Skip to content

Commit

Permalink
Clarify when to report
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Sep 2, 2024
1 parent 63b48f2 commit dbd33bc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions designs/2024-report-unused-inline-configs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ Each inline config comment will be compared against the existing configuration v
- The new logic will normalize options: `"off"` will be considered equivalent to `0`
- If the config comment also specifies rule options, they will be compared for deep equality to the existing rule options

There will be a report if both the severity and rule options are the same.
If there is a difference in the severity and/or rule options, then there will be no report.

This RFC should wait to begin work until after [feat: add meta.defaultOptions](https://github.com/eslint/eslint/pull/17656) is merged into ESLint.
That way, if a rule defines `meta.defaultOptions`, those default options can be factored into computing whether an inline config's rule options differ from the previously configured options.

Expand Down

0 comments on commit dbd33bc

Please sign in to comment.