intentionallyNotExported
does not support Windows path separators
#1738
Labels
bug
Functionality does not match expectation
Search terms
intentionallyNotExported, Windows
Expected Behavior
When running TypeDoc, I got this warning:
So copied the file path of the warning + the type name and used the
intentionallyNotExported
in mytypedoc.json
like this:Actual Behavior
This does not work. Luckily, TypeDoc prints a very helpful but also confusing warning:
However, using front slashes in the path works:
(Removing the path and only using
"NodeIdent"
also works as expected.)It seems like the symbol comparison of the
intentionallyNotExported
option uses Unix path separators internally and doesn't account for Windows path separators.The easiest fix for this might be to consistently use Unix path separators internally and to converts the paths from the
intentionallyNotExported
into Unix paths as well. This could as simple as replacing all backslashes with frontslashes.Steps to reproduce the bug
Here is a minimal example. Just install all deps (
npm ci
) and runnpx typedoc
. You'll see the following on Windows machines:Environment
The text was updated successfully, but these errors were encountered: