/
.eslintrc.js
234 lines (217 loc) · 9.64 KB
/
.eslintrc.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
// `@rushstack/eslint-patch` patches eslint so that shared configs can include
// plugins as dependencies. Without this patch, plugins have to be included as
// peer dependencies in studios.
//
// create-react-app https://github.com/facebook/create-react-app/blob/9673858a3715287c40aef9e800c431c7d45c05a2/packages/eslint-config-react-app/base.js#L11
// and next.js: https://github.com/vercel/next.js/blob/0de84472eb565d5ecae1e6b71994f0cd46c8ecb9/packages/eslint-config-next/index.js#L7
// both use this
require("@rushstack/eslint-patch/modern-module-resolution");
// The ESLint browser environment defines all browser globals as valid,
// even though most people don't know some of them exist (e.g. `name` or `status`).
// This is dangerous as it hides accidentally undefined variables.
// We blacklist the globals that we deem potentially confusing.
// To use them, explicitly reference them, e.g. `window.name` or `window.status`.
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L19-L24
const restrictedGlobals = require("confusing-browser-globals");
/**
* `@sanity/eslint-config-studio` is meant to be a relatively unobtrusive eslint
* config that will purely help find bug instead enforce opinions
*/
module.exports = {
plugins: ["react", "react-hooks", "jsx-a11y"],
env: {
browser: true,
commonjs: true,
es6: true,
node: true,
jest: true,
},
// `@babel/eslint-parser` is used instead of `@typescript-eslint/parser`
// because `@typescript-eslint/parser` requires typescript as a peer
// dependency and we don't want to enforce typescript as a dependency
parser: "@babel/eslint-parser",
parserOptions: {
requireConfigFile: false,
babelOptions: {
presets: [
["@babel/preset-env", { targets: "maintained node versions" }],
"@babel/preset-react",
],
},
},
// removes warning "React version not specified in eslint-plugin-react settings"
settings: { react: { version: "detect" } },
// inspired by:
// - https://github.com/eslint/eslint/blob/dd58cd4afa6ced9016c091fc99a702c97a3e44f0/conf/eslint-recommended.js#L14-L74
// - https://github.com/suchipi/eslint-config-unobtrusive/blob/744a7f23a549c3dcf0a35a0d43372a268af4f028/index.js
rules: {
"constructor-super": "error",
"for-direction": "error",
"getter-return": "error",
"no-case-declarations": "warn",
"no-class-assign": "warn",
"no-compare-neg-zero": "warn",
// https://github.com/suchipi/eslint-config-unobtrusive/blob/744a7f23a549c3dcf0a35a0d43372a268af4f028/index.js#L43-L52
"no-cond-assign": ["warn", "except-parens"],
"no-const-assign": "error",
// https://github.com/suchipi/eslint-config-unobtrusive/blob/744a7f23a549c3dcf0a35a0d43372a268af4f028/index.js#L58-L63
"no-constant-condition": ["warn", { checkLoops: false }],
"no-debugger": "warn",
"no-delete-var": "error",
"no-dupe-args": "error",
"no-dupe-class-members": "error", // Note: has a TS extension
"no-dupe-else-if": "error",
"no-dupe-keys": "error",
"no-duplicate-case": "error",
"no-empty-character-class": "warn",
"no-empty-function": "warn", // Note: has a TS extension
"no-empty-pattern": "warn",
"no-ex-assign": "warn",
"no-func-assign": "warn",
"no-global-assign": "error",
"no-import-assign": "error",
"no-invalid-regexp": "error",
"no-loss-of-precision": "warn", // Note: has a TS extension
"no-misleading-character-class": "warn",
"no-new-symbol": "error",
"no-nonoctal-decimal-escape": "warn",
"no-obj-calls": "error",
"no-octal": "error",
"no-redeclare": "warn", // Note: has a TS extension
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L165
"no-restricted-globals": ["warn"].concat(restrictedGlobals),
"no-self-assign": "warn",
"no-setter-return": "warn",
"no-shadow-restricted-names": "error",
"no-sparse-arrays": "warn",
"no-this-before-super": "error",
"no-undef": "error",
"no-unexpected-multiline": "warn",
"no-unreachable": "warn",
"no-unsafe-finally": "warn",
"no-unsafe-negation": "warn",
"no-unsafe-optional-chaining": "warn",
// typically represents an unfinished assignment
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L167-L174
// Note: has a TS extension
"no-unused-expressions": [
"warn",
{
allowShortCircuit: true,
allowTernary: true,
allowTaggedTemplates: true,
},
],
"no-unused-labels": "warn",
// rest siblings are fine
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L176-L182
// Note: has a TS extension
"no-unused-vars": ["warn", { args: "none", ignoreRestSiblings: true }],
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L183-L190
// Note: has TS extension
"no-use-before-define": [
"warn",
{ functions: false, classes: false, variables: false },
],
"no-useless-backreference": "warn",
"no-useless-escape": "warn",
"no-with": "error",
"require-yield": "warn",
"use-isnan": "warn",
// https://github.com/suchipi/eslint-config-unobtrusive/blob/744a7f23a549c3dcf0a35a0d43372a268af4f028/index.js#L217-L225
"valid-typeof": ["warn", { requireStringLiterals: false }],
// mostly inspired by plugin:react/recommended but less strict
// https://github.com/yannickcr/eslint-plugin-react/blob/151bb2b13892969bea17b334e882eb422152c30a/index.js#L124-L157
"react/jsx-key": "warn",
"react/jsx-no-comment-textnodes": "warn",
"react/jsx-no-duplicate-props": "error",
"react/jsx-no-target-blank": "warn",
"react/jsx-uses-react": "error",
"react/jsx-uses-vars": "warn",
"react/no-danger-with-children": "warn",
"react/no-direct-mutation-state": "error",
"react/no-is-mounted": "warn",
"react/no-render-return-value": "error",
"react/no-string-refs": "error",
"react/no-typos": "warn",
"react/no-unescaped-entities": "error",
"react/no-unknown-property": "warn",
"react/prop-types": "warn",
"react/react-in-jsx-scope": "error",
"react/require-render-return": "error",
"react/style-prop-object": "warn",
// https://github.com/facebook/react/blob/9a7e6bf0d0cf08114b74c9fe45c06e60a5e496e4/packages/eslint-plugin-react-hooks/src/index.js#L17-L18
"react-hooks/rules-of-hooks": "error",
"react-hooks/exhaustive-deps": "warn",
// inspired by eslint-config-react-app
// https://github.com/facebook/create-react-app/blob/9673858a3715287c40aef9e800c431c7d45c05a2/packages/eslint-config-react-app/index.js#L260-L281
"jsx-a11y/alt-text": "warn",
"jsx-a11y/anchor-has-content": "warn",
"jsx-a11y/aria-activedescendant-has-tabindex": "warn",
"jsx-a11y/aria-props": "warn",
"jsx-a11y/aria-proptypes": "warn",
"jsx-a11y/aria-role": ["warn", { ignoreNonDOM: true }],
"jsx-a11y/aria-unsupported-elements": "warn",
"jsx-a11y/heading-has-content": "warn",
"jsx-a11y/iframe-has-title": "warn",
"jsx-a11y/img-redundant-alt": "warn",
"jsx-a11y/no-access-key": "warn",
"jsx-a11y/no-distracting-elements": "warn",
"jsx-a11y/no-redundant-roles": "warn",
"jsx-a11y/role-has-required-aria-props": "warn",
"jsx-a11y/role-supports-aria-props": "warn",
"jsx-a11y/scope": "warn",
},
overrides: [
{
files: ["**/*.ts?(x)"],
plugins: ["@typescript-eslint"],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 2018,
ecmaFeatures: { jsx: true },
},
rules: {
// https://typescript-eslint.io/rules/#extension-rules
"no-dupe-class-members": "off",
"@typescript-eslint/no-dupe-class-members": "error",
"no-empty-function": "off",
"@typescript-eslint/no-empty-function": "warn",
"no-loss-of-precision": "off",
"@typescript-eslint/no-loss-of-precision": "warn",
"no-redeclare": "off",
"@typescript-eslint/no-redeclare": "warn",
// TypeScript should do a good job at this
"no-unsafe-optional-chaining": "off",
"no-undef": "off",
"react/react-in-jsx-scope": "off",
"no-unused-vars": "off",
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L82-L88
"@typescript-eslint/no-unused-vars": [
"warn",
{ args: "none", ignoreRestSiblings: true },
],
"no-use-before-define": "off",
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L63-L71
"@typescript-eslint/no-use-before-define": [
"warn",
{ functions: false, classes: false, variables: false },
],
"no-unused-expressions": "off",
// https://github.com/facebook/create-react-app/blob/a422bf227cf5294a34d68696664e9568a152fd8f/packages/eslint-config-react-app/index.js#L73-L80
"@typescript-eslint/no-unused-expressions": [
"warn",
{
allowShortCircuit: true,
allowTernary: true,
allowTaggedTemplates: true,
},
],
// ts-only rules
"@typescript-eslint/no-empty-interface": "warn",
"@typescript-eslint/no-extra-non-null-assertion": "warn",
"@typescript-eslint/no-misused-new": "warn",
},
},
],
};