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.

Sign up for GitHub

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

Jump to bottom

treat validation issues as errors - but not all warnings as errors #2199

Closed
RebeccaStevens opened this issue Mar 13, 2023 · 1 comment
Closed

treat validation issues as errors - but not all warnings as errors #2199

RebeccaStevens opened this issue Mar 13, 2023 · 1 comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@RebeccaStevens
Copy link
Contributor

Search Terms

  • treatWarningsAsErrors
  • validation errors

Problem

--treatWarningsAsErrors is too general. I want to treat validation issues as errors, but I don't want all warnings to be errors.

Example of a warning I want to keep as a warning:

warning You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports 4.6, 4.7, 4.8, 4.9

Suggested Solution

Add a new config and cli option to do this.
Maybe something like: validationWarningsAsError or requireValidation
@RebeccaStevens RebeccaStevens added the enhancement Improved functionality label Mar 13, 2023
@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Mar 14, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 14, 2023

Seems like a reasonable request 👍

@RebeccaStevens RebeccaStevens changed the title treat validation issues as errors - buy not all warnings as errors treat validation issues as errors - but not all warnings as errors Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@RebeccaStevens @Gerrit0