Logger: also count the warning messages #1205
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you want to make your build fail on error messages, you currently can do
```
const result = app.generateDocs(project, OUTPUT_DIR);
if (!result || app.logger.hasErrors() ) {
console.log("Errors were logged during the generation of the documentation. Check the log for more information");
process.exit(1);
}
```
However, warning messages typically indicate a problem as well. If you want to make your build fail on those as well, you need a custom logger to keep track of the warning messages yourself.
This PR makes this easier by counting the warning messages in a similar fashion as the error messages.
Removing some trailing whitespace
|
Looks good, thanks! I'll put out a patch with this this weekend. |
|
Thanks. |
|
Released in 0.16.10 |
PissedCapslock
added a commit
to PissedCapslock/typedoc
that referenced
this pull request
Feb 18, 2020
I cannot believe I messed up that previous PR (TypeStrong#1205), but the extensions of the `Logger` class did not count the warnings. Solved this by removing the error counting code from the child classes, and called the super method instead. This ensures that both the error count and the warning count increases.
Gerrit0
pushed a commit
that referenced
this pull request
Feb 22, 2020
I cannot believe I messed up that previous PR (#1205), but the extensions of the `Logger` class did not count the warnings. Solved this by removing the error counting code from the child classes, and called the super method instead. This ensures that both the error count and the warning count increases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you want to make your build fail on error messages, you currently can do
However, warning messages typically indicate a problem as well. If you want to make your build fail on those as well, you need a custom logger to keep track of the warning messages yourself.
This PR makes this easier by counting the warning messages in a similar fashion as the error messages.