feat: Reporting unused inline configs #121
Conversation
Co-authored-by: Francesco Trotta <[email protected]>
|
Per eslint/eslint#15476 (comment), converting to a draft so I can rework this to encompass eslint/eslint#15476. |
Co-authored-by: 唯然 <[email protected]>
Co-authored-by: Francesco Trotta <[email protected]>
… configs" This reverts commit c339a59.
|
|
||
| [eslint/eslint#15476 Change Request: report unnecessary config overrides](https://github.com/eslint/eslint/issues/15476) previously suggested also checking config files (`eslint.config.*`). | ||
| Doing so could be beneficial to flag values that become unnecessary in config files over time. | ||
| However, because flat config purely involves spreading objects, there's no way to know what objects originate from shared configs or shared packages. |
There was a problem hiding this comment.
FYI @ljharb. I really wanted to get this support in, but just don't see a way to get it to work in this major version. 😞
There was a problem hiding this comment.
I think this is probably something better located in the config inspector, where we could give people a visualization of duplicate configs.
|
|
||
| [eslint/eslint#15476 Change Request: report unnecessary config overrides](https://github.com/eslint/eslint/issues/15476) previously suggested also checking config files (`eslint.config.*`). | ||
| Doing so could be beneficial to flag values that become unnecessary in config files over time. | ||
| However, because flat config purely involves spreading objects, there's no way to know what objects originate from shared configs or shared packages. |
There was a problem hiding this comment.
I think this is probably something better located in the config inspector, where we could give people a visualization of duplicate configs.
| 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` and `--report-unused-inline-configs-severity` options for consistency's sake. | ||
|
|
||
| This RFC's opinion is that the consistency of adding two new options is not worth the excess options logic. |
| ### Separate CLI Option | ||
|
|
||
| Unlike the changes discussed in [Change Request: Enable reportUnusedDisableDirectives config option by default](https://github.com/eslint/eslint/issues/15466) -> [feat!: flexible config + default reporting of unused disable directives](https://github.com/eslint/rfcs/pull/100), reporting unused inline configs does not have legacy behavior to keep to. | ||
| The existing `--report-unused-disable-directives` (enabling) and `--report-unused-disable-directives-severity` (severity) options were kept separate for backwards compatibility. |
There was a problem hiding this comment.
Just to clarify, --report-unused-disable-directives is the same as --report-unused-disable-directives-severity error, and it isn't necessary to pass --report-unused-disable-directives to enable reporting when --report-unused-disable-directives-severity is used. In fact, these two options cannot be used together.
https://github.com/eslint/eslint/blob/d1f0831bac173fe3e6e81ff95c5abdbf95b02b65/lib/cli.js#L484-L487
|
We have two approvals so moving to final commenting. |
nzakas
added
Final Commenting
JoshuaKGoldberg
dismissed stale reviews from nzakas and mdjermanovic
via
dbd33bc
|
Just needs to stay open for one more day to finish out the final commenting period, then we're ready to merge. |
Summary
Proposes adding a CLI option to report
/* eslint... */comments that don't change any settings.Related Issues