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

Feature request: display warning and error count like eslint. #2581

Closed
bladerunner2020 opened this issue Jun 1, 2024 · 2 comments
Closed
Labels
enhancement Improved functionality
Milestone

Comments

@bladerunner2020
Copy link
Contributor

Problem

TypeDoc doesn't show the number of warnings and errors (though it does calculate them!). If a project has a lot of warnings (as it is in our case), it would be very convenient to see the number of warnings to ensure that the count goes down over time and not up.

Suggested Solution

I suggest displaying the warning and error count like ESLint does. Possible outputs:

  • if there are only warnings: [warning] Found 0, error(s), 70 warning(s).
  • if there are errors: [error] Found 1, error(s), 70 warning(s).

Considering that TypeDoc already counts errors and warnings, it should only take a couple of lines to add this feature.

I don't mind to make a PR.

@bladerunner2020 bladerunner2020 added the enhancement Improved functionality label Jun 1, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 1, 2024

Seems like a reasonable request, go for it!

@Gerrit0 Gerrit0 added this to the v0.26.0 milestone Jun 1, 2024
Gerrit0 pushed a commit that referenced this issue Jun 11, 2024
* feat: added a message summarizing the number of errors and warnings if there are any, fix: VERSION property is readonly

* tests: added test for errors and warnings summary message

* tests: added test for errors and warnings summary message (generateJson)

* chore: added a comment

* fix: typescript errors

* fix: fixed warnings by prettier

* refactor: moved logRunSummary to cli

* fix: lint issues
Gerrit0 pushed a commit that referenced this issue Jun 12, 2024
* feat: added a message summarizing the number of errors and warnings if there are any, fix: VERSION property is readonly

* tests: added test for errors and warnings summary message

* tests: added test for errors and warnings summary message (generateJson)

* chore: added a comment

* fix: typescript errors

* fix: fixed warnings by prettier

* refactor: moved logRunSummary to cli

* fix: lint issues
@Gerrit0 Gerrit0 mentioned this issue Jun 16, 2024
7 tasks
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 16, 2024

Included in TypeDoc 0.26, which is releasing 2024/06/21

@Gerrit0 Gerrit0 closed this as completed Jun 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

2 participants