feat!: flexible config + default reporting of unused disable directives #100

bmish · 2022-12-09T19:00:03Z

Summary

Provide users with more flexible, intuitive control over how unused disable directives are reported by supporting severity levels instead of just boolean values with CLI and config file options. Change the default behavior from off to warn on unused disable directives.

Related Issues

Draft implementation of phase 1 of this RFC (the non-breaking changes):

feat: Support custom severity when reporting unused disable directives eslint#17212

The issue triggering this RFC:

Change Request: Enable reportUnusedDisableDirectives config option by default eslint#15466 - the issue triggering this RFC

Other related issues:

Proposal: reportUnusedDisableDirectives in config files eslint#9382 - similar earlier proposal with reportUnusedDisableDirectives accepting a severity level
New: Configuring core options in Config Files #22 - previous RFC to allow reportUnusedDisableDirectives in config files
reportUnusedDisableDirectives should probably be a regular rule eslint#13104
Allow "reportUnusedDisableDirectives" option to "error" eslint#12703 (comment)
Chore: enable reportUnusedDisableDirectives in eslint-config-eslint eslint#14699 (comment)

eslint-github-bot · 2022-12-09T19:00:07Z

Hi @bmish!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

nzakas

Thanks for putting this together. Overall, I think have the option on by default makes sense, but I think this plan is a bit too disruptive as described. I think we can make it less disruptive by continuing to support boolean settings forever and by having the default be warn instead of error.

designs/2022-unused-disable-directive-flexible-config/README.md

nzakas

It seems like we've come to a pretty good agreement about how to proceed here. We just need the RFC to be updated to reflect that agreement along with some other small points of clarification.

designs/2022-unused-disable-directive-flexible-config/README.md

nzakas · 2023-03-08T21:35:41Z

@bmish are you still working on this?

nzakas · 2023-04-07T20:00:38Z

@bmish friendly ping. Do you intend to finish up this RFC?

bmish · 2023-04-10T20:43:14Z

Sorry for delay, will finish this up when I have a chance.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

…severity>

