feat: Reporting unused inline configs #121
Draft
+244
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
fasttime
reviewed
Jul 8, 2024
fasttime
reviewed
Jul 8, 2024
fasttime
reviewed
Jul 8, 2024
Co-authored-by: Francesco Trotta <[email protected]>
1 task
fasttime
reviewed
Jul 9, 2024
Comment on lines
+192
to
+193
| One way to reduce costs could be to wait until ESLint completely removes support for legacy configs. | ||
| That way, only the new ("flat") config system would need to be tested with this change. |
There was a problem hiding this comment.
I think it makes sense to enable this change only for the new config system. Probably we don't want to add a new option to eslintrc, even if it's only for internal usage by the CLI. But we should still make sure that no new problems are reported when the Linter runs in eslintrc mode and the default value for reportUnusedInlineConfigs changes to "error" or "warn".
fasttime
reviewed
Jul 9, 2024
| Additional logic can be added to the existing code points in `Linter` that validate inline config options: | ||
|
|
||
| - [`_verifyWithFlatConfigArrayAndWithoutProcessors`](https://github.com/eslint/eslint/blob/7c78ad9d9f896354d557f24e2d37710cf79a27bf/lib/linter/linter.js#L1650): called in the current ("flat") config system | ||
| - [`getDirectiveComments`](https://github.com/eslint/eslint/blob/7c78ad9d9f896354d557f24e2d37710cf79a27bf/lib/linter/linter.js#L387): called when `ESLINT_USE_FLAT_CONFIG=true` |
There was a problem hiding this comment.
I think that getDirectiveComments is also called when ESLINT_USE_FLAT_CONFIG is not set?
fasttime
reviewed
Jul 9, 2024
| The existing `--report-unused-disable-directives` (enabling) and `--report-unused-disable-directives-severity` (severity) options were kept separate for backwards compatibility. | ||
|
|
||
| Adding a sole `--report-unused-inline-configs` CLI option presents a discrepency between the two sets of options. | ||
| An alternative could be to instead add `--report-unused-inline-configs` an `--report-unused-inline-configs-severity` options for consistency's sake. |
There was a problem hiding this comment.
Suggested change
| An alternative could be to instead add `--report-unused-inline-configs` an `--report-unused-inline-configs-severity` options for consistency's sake. | |
| An alternative could be to instead add `--report-unused-inline-configs` and `--report-unused-inline-configs-severity` options for consistency's sake. |
|
Per eslint/eslint#15476 (comment), converting to a draft so I can rework this to encompass eslint/eslint#15476. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Proposes adding a CLI option to report
/* eslint... */comments that don't change any settings.Related Issues