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

docs: Add explanation of when to use 'warn' severity #16882

Merged
merged 2 commits into from Feb 13, 2023
Merged

docs: Add explanation of when to use 'warn' severity #16882

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52421fa
docs: Add explanation of when to use 'warn' severity
nzakas Feb 10, 2023
93f317e
Update docs/src/use/configure/rules.md
nzakas Feb 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/use/configure/rules.md
View file
Open in desktop
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