Skip to content

Commit 5be64be

Browse files
abrahamguoKenneth-SillsJounQin
authored
feat: add support for @stylistic/eslint-plugin (#272)
Co-authored-by: Kenneth Sills <[email protected]> Co-authored-by: JounQin <[email protected]>
1 parent 5687e7d commit 5be64be

16 files changed

+6521
-13484
lines changed

‎.changeset/purple-snakes-call.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"eslint-config-prettier": major
3+
---
4+
5+
add support for @stylistic formatting rules

‎.eslintrc.base.js

+17-1
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,25 @@ module.exports = {
9595
},
9696
},
9797
{
98-
files: ["test-lint/{react,flowtype}.js"],
98+
files: ["test-lint/{react,flowtype}.js", "test-lint/@stylistic__jsx.jsx"],
9999
parserOptions: { parser: "@babel/eslint-parser" },
100100
},
101+
{
102+
files: ["test-lint/@stylistic.js"],
103+
extends: ["plugin:@stylistic/all-extends"],
104+
},
105+
{
106+
files: ["test-lint/@stylistic__js.js"],
107+
extends: ["plugin:@stylistic/js/all-extends"],
108+
},
109+
{
110+
files: ["test-lint/@stylistic__jsx.jsx"],
111+
extends: ["plugin:@stylistic/jsx/all-extends"],
112+
},
113+
{
114+
files: ["test-lint/@stylistic__ts.ts"],
115+
extends: ["plugin:@stylistic/ts/all-extends"],
116+
},
101117
],
102118
settings: {
103119
react: {

‎.eslintrc.js

+3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ module.exports = {
3232
{ avoidEscape: true, allowTemplateLiterals: false },
3333
],
3434
},
35+
parserOptions: {
36+
ecmaVersion: "latest",
37+
},
3538
},
3639
{
3740
files: ["**/*.test.js"],

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
/build/
22
/node_modules/
33
/test-config/
4+
/.idea/

‎README.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Example ESLint configuration:
277277

278278
### [lines-around-comment] \(deprecated)
279279

280-
(The following applies to [@typescript-eslint/lines-around-comment] as well.)
280+
(The following applies to [@stylistic/lines-around-comment], [@stylistic/js/lines-around-comment], [@stylistic/ts/lines-around-comment], and [@typescript-eslint/lines-around-comment] as well.)
281281

282282
**This rule can be used with certain options.**
283283

@@ -336,7 +336,7 @@ Example ESLint configuration:
336336

337337
### [max-len] \(deprecated)
338338

339-
(The following applies to [vue/max-len] as well.)
339+
(The following applies to [@stylistic/max-len], [@stylistic/js/max-len], and [vue/max-len] as well.)
340340

341341
**This rule requires special attention when writing code.**
342342

@@ -359,6 +359,8 @@ Example ESLint configuration:
359359

360360
### [no-confusing-arrow] \(deprecated)
361361

362+
(The following applies to [@stylistic/no-confusing-arrow] and [@stylistic/js/no-confusing-arrow] as well.)
363+
362364
**This rule requires certain options.**
363365

364366
For example, the rule could warn about this line:
@@ -409,6 +411,8 @@ Example ESLint configuration:
409411

410412
### [no-mixed-operators] \(deprecated)
411413

414+
(The following applies to [@stylistic/no-mixed-operators] and [@stylistic/js/no-mixed-operators] as well.)
415+
412416
**This rule requires special attention when writing code.**
413417

414418
This rule forbids mixing certain operators, such as `&&` and `||`.
@@ -462,6 +466,8 @@ Example ESLint configuration:
462466

463467
### [no-tabs] \(deprecated)
464468

469+
(The following applies to [@stylistic/no-tabs] and [@stylistic/js/no-tabs] as well.)
470+
465471
**This rule requires certain options.**
466472

467473
This rule disallows the use of tab characters. By default the rule forbids _all_ tab characters. That can be used just fine with Prettier as long as you don’t configure Prettier to indent using tabs.
@@ -548,7 +554,7 @@ Example configuration:
548554

549555
### [quotes] \(deprecated)
550556

551-
(The following applies to [babel/quotes] and [@typescript-eslint/quotes] as well.)
557+
(The following applies to [babel/quotes], [@stylistic/quotes], [@stylistic/js/quotes], [@stylistic/ts/quotes], and [@typescript-eslint/quotes] as well.)
552558

553559
**This rule requires certain options and certain Prettier options.**
554560

@@ -853,6 +859,20 @@ When you’re done, run `npm test` to verify that you got it all right. It runs
853859
[MIT](LICENSE).
854860

855861
[@babel/eslint-plugin]: https://github.com/babel/babel/tree/main/eslint/babel-eslint-plugin
862+
[@stylistic/lines-around-comment]: https://eslint.style/rules/default/lines-around-comment
863+
[@stylistic/js/lines-around-comment]: https://eslint.style/rules/js/lines-around-comment
864+
[@stylistic/ts/lines-around-comment]: https://eslint.style/rules/ts/lines-around-comment
865+
[@stylistic/max-len]: https://eslint.style/rules/default/max-len
866+
[@stylistic/js/max-len]: https://eslint.style/rules/js/max-len
867+
[@stylistic/no-confusing-arrow]: https://eslint.style/rules/default/no-confusing-arrow
868+
[@stylistic/js/no-confusing-arrow]: https://eslint.style/rules/js/no-confusing-arrow
869+
[@stylistic/no-mixed-operators]: https://eslint.style/rules/default/no-mixed-operators
870+
[@stylistic/js/no-mixed-operators]: https://eslint.style/rules/js/no-mixed-operators
871+
[@stylistic/no-tabs]: https://eslint.style/rules/default/no-tabs
872+
[@stylistic/js/no-tabs]: https://eslint.style/rules/js/no-tabs
873+
[@stylistic/quotes]: https://eslint.style/rules/default/quotes
874+
[@stylistic/js/quotes]: https://eslint.style/rules/js/quotes
875+
[@stylistic/ts/quotes]: https://eslint.style/rules/ts/quotes
856876
[@typescript-eslint/eslint-plugin]: https://github.com/typescript-eslint/typescript-eslint
857877
[@typescript-eslint/lines-around-comment]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/lines-around-comment.md
858878
[@typescript-eslint/quotes]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/quotes.md

‎eslint.base.config.js

+27-4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ const google = require("eslint-config-google");
1515
const prettier = require("eslint-plugin-prettier");
1616
const react = require("eslint-plugin-react");
1717
const standard = require("eslint-plugin-standard");
18+
const stylistic = require("@stylistic/eslint-plugin");
19+
const stylisticJs = require("@stylistic/eslint-plugin-js");
20+
const stylisticTs = require("@stylistic/eslint-plugin-ts");
21+
const stylisticJsx = require("@stylistic/eslint-plugin-jsx");
1822
const typescriptEslint = require("@typescript-eslint/eslint-plugin");
1923
const unicorn = require("eslint-plugin-unicorn");
2024
const vue = require("eslint-plugin-vue");
@@ -38,6 +42,10 @@ module.exports = [
3842
"@typescript-eslint": typescriptEslint,
3943
"babel": babelOld,
4044
"@babel": babelNew,
45+
"@stylistic": stylistic,
46+
"@stylistic/js": stylisticJs,
47+
"@stylistic/ts": stylisticTs,
48+
"@stylistic/jsx": stylisticJsx,
4149
flowtype,
4250
prettier,
4351
react,
@@ -81,8 +89,23 @@ module.exports = [
8189
...vue.configs.recommended.rules,
8290
},
8391
},
84-
...eslintrcBase.overrides.map(({ parserOptions, ...override }) => ({
85-
...override,
86-
languageOptions: { parser: require(parserOptions.parser) },
87-
})),
92+
...eslintrcBase.overrides
93+
.filter(({ parserOptions }) => parserOptions)
94+
.map(({ parserOptions, ...override }) => ({
95+
...override,
96+
languageOptions: { parser: require(parserOptions.parser) },
97+
})),
98+
{ files: ["test-lint/@stylistic.js"], ...stylistic.configs["all-flat"] },
99+
{
100+
files: ["test-lint/@stylistic__js.js"],
101+
...stylisticJs.configs["all-flat"],
102+
},
103+
{
104+
files: ["test-lint/@stylistic__jsx.jsx"],
105+
...stylisticJsx.configs["all-flat"],
106+
},
107+
{
108+
files: ["test-lint/@stylistic__ts.ts"],
109+
...stylisticTs.configs["all-flat"],
110+
},
88111
];