* main: chore: Add Mastodon status post to workflow (eslint#110) feat: ESLint Language Plugins (eslint#99) feat: support for testing invalid rule schemas and runtime exceptions (eslint#103) feat!: check for parsing errors in suggestion fixes (eslint#101)

bmish · 2023-05-21T15:38:10Z

I have updated the RFC to incorporate all feedback so far.

bmish · 2023-05-23T23:16:46Z

I have opened up a draft PR of phase 1 (the non-breaking changes) from this RFC. It's fully working, tested, and documented, so this helps prove out the RFC and demonstrates what changes will be necessary.

feat: Support custom severity when reporting unused disable directives eslint#17212

designs/2022-unused-disable-directive-flexible-config/README.md

…ions

nzakas

LGTM. I feel comfortable with this direction

mdjermanovic

LGTM, thanks! Moving to final commenting.

eslint-github-bot bot added the triage label Dec 9, 2022

bmish force-pushed the unused-disable-directive-config branch from 6783236 to c5b1c10 Compare December 9, 2022 19:01

eslint-github-bot bot added breaking feature labels Dec 9, 2022

bmish changed the title ~~feat!: flexible configuration and stricter default behavior for reporting unused disable directives~~ feat!: flexible config + default reporting of unused disable directives Dec 9, 2022

bmish force-pushed the unused-disable-directive-config branch from c5b1c10 to 132158c Compare December 9, 2022 19:02

bmish mentioned this pull request Dec 9, 2022

Change Request: Enable reportUnusedDisableDirectives config option by default eslint/eslint#15466

Closed

1 task

nzakas added the Initial Commenting This RFC is in the initial feedback stage label Dec 9, 2022

nzakas reviewed Dec 9, 2022

View reviewed changes

feat!: flexible config + default reporting of unused disable directives

8e231bb

bmish force-pushed the unused-disable-directive-config branch 3 times, most recently from 94ef555 to bb6df4e Compare December 29, 2022 18:06

change default to warn and keep boolean values around

37c78bf

bmish force-pushed the unused-disable-directive-config branch from bb6df4e to 37c78bf Compare December 30, 2022 13:24

bmish mentioned this pull request Jan 12, 2023

Warn on unused ESLint disable directives in base config square/eslint-plugin-square#829

Merged

mdjermanovic reviewed Feb 7, 2023

View reviewed changes

designs/2022-unused-disable-directive-flexible-config/README.md Outdated Show resolved Hide resolved

nzakas requested changes Feb 14, 2023

View reviewed changes

bmish and others added 7 commits May 21, 2023 10:42

Update designs/2022-unused-disable-directive-flexible-config/README.md

ce3bd8c

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

Update designs/2022-unused-disable-directive-flexible-config/README.md

a9d602b

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

Update designs/2022-unused-disable-directive-flexible-config/README.md

82a6c44

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

Update designs/2022-unused-disable-directive-flexible-config/README.md

ec622e9

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

incorporate CLI option: --report-unused-disable-directives-severity <…

6cc325c

…severity>

change summary for lib/config/flat-config-schema.js

614feaf

bmish mentioned this pull request May 23, 2023

feat: Support custom severity when reporting unused disable directives eslint/eslint#17212

Merged

2 tasks

bmish force-pushed the unused-disable-directive-config branch from 595e34e to 6a1d1ad Compare May 23, 2023 23:13

improve code change list

d8e3de7

bmish force-pushed the unused-disable-directive-config branch from 6a1d1ad to d8e3de7 Compare May 24, 2023 00:13

mdjermanovic reviewed May 25, 2023

View reviewed changes

designs/2022-unused-disable-directive-flexible-config/README.md Outdated Show resolved Hide resolved

bmish added 2 commits May 25, 2023 10:06

update where default is set, remove open question

abd3272

tweak default location

0ce7a29

mdjermanovic reviewed May 28, 2023

View reviewed changes

designs/2022-unused-disable-directive-flexible-config/README.md Outdated Show resolved Hide resolved

bmish added 2 commits May 29, 2023 10:09

remove redundant reportUnusedDisableDirectives option from processOpt…

34780f7

…ions

tweak phase 2 wording

fa8df52

nzakas approved these changes Jun 14, 2023

View reviewed changes

mdjermanovic removed the triage label Jun 20, 2023

mdjermanovic approved these changes Jun 20, 2023

View reviewed changes

mdjermanovic added Final Commenting This RFC is in the final week of commenting and removed Initial Commenting This RFC is in the initial feedback stage labels Jun 20, 2023

mdjermanovic merged commit 6a7e04d into eslint:main Jul 21, 2023
5 checks passed

teppeis mentioned this pull request Sep 16, 2023

no-unused-disable doesn't work with flat config mysticatea/eslint-plugin-eslint-comments#79

Open

fasttime mentioned this pull request Sep 18, 2023

Bug: Flat config doesn't allow uppercase severities eslint/eslint#17570

Closed

1 task

teppeis mentioned this pull request Oct 16, 2023

no-unused-disable doesn't work with flat config eslint-community/eslint-plugin-eslint-comments#133

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: flexible config + default reporting of unused disable directives #100

feat!: flexible config + default reporting of unused disable directives #100

bmish commented Dec 9, 2022 •

edited

eslint-github-bot bot commented Dec 9, 2022

nzakas left a comment

nzakas left a comment

nzakas commented Mar 8, 2023

nzakas commented Apr 7, 2023

bmish commented Apr 10, 2023

bmish commented May 21, 2023

bmish commented May 23, 2023

nzakas left a comment

mdjermanovic left a comment

feat!: flexible config + default reporting of unused disable directives #100

feat!: flexible config + default reporting of unused disable directives #100

Conversation

bmish commented Dec 9, 2022 • edited

Summary

Related Issues

eslint-github-bot bot commented Dec 9, 2022

nzakas left a comment

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

nzakas commented Mar 8, 2023

nzakas commented Apr 7, 2023

bmish commented Apr 10, 2023

bmish commented May 21, 2023

bmish commented May 23, 2023

nzakas left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

bmish commented Dec 9, 2022 •

edited