Skip to content

Commit

Permalink
docs: Add explanation of when to use 'warn' severity (#16882)
Browse files Browse the repository at this point in the history
* docs: Add explanation of when to use 'warn' severity

Fixes #16696
Closes #16753

* Update docs/src/use/configure/rules.md

Co-authored-by: Nitin Kumar <snitin315@gmail.com>

---------

Co-authored-by: Nitin Kumar <snitin315@gmail.com>
  • Loading branch information
nzakas and snitin315 committed Feb 13, 2023
1 parent 71f6f0d commit 43af24a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/use/configure/rules.md
Expand Up @@ -20,6 +20,10 @@ To change a rule's severity, set the rule ID equal to one of these values:
* `"warn"` or `1` - turn the rule on as a warning (doesn't affect exit code)
* `"error"` or `2` - turn the rule on as an error (exit code is 1 when triggered)

Rules are typically set to `"error"` to enforce compliance with the rule during continuous integration testing, pre-commit checks, and pull request merging because doing so causes ESLint to exit with a non-zero exit code.

If you don't want to enforce compliance with a rule but would still like ESLint to report the rule's violations, set the severity to `"warn"`. This is typically used when introducing a new rule that will eventually be set to `"error"`, when a rule is flagging something other than a potential buildtime or runtime error (such as an unused variable), or when a rule cannot determine with certainty that a problem has been found (when a rule might have false positives and need manual review).

### Using configuration comments

To configure rules inside of a file using configuration comments, use a comment in the following format:
Expand Down

0 comments on commit 43af24a

Please sign in to comment.