‎eslint.config.js

+13-9
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@ module.exports = [
2121
{
2222
rules: eslintrc.rules,
2323
},
24-
...eslintrc.overrides.map(({ env = {}, ...override }) => ({
25-
...override,
26-
languageOptions: {
27-
globals: Object.entries(env).reduce(
28-
(acc, [key, enabled]) => (enabled ? { ...acc, ...globals[key] } : acc),
29-
{}
30-
),
31-
},
32-
})),
24+
...eslintrc.overrides.map(
25+
({ env = {}, parserOptions = {}, ...override }) => ({
26+
...override,
27+
languageOptions: {
28+
globals: Object.entries(env).reduce(
29+
(acc, [key, enabled]) =>
30+
enabled ? { ...acc, ...globals[key] } : acc,
31+
{}
32+
),
33+
parserOptions,
34+
},
35+
})
36+
),
3337
];

‎index.js

+180
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,20 @@ module.exports = {
1212
// in the deprecated section below.
1313
"curly": specialRule,
1414
"no-unexpected-multiline": specialRule,
15+
"@stylistic/lines-around-comment": specialRule,
16+
"@stylistic/max-len": specialRule,
17+
"@stylistic/no-confusing-arrow": specialRule,
18+
"@stylistic/no-mixed-operators": specialRule,
19+
"@stylistic/no-tabs": specialRule,
20+
"@stylistic/quotes": specialRule,
21+
"@stylistic/js/lines-around-comment": specialRule,
22+
"@stylistic/js/max-len": specialRule,
23+
"@stylistic/js/no-confusing-arrow": specialRule,
24+
"@stylistic/js/no-mixed-operators": specialRule,
25+
"@stylistic/js/no-tabs": specialRule,
26+
"@stylistic/js/quotes": specialRule,
27+
"@stylistic/ts/lines-around-comment": specialRule,
28+
"@stylistic/ts/quotes": specialRule,
1529
"@typescript-eslint/lines-around-comment": specialRule,
1630
"@typescript-eslint/quotes": specialRule,
1731
"babel/quotes": specialRule,
@@ -22,6 +36,172 @@ module.exports = {
2236
// The rest are rules that you never need to enable when using Prettier.
2337
"@babel/object-curly-spacing": "off",
2438
"@babel/semi": "off",
39+
"@stylistic/array-bracket-newline": "off",
40+
"@stylistic/array-bracket-spacing": "off",
41+
"@stylistic/array-element-newline": "off",
42+
"@stylistic/arrow-parens": "off",
43+
"@stylistic/arrow-spacing": "off",
44+
"@stylistic/block-spacing": "off",
45+
"@stylistic/brace-style": "off",
46+
"@stylistic/comma-dangle": "off",
47+
"@stylistic/comma-spacing": "off",
48+
"@stylistic/comma-style": "off",
49+
"@stylistic/computed-property-spacing": "off",
50+
"@stylistic/dot-location": "off",
51+
"@stylistic/eol-last": "off",
52+
"@stylistic/func-call-spacing": "off",
53+
"@stylistic/function-call-argument-newline": "off",
54+
"@stylistic/function-call-spacing": "off",
55+
"@stylistic/function-paren-newline": "off",
56+
"@stylistic/generator-star-spacing": "off",
57+
"@stylistic/implicit-arrow-linebreak": "off",
58+
"@stylistic/indent": "off",
59+
"@stylistic/jsx-quotes": "off",
60+
"@stylistic/key-spacing": "off",
61+
"@stylistic/keyword-spacing": "off",
62+
"@stylistic/linebreak-style": "off",
63+
"@stylistic/max-statements-per-line": "off",
64+
"@stylistic/multiline-ternary": "off",
65+
"@stylistic/new-parens": "off",
66+
"@stylistic/newline-per-chained-call": "off",
67+
"@stylistic/no-extra-parens": "off",
68+
"@stylistic/no-extra-semi": "off",
69+
"@stylistic/no-floating-decimal": "off",
70+
"@stylistic/no-mixed-spaces-and-tabs": "off",
71+
"@stylistic/no-multi-spaces": "off",
72+
"@stylistic/no-multiple-empty-lines": "off",
73+
"@stylistic/no-trailing-spaces": "off",
74+
"@stylistic/no-whitespace-before-property": "off",
75+
"@stylistic/nonblock-statement-body-position": "off",
76+
"@stylistic/object-curly-newline": "off",
77+
"@stylistic/object-curly-spacing": "off",
78+
"@stylistic/object-property-newline": "off",
79+
"@stylistic/one-var-declaration-per-line": "off",
80+
"@stylistic/operator-linebreak": "off",
81+
"@stylistic/padded-blocks": "off",
82+
"@stylistic/quote-props": "off",
83+
"@stylistic/rest-spread-spacing": "off",
84+
"@stylistic/semi": "off",
85+
"@stylistic/semi-spacing": "off",
86+
"@stylistic/semi-style": "off",
87+
"@stylistic/space-before-blocks": "off",
88+
"@stylistic/space-before-function-paren": "off",
89+
"@stylistic/space-in-parens": "off",
90+
"@stylistic/space-infix-ops": "off",
91+
"@stylistic/space-unary-ops": "off",
92+
"@stylistic/switch-colon-spacing": "off",
93+
"@stylistic/template-curly-spacing": "off",
94+
"@stylistic/template-tag-spacing": "off",
95+
"@stylistic/wrap-iife": "off",
96+
"@stylistic/wrap-regex": "off",
97+
"@stylistic/yield-star-spacing": "off",
98+
"@stylistic/member-delimiter-style": "off",
99+
"@stylistic/type-annotation-spacing": "off",
100+
"@stylistic/jsx-child-element-spacing": "off",
101+
"@stylistic/jsx-closing-bracket-location": "off",
102+
"@stylistic/jsx-closing-tag-location": "off",
103+
"@stylistic/jsx-curly-newline": "off",
104+
"@stylistic/jsx-curly-spacing": "off",
105+
"@stylistic/jsx-equals-spacing": "off",
106+
"@stylistic/jsx-first-prop-new-line": "off",
107+
"@stylistic/jsx-indent": "off",
108+
"@stylistic/jsx-indent-props": "off",
109+
"@stylistic/jsx-max-props-per-line": "off",
110+
"@stylistic/jsx-newline": "off",
111+
"@stylistic/jsx-one-expression-per-line": "off",
112+
"@stylistic/jsx-props-no-multi-spaces": "off",
113+
"@stylistic/jsx-tag-spacing": "off",
114+
"@stylistic/jsx-wrap-multilines": "off",
115+
"@stylistic/indent-binary-ops": "off",
116+
"@stylistic/type-generic-spacing": "off",
117+
"@stylistic/type-named-tuple-spacing": "off",
118+
"@stylistic/js/array-bracket-newline": "off",
119+
"@stylistic/js/array-bracket-spacing": "off",
120+
"@stylistic/js/array-element-newline": "off",
121+
"@stylistic/js/arrow-parens": "off",
122+
"@stylistic/js/arrow-spacing": "off",
123+
"@stylistic/js/block-spacing": "off",
124+
"@stylistic/js/brace-style": "off",
125+
"@stylistic/js/comma-dangle": "off",
126+
"@stylistic/js/comma-spacing": "off",
127+
"@stylistic/js/comma-style": "off",
128+
"@stylistic/js/computed-property-spacing": "off",
129+
"@stylistic/js/dot-location": "off",
130+
"@stylistic/js/eol-last": "off",
131+
"@stylistic/js/func-call-spacing": "off",
132+
"@stylistic/js/function-call-argument-newline": "off",
133+
"@stylistic/js/function-call-spacing": "off",
134+
"@stylistic/js/function-paren-newline": "off",
135+
"@stylistic/js/generator-star-spacing": "off",
136+
"@stylistic/js/implicit-arrow-linebreak": "off",
137+
"@stylistic/js/indent": "off",
138+
"@stylistic/js/jsx-quotes": "off",
139+
"@stylistic/js/key-spacing": "off",
140+
"@stylistic/js/keyword-spacing": "off",
141+
"@stylistic/js/linebreak-style": "off",
142+
"@stylistic/js/max-statements-per-line": "off",
143+
"@stylistic/js/multiline-ternary": "off",
144+
"@stylistic/js/new-parens": "off",
145+
"@stylistic/js/newline-per-chained-call": "off",
146+
"@stylistic/js/no-extra-parens": "off",
147+
"@stylistic/js/no-extra-semi": "off",
148+
"@stylistic/js/no-floating-decimal": "off",
149+
"@stylistic/js/no-mixed-spaces-and-tabs": "off",
150+
"@stylistic/js/no-multi-spaces": "off",
151+
"@stylistic/js/no-multiple-empty-lines": "off",
152+
"@stylistic/js/no-trailing-spaces": "off",
153+
"@stylistic/js/no-whitespace-before-property": "off",
154+
"@stylistic/js/nonblock-statement-body-position": "off",
155+
"@stylistic/js/object-curly-newline": "off",
156+
"@stylistic/js/object-curly-spacing": "off",
157+
"@stylistic/js/object-property-newline": "off",
158+
"@stylistic/js/one-var-declaration-per-line": "off",
159+
"@stylistic/js/operator-linebreak": "off",
160+
"@stylistic/js/padded-blocks": "off",
161+
"@stylistic/js/quote-props": "off",
162+
"@stylistic/js/rest-spread-spacing": "off",
163+
"@stylistic/js/semi": "off",
164+
"@stylistic/js/semi-spacing": "off",
165+
"@stylistic/js/semi-style": "off",
166+
"@stylistic/js/space-before-blocks": "off",
167+
"@stylistic/js/space-before-function-paren": "off",
168+
"@stylistic/js/space-in-parens": "off",
169+
"@stylistic/js/space-infix-ops": "off",
170+
"@stylistic/js/space-unary-ops": "off",
171+
"@stylistic/js/switch-colon-spacing": "off",
172+
"@stylistic/js/template-curly-spacing": "off",
173+
"@stylistic/js/template-tag-spacing": "off",
174+
"@stylistic/js/wrap-iife": "off",
175+
"@stylistic/js/wrap-regex": "off",
176+
"@stylistic/js/yield-star-spacing": "off",
177+
"@stylistic/ts/block-spacing": "off",
178+
"@stylistic/ts/brace-style": "off",
179+
"@stylistic/ts/comma-dangle": "off",
180+
"@stylistic/ts/comma-spacing": "off",
181+
"@stylistic/ts/func-call-spacing": "off",
182+
"@stylistic/ts/function-call-spacing": "off",
183+
"@stylistic/ts/indent": "off",
184+
"@stylistic/ts/key-spacing": "off",
185+
"@stylistic/ts/keyword-spacing": "off",
186+
"@stylistic/ts/member-delimiter-style": "off",
187+
"@stylistic/ts/no-extra-parens": "off",
188+
"@stylistic/ts/no-extra-semi": "off",
189+
"@stylistic/ts/object-curly-spacing": "off",
190+
"@stylistic/ts/semi": "off",
191+
"@stylistic/ts/space-before-blocks": "off",
192+
"@stylistic/ts/space-before-function-paren": "off",
193+
"@stylistic/ts/space-infix-ops": "off",
194+
"@stylistic/ts/type-annotation-spacing": "off",
195+
"@stylistic/jsx/jsx-child-element-spacing": "off",
196+
"@stylistic/jsx/jsx-closing-bracket-location": "off",
197+
"@stylistic/jsx/jsx-closing-tag-location": "off",
198+
"@stylistic/jsx/jsx-curly-newline": "off",
199+
"@stylistic/jsx/jsx-curly-spacing": "off",
200+
"@stylistic/jsx/jsx-equals-spacing": "off",
201+
"@stylistic/jsx/jsx-first-prop-new-line": "off",
202+
"@stylistic/jsx/jsx-indent": "off",
203+
"@stylistic/jsx/jsx-indent-props": "off",
204+
"@stylistic/jsx/jsx-max-props-per-line": "off",
25205
"@typescript-eslint/block-spacing": "off",
26206
"@typescript-eslint/brace-style": "off",
27207
"@typescript-eslint/comma-dangle": "off",

0 commit comments

Comments
 (0)