Skip to content

Commit

Permalink
docs: advice for inline disabling of rules (#17458)
Browse files Browse the repository at this point in the history
* docs: advice for dev while disabling rules

* docs: advice for dev while disabling rules

* docs: advice for dev while disabling rules

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

---------

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
  • Loading branch information
criticalAY and nzakas committed Aug 22, 2023
1 parent 056499d commit cab21e6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/src/use/configure/rules.md
Expand Up @@ -144,6 +144,17 @@ You can also use this format with configuration comments, such as:

### Using configuration comments

* **Use with Caution.** Disabling ESLint rules inline should be restricted and used only in situations with a clear and
valid reason for doing so. Disabling rules inline should not be the default solution to resolve linting errors.
* **Document the Reason.** Provide a comment explaining the reason for disabling a particular rule after the `--` section of the comment. This
documentation should clarify why the rule is being disabled and why it is necessary in that specific situation.
* **Temporary Solutions.** If a disable comment is added as a temporary measure to address a pressing issue, create a follow-up task to address the underlying problem adequately. This ensures that the
disable comment is revisited and resolved at a later stage.
* **Code Reviews and Pair Programming.** Encourage team members to review each other's code regularly. Code reviews can help
identify the reasons behind disable comments and ensure that they are used appropriately.
* **Configurations.** Whenever possible, prefer using ESLint configuration files over disable comments. Configuration
files allow for consistent and project-wide rule handling.

To disable rule warnings in a part of a file, use block comments in the following format:

```js
Expand Down

0 comments on commit cab21e6

Please sign in to comment.