Thanks to visit codestin.com Credit goes to github.com
We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
When using "includes" to add additional documentation, if the target directory does not exist nothing is generated and the process does not fail.
Not tested but it is probably the case with other errors.
node 14.17.3 compodoc 1.1.15
{ "$schema": "../../node_modules/@compodoc/compodoc/src/config/schema.json", "disableCoverage": true, "disableGraph": true, "disableDependencies": true, "disableDomTree": true, "disableInternal": true, "disableRoutesGraph": true, "disablePrivate": true, "disableProtected": true, "silent": false }
Launch the generation with an invalid "includes" option
compodoc -c .compodocrc.json -p tsconfig.app.json --includes wrong_folder -d target/doc
And error is logged
[14:05:52] Error during wrong_folder/summary.json read [14:05:52] Error during Additional documentation generation
But the process exits with code 0
Additionally the error is not shown at all when using silent: true. I think errors should always be displayed regardless of this option.
silent: true
When a critical error is detected :
silent
The text was updated successfully, but these errors were encountered:
15fd3de
@vogloblinsky I am not sure your fix is correct
it should exit 1 on error not 0
Sorry, something went wrong.
Yes, good catch, too focused on catching the error, i miss to use 1 and not 0. Fixed.
vogloblinsky
No branches or pull requests
Overview of the issue
When using "includes" to add additional documentation, if the target directory does not exist nothing is generated and the process does not fail.
Not tested but it is probably the case with other errors.
Operating System, Node.js, npm, compodoc version(s)
node 14.17.3
compodoc 1.1.15
**Compodoc configuration
Reproduce the error
Launch the generation with an invalid "includes" option
And error is logged
But the process exits with code 0
Additionally the error is not shown at all when using
silent: true
. I think errors should always be displayed regardless of this option.Suggest a Fix
When a critical error is detected :
silent
optionThe text was updated successfully, but these errors were encountered: