Implement eslint.rules.customizations - with overrides #1164

JoshuaKGoldberg · 2021-01-23T18:56:40Z

Continues @jamesorlakin's great work from #993, with the changes requested by @dbaeumer to take settings as an array and allow ignoring rules.

Fixes #468 based on the discussions in #561.

Fixes #1199.

In the demo, note the underline under bar and console.log changing to red (error):

Screen.Recording.2021-03-12.at.12.38.53.PM.mov

Co-authored-by: James Lakin contact@jameslakin.co.uk

server/src/eslintServer.ts

client/src/extension.ts

server/src/eslintServer.ts

…cation

dbaeumer · 2021-02-08T11:27:56Z

README.md

@@ -146,6 +146,29 @@ This extension contributes the following variables to the [settings](https://cod
  - `all`: fixes all possible problems by revalidating the file's content. This executes the same code path as running eslint with the `--fix` option in the terminal and therefore can take some time. This is the default value.
  - `problems`: fixes only the currently known fixable problems as long as their textual edits are non overlapping. This mode is a lot faster but very likely only fixes parts of the problems.

+- `eslint.rules.customizations`: force rules to report a different severity within VS Code compared to the project's true ESLint configuration. This is an array that allows two kinds of glob patterns:
+  - `"override`": Overrides for rules with names that match, factoring in asterisks: `{ "override": "no-*", "severity": "warn" }`
+  - `"reset"`: Excludes rules matching a glob from previous overrides: `{ "reset": "*jsx*" }`


Can you please provide an example on when users should use that.

I think I did, in the next example. Do you mean something else @dbaeumer?

client/src/extension.ts

playgrounds/6.0/.vscode/settings.json

dbaeumer · 2021-02-08T11:40:29Z

server/src/eslintServer.ts

@@ -1290,6 +1348,12 @@ function validate(document: TextDocument, settings: TextDocumentSettings & { lib
 		}
 	}

+	const newRuleCustomizationsKey = JSON.stringify(settings.rulesCustomizations);


I would actually hash this to make it clear that we use the content as a key.

Err, is there a particular hash function you're looking for here? I'm under the impression JSON.stringify works as a rudimentary, though space-inefficient, hash.

dbaeumer · 2021-02-08T11:41:15Z

Add my comment. Again thanks for working on this.

dbaeumer · 2021-03-12T13:27:01Z

@JoshuaKGoldberg anything I need to do to move this forward?

JoshuaKGoldberg · 2021-03-12T14:14:54Z

Ah! It fell off my radar. Looking again now -- thanks for the ping!

stenzengel · 2021-03-23T09:29:13Z

Can I help? E.g. is it easily possible to test this PR before it is merged or a new version is released? (Unfortunately I have no experience with VS Code extension development, yet.)

dbaeumer · 2021-03-24T10:32:32Z

@stenzengel To test things you can do the following:

clone @JoshuaKGoldberg fork
npm install
open in VS Code
go to the debugger tab
run Launch Client

That launches a new VS Code instance which uses the ESLint extension from source.

stenzengel · 2021-03-24T20:31:45Z

@JoshuaKGoldberg
I have only done a quick test, but my use case works like a charm so far. I will continue testing.

One short question: I'm not sure, if you prefer the property name "override" to my original proposal "severity" or if it is an oversight. I am not a native speaker, so I am not sure which one sounds better.

Current implementation:

{ "rule": "*",         "override": "downgrade" },
{ "rule": "*console*", "override": "reset" },

Original proposal

{ "rule": "*",         "severity": "downgrade" },
{ "rule": "*console*", "severity": "reset" },

dbaeumer · 2021-03-25T08:29:01Z

I prefer severity over override

JoshuaKGoldberg · 2021-03-28T00:22:41Z

This is how it is now:

  "eslint.rules.customizations": [
    { "override": "no-*", "severity": "info" },
    { "override": "!no-*", "severity": "downgrade" },
    { "reset": "radix", "severity": "reset" }
  ]

Is that acceptable to both of you?

stenzengel · 2021-03-28T06:25:06Z

I don't understand yet in which case exactly you have to use the property name "reset" instead of "override". Only in cases where the value for "severity" is also "reset"?. I also don't see any commit yet where I could hava a closer look.

I definitely don't want you to make a change to your code that you're not completely happy with because of my configuration proposition. I.e. for me all configuration alternatives are ok as long as it is possible to downgrade all rules.

JoshuaKGoldberg · 2021-03-28T15:34:57Z

Oh you know what, I had just forgotten to update the README.md example 😅 . Sorry! Yes, I'll switch to this -- your proposal @stenzengel:

  "eslint.rules.customizations": [
    { "rule": "no-*", "severity": "info" },
    { "rule": "!no-*", "severity": "downgrade" },
    { "rule": "radix", "severity": "reset" }
  ]

dbaeumer · 2021-03-29T09:47:35Z

One minor suggestion: I would like to rename reset since to my undestanding it will use the value defined in the eslintrc file. Suggestions are: default since it is the value in the eslintrc file or eslintrc to make this even more clear. I actually woul prefer default.

dbaeumer · 2021-03-30T07:35:49Z

@JoshuaKGoldberg is this ready for another review?

JoshuaKGoldberg · 2021-03-30T13:32:12Z

@dbaeumer yes please!

dbaeumer

Very nice work. Only minor things. Thanks again for doing this.

README.md

client/src/extension.ts

dbaeumer · 2021-04-06T11:53:53Z

Merged !!

dbaeumer · 2021-04-06T11:59:14Z

I drafted a pre-release here: https://github.com/microsoft/vscode-eslint/releases/tag/insider%2F2.1.20 in case you want to give it a try.

JoshuaKGoldberg · 2021-04-06T13:27:44Z

Whoohoo! 🙌

Thanks everyone for helping push this through! It feels like we made a real team effort and I'm stoked to start adding this config to repositories. 🚀

stenzengel · 2021-04-06T17:57:23Z

Thanks a lot, @JoshuaKGoldberg and @dbaeumer . The pre-release worked for me without any problems.

lolmaus · 2021-04-07T09:40:28Z

Hi!

I have installed v2.1.20, added this to my settings.json:

    "eslint.rules.customizations": [
        {
            "rule": "*", "override": "info"
        }
    ],

I expect the linting problems to be underlined yellow, but they are still red. What am I doing wrong?

dbaeumer · 2021-04-07T13:30:50Z

@lolmaus the correct syntax is:

	"eslint.rules.customizations": [
		{ "rule": "*", "severity": "info" }
	]

lolmaus · 2021-04-07T13:36:01Z

Ah, thanks! My syntax is correct, but I used the keyword override from this PR's screenshot. The correct keyword is severity.

Thank you for the absolutely awesome feature! 🙇‍♂️🙏

lolmaus · 2021-04-07T13:58:11Z

Here's a config that sets the color of fixable rules to blue, non-fixable to yellow:
https://gist.github.com/lolmaus/e1be5655288fca67e53a22b720adf40d

Includes eslint, @typescript-eslint and prettier.

lolmaus · 2021-04-08T12:38:47Z

I love how different severities overlap and you can now see an important problem inside an unimportant problem! 😍

Implement eslint.rules.customizations - with overrides

6aa680d

JoshuaKGoldberg mentioned this pull request Jan 23, 2021

Implement "eslint.rules.customizations" - Allow users to override rule severity from VS Code settings #993

Closed

JoshuaKGoldberg commented Jan 23, 2021

View reviewed changes

server/src/eslintServer.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg commented Jan 23, 2021

View reviewed changes

client/src/extension.ts Show resolved Hide resolved

Josh Goldberg added 2 commits January 23, 2021 14:13

Renamed from 'ignore' to 'reset'

5455354

Fixed compile complaints

7004ef6

dbaeumer requested changes Jan 25, 2021

View reviewed changes

server/src/eslintServer.ts Outdated Show resolved Hide resolved

Josh Goldberg added 3 commits January 26, 2021 23:39

Added a simple rule severy cache using a Map

fd013ab

Switched map to only clear cache on new rulesCustomizations stringifi…

bbc3eb0

…cation

Used LinkedMap as suggested

0cc0a8a

JoshuaKGoldberg requested a review from dbaeumer January 27, 2021 05:04

Used an LRU cache as suggested

3875dbd

dbaeumer requested changes Feb 8, 2021

View reviewed changes

Base automatically changed from master to main March 2, 2021 14:45

stenzengel mentioned this pull request Mar 11, 2021

Reduce each severity by one level, i.e. display ESLint error as VS Code warning and display ESLint warning as VS Code info #1199

Closed

Josh Goldberg added 2 commits March 12, 2021 09:25

Dedup enum and sanitize inputs

6fbd59f

Simplified type and allowed bang exclusions

67ead7a

JoshuaKGoldberg requested a review from dbaeumer March 12, 2021 17:36

Update naming to severity, not override/reset

016e1a0

Server severity rename, and reset -> default

087bd29

dbaeumer requested changes Apr 1, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

client/src/extension.ts Outdated Show resolved Hide resolved

Review touchups

438a5a1

JoshuaKGoldberg requested a review from dbaeumer April 1, 2021 13:16

dbaeumer merged commit e4b2738 into microsoft:main Apr 6, 2021

dbaeumer added this to the 2.1.20 milestone Apr 6, 2021

JoshuaKGoldberg deleted the eslint-overrides-2 branch April 6, 2021 13:27

dbaeumer added the April 2021 label Apr 13, 2021

dbaeumer mentioned this pull request Nov 19, 2021

Add setting "eslint.globalSeverity", Implements #468 #561

Closed

JoshuaKGoldberg mentioned this pull request Dec 21, 2023

Allow eslint.rules.customizations to target all fixable rules #1705

Closed

JoshuaKGoldberg mentioned this pull request Aug 10, 2024

Bug: [no-unsafe-assignment] "Unsafe assignment of an error typed value." obscures underlying TS errors typescript-eslint/typescript-eslint#9771

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement eslint.rules.customizations - with overrides #1164

Implement eslint.rules.customizations - with overrides #1164

JoshuaKGoldberg commented Jan 23, 2021 •

edited

Loading

dbaeumer Feb 8, 2021

JoshuaKGoldberg Mar 12, 2021

dbaeumer Feb 8, 2021

JoshuaKGoldberg Mar 12, 2021

dbaeumer commented Feb 8, 2021

dbaeumer commented Mar 12, 2021

JoshuaKGoldberg commented Mar 12, 2021

stenzengel commented Mar 23, 2021

dbaeumer commented Mar 24, 2021

stenzengel commented Mar 24, 2021

dbaeumer commented Mar 25, 2021

JoshuaKGoldberg commented Mar 28, 2021

stenzengel commented Mar 28, 2021

JoshuaKGoldberg commented Mar 28, 2021

dbaeumer commented Mar 29, 2021

dbaeumer commented Mar 30, 2021

JoshuaKGoldberg commented Mar 30, 2021

dbaeumer left a comment

dbaeumer commented Apr 6, 2021

dbaeumer commented Apr 6, 2021

JoshuaKGoldberg commented Apr 6, 2021

stenzengel commented Apr 6, 2021

lolmaus commented Apr 7, 2021

dbaeumer commented Apr 7, 2021

lolmaus commented Apr 7, 2021

lolmaus commented Apr 7, 2021

lolmaus commented Apr 8, 2021

Implement eslint.rules.customizations - with overrides #1164

Implement eslint.rules.customizations - with overrides #1164

Conversation

JoshuaKGoldberg commented Jan 23, 2021 • edited Loading

dbaeumer Feb 8, 2021

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 12, 2021

Choose a reason for hiding this comment

dbaeumer Feb 8, 2021

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 12, 2021

Choose a reason for hiding this comment

dbaeumer commented Feb 8, 2021

dbaeumer commented Mar 12, 2021

JoshuaKGoldberg commented Mar 12, 2021

stenzengel commented Mar 23, 2021

dbaeumer commented Mar 24, 2021

stenzengel commented Mar 24, 2021

dbaeumer commented Mar 25, 2021

JoshuaKGoldberg commented Mar 28, 2021

stenzengel commented Mar 28, 2021

JoshuaKGoldberg commented Mar 28, 2021

dbaeumer commented Mar 29, 2021

dbaeumer commented Mar 30, 2021

JoshuaKGoldberg commented Mar 30, 2021

dbaeumer left a comment

Choose a reason for hiding this comment

dbaeumer commented Apr 6, 2021

dbaeumer commented Apr 6, 2021

JoshuaKGoldberg commented Apr 6, 2021

stenzengel commented Apr 6, 2021

lolmaus commented Apr 7, 2021

dbaeumer commented Apr 7, 2021

lolmaus commented Apr 7, 2021

lolmaus commented Apr 7, 2021

lolmaus commented Apr 8, 2021

JoshuaKGoldberg commented Jan 23, 2021 •

edited

Loading