-
-
Notifications
You must be signed in to change notification settings - Fork 737
Avoid documenting excluded files. #896
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
When I npm link this branch in typedoc to my project I'm running into an issue with the ConvertComponent invocation.
In my package.json: "docs": "typedoc --exclude node_modules" In my tsconfig.json: "typedocOptions": {
"mode": "file",
"out": "docs",
"theme": "minimal",
"exclude": ["test", "node_modules"],
"excludePrivate": true,
"excludeNotExported": true,
"moduleResolution": "node",
"module": "commonjs",
"hideGenerator": true,
"readme": "none"
} |
That's... odd to say the least. I don't think it's related to this PR since the source of the error appears to be the markdown plugin you have installed.
I'd be willing to bet that |
When will this land? |
Got merged! |
Great! When will a release land? |
I'm planning on merging #922 before pushing a release |
Avoid documenting excluded files. (TypeStrong#896)
as the v0.14 release has a workaround bugfix for it: - TypeStrong/typedoc#913 - TypeStrong/typedoc#896
This is an attempt at correcting how the exclude option works. I'd like to get some feedback from people running into this problem before merging these changes in.
I previously raised some concerns about how a change like this would affect errors/output, so here's how I decided to handle each concern:
I ran the project on the TypeDoc repo with the utils folder excluded and noted that classes defined in the utils folder were not present in the JSON output. In the HTML output, their name will be printed as plain text (much like
Promise
) if they are referred. I also introduced errors both in the utils folder and outside of the utils folder and noted that only errors outside of the utils folder were reported. Errors in the utils folder did not prevent output.Fixes #319
Fixes #839