Skip to content
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

Is it possible to suppress warnings from node_modules files? #2611

Closed
crystalfp opened this issue Jun 23, 2024 · 2 comments
Closed

Is it possible to suppress warnings from node_modules files? #2611

crystalfp opened this issue Jun 23, 2024 · 2 comments
Labels
enhancement Improved functionality question Question about functionality
Milestone

Comments

@crystalfp
Copy link

Search terms

node_modules, warning

Question

Running typedoc on my application generates plenty of warnings from modules under node_modules on which I have no control. For example:

./node_modules/@types/node/events.d.ts:512:11 - [warning] Encountered an unknown block tag @since

512             * @since v0.11.2

./node_modules/electron/electron.d.ts:3883:7 - [warning] Encountered an unknown block tag @platform

3883         * @platform win32,linux

These modules are not in the list of files passed to typedoc, but are indirectly loaded from input statements.
This huge list of warnings obscures genuine warnings from my code.
Thanks for your help!
mario

@crystalfp crystalfp added the question Question about functionality label Jun 23, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 23, 2024

Hmm.. that's a rather annoying problem. Currently no, I'm going to go add a suppressCommentWarningsInDeclarationFiles option right now though.

@Gerrit0 Gerrit0 added the enhancement Improved functionality label Jun 23, 2024
@Gerrit0 Gerrit0 added this to the v0.26.2 milestone Jun 23, 2024
@crystalfp
Copy link
Author

The new option works and helped a lot. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants