-
Notifications
You must be signed in to change notification settings - Fork 55
/
typescript.js
339 lines (327 loc) · 14.7 KB
/
typescript.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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
module.exports = {
extends: ['plugin:@shopify/esnext', 'plugin:import/typescript'],
plugins: ['@typescript-eslint'],
overrides: [
{
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 2021,
sourceType: 'module',
},
files: ['*.ts', '*.tsx'],
rules: {
// This rule extends the base eslint/keyword-spacing rule.
// This version adds support for generic type parameters on function calls.
'keyword-spacing': 'off',
'@typescript-eslint/keyword-spacing': [
'error',
{before: true, after: true, overrides: {}},
],
// Enforce one space after the colon and zero spaces before the colon of a type annotation.
'@typescript-eslint/type-annotation-spacing': ['error'],
// Require explicit return types on functions and class methods
'@typescript-eslint/explicit-function-return-type': 'off',
// Enforce accessibility modifiers on class properties and methods. (member-access from TSLint)
'@typescript-eslint/explicit-member-accessibility': 'off',
// Enforce interface names are prefixed. (interface-name from TSLint)
'@typescript-eslint/interface-name-prefix': 'off',
// Enforce naming conventions for class members by visibility.
'@typescript-eslint/member-naming': 'off',
// Disallow generic Array constructors
'@typescript-eslint/no-array-constructor': 'error',
// Enforce the any type is not used. (no-any from TSLint)
'@typescript-eslint/no-explicit-any': 'off',
// Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean. (no-inferrable-types from TSLint)
'@typescript-eslint/no-inferrable-types': [
'error',
{
ignoreParameters: false,
ignoreProperties: false,
},
],
// Disallow the use of custom TypeScript modules and namespaces
'@typescript-eslint/no-namespace': [
'error',
{allowDeclarations: false, allowDefinitionFiles: false},
],
// Disallow non-null assertions using the ! postfix operator
'@typescript-eslint/no-non-null-assertion': 'off',
// Disallow the use of variables before they are defined.
'@typescript-eslint/no-use-before-define': 'off',
// Disallows the use of require statements except in import statements (no-var-requires from TSLint)
'@typescript-eslint/no-var-requires': 'error',
// Enforce the use of the keyword namespace over module to declare custom TypeScript modules. (no-internal-module from TSLint)
'@typescript-eslint/prefer-namespace-keyword': 'off',
// Disallow the use of type aliases. (interface-over-type-literal from TSLint)
'@typescript-eslint/no-type-alias': 'off',
// Enforce a standard member declaration order. (member-ordering from TSLint)
'@typescript-eslint/member-ordering': [
'error',
{
default: [
'public-static-field',
'protected-static-field',
'private-static-field',
'public-static-method',
'protected-static-method',
'private-static-method',
'public-instance-field',
'protected-instance-field',
'private-instance-field',
'constructor',
'public-instance-method',
'protected-instance-method',
'private-instance-method',
],
},
],
// Prevent TypeScript-specific constructs from being erroneously flagged as unused
'@typescript-eslint/no-unused-vars': 'off',
// Enforce member overloads to be consecutive.
'@typescript-eslint/adjacent-overload-signatures': 'error',
// Disallow parameter properties in class constructors. (no-parameter-properties from TSLint)
'@typescript-eslint/no-parameter-properties': 'off',
// Enforce a member delimiter style in interfaces and type literals.
'@typescript-eslint/member-delimiter-style': [
'error',
{
multiline: {
delimiter: 'semi',
requireLast: true,
},
singleline: {
delimiter: 'semi',
requireLast: true,
},
},
],
// Disallow the declaration of empty interfaces. (no-empty-interface from TSLint)
'@typescript-eslint/no-empty-interface': 'off',
// Requires using either T[] for arrays (array-type)
'@typescript-eslint/array-type': [
'error',
{
default: 'array',
readonly: 'generic',
},
],
// Enforces that types will not to be used
'@typescript-eslint/ban-types': [
'error',
{
types: {
String: {message: 'Use string instead', fixWith: 'string'},
Boolean: {message: 'Use boolean instead', fixWith: 'boolean'},
Number: {message: 'Use number instead', fixWith: 'number'},
Object: {message: 'Use object instead', fixWith: 'object'},
Array: {message: 'Provide a more specific type'},
},
},
],
// Enforce camelCase naming convention and PascalCase class and interface names
'@typescript-eslint/naming-convention': [
'error',
{
selector: 'default',
format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
leadingUnderscore: 'allow',
trailingUnderscore: 'allow',
},
{
selector: 'default',
filter: {
match: true,
// Allow double underscores and React UNSAFE_ (for lifecycle hooks that are to be deprecated)
regex: '^(__|UNSAFE_).+$',
},
format: null,
},
{
selector: 'typeLike',
format: ['PascalCase'],
},
{
selector: 'typeParameter',
format: ['PascalCase'],
prefix: ['T'],
},
{
selector: 'interface',
format: ['PascalCase'],
custom: {
regex: '^I[A-Z]',
match: false,
},
},
],
// Enforces naming of generic type variables
'@typescript-eslint/generic-type-naming': 'off',
// Enforce consistent indentation
'@typescript-eslint/indent': 'off',
// Forbids the use of classes as namespaces
'@typescript-eslint/no-extraneous-class': [
'error',
{
allowConstructorOnly: false,
allowEmpty: false,
allowStaticOnly: false,
},
],
// Enforce valid definition of new and constructor
'@typescript-eslint/no-misused-new': 'error',
// Disallows invocation of require()
'@typescript-eslint/no-require-imports': 'off',
// Disallow aliasing this
'@typescript-eslint/no-this-alias': [
'error',
{allowDestructuring: true, allowedNames: []},
],
// Disallow unnecessary constructors
'@typescript-eslint/no-useless-constructor': 'off',
// Use function types instead of interfaces with call signatures
'@typescript-eslint/prefer-function-type': 'off',
// Functions that return promises must be async
'@typescript-eslint/promise-function-async': 'off',
// Bans “// @ts-ignore” comments from being used. "@ts-expect-error: some comment describing why it's disabled" is allowed
'@typescript-eslint/ban-ts-comment': 'error',
// Enforce consistent brace style for blocks
'@typescript-eslint/brace-style': 'error',
// Enforces consistent usage of type assertions.
'@typescript-eslint/consistent-type-assertions': [
'error',
{assertionStyle: 'as', objectLiteralTypeAssertions: 'allow'},
],
// Consistent with type definition either interface or type
'@typescript-eslint/consistent-type-definitions': [
'error',
'interface',
],
// Require or disallow spacing between function identifiers and their invocations
'@typescript-eslint/func-call-spacing': 'error',
// Disallow empty functions
'@typescript-eslint/no-empty-function': 'off',
// Disallow unnecessary parentheses
'@typescript-eslint/no-extra-parens': 'error',
// Requires Promise-like values to be handled appropriately.
'@typescript-eslint/no-floating-promises': 'off',
// Disallows magic numbers
'@typescript-eslint/no-magic-numbers': 'off',
// Prefer a ‘for-of’ loop over a standard ‘for’ loop if the index is only used to access the array being iterated
'@typescript-eslint/prefer-for-of': 'error',
// Enforce the consistent use of either backticks, double, or single quotes
'@typescript-eslint/quotes': [
'error',
'single',
{avoidEscape: true, allowTemplateLiterals: true},
],
// Enforce giving compare argument to Array#sort
'@typescript-eslint/require-array-sort-compare': 'off',
// Require or disallow semicolons instead of ASI
'@typescript-eslint/semi': 'error',
// Restricts the types allowed in boolean expressions
'@typescript-eslint/strict-boolean-expressions': 'off',
// Sets preference level for triple slash directives versus ES6-style import declarations
'@typescript-eslint/triple-slash-reference': [
'error',
{path: 'never', types: 'never', lib: 'never'},
],
// Requires type annotations to exist
'@typescript-eslint/typedef': 'off',
// Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter
'@typescript-eslint/unified-signatures': 'error',
// The rules below require type information and are slower to run.
// We disable them here to keep this config lightweight, but enable
// them in the `typescript/requiring-type-checking` config.
// Disallows awaiting a value that is not a Thenable
'@typescript-eslint/await-thenable': 'off',
// Disallow iterating over an array with a for-in loop
'@typescript-eslint/no-for-in-array': 'off',
// Avoid using promises in places not designed to handle them
'@typescript-eslint/no-misused-promises': 'off',
// Warns if a type assertion does not change the type of an expression
'@typescript-eslint/no-unnecessary-type-assertion': 'off',
// Enforce includes method over indexOf method
'@typescript-eslint/prefer-includes': 'off',
// Prefer RegExp#exec() over String#match() if no global flag is provided
'@typescript-eslint/prefer-regexp-exec': 'off',
// Enforce the use of String#startsWith and String#endsWith instead of other equivalent methods of checking substrings
'@typescript-eslint/prefer-string-starts-ends-with': 'off',
// Disallow async functions which have no await expression
'@typescript-eslint/require-await': 'off',
// Enforces unbound methods are called with their expected scope
'@typescript-eslint/unbound-method': 'off',
// Warns when a namespace qualifier is unnecessary
'@typescript-eslint/no-unnecessary-qualifier': 'off',
// When adding two variables, operands must both be of type number or of type string
'@typescript-eslint/restrict-plus-operands': 'off',
// Prevents conditionals where the type is always truthy or always falsy
'@typescript-eslint/no-unnecessary-condition': 'off',
// Warns if an explicitly specified type argument is the default for that type parameter
'@typescript-eslint/no-unnecessary-type-arguments': 'off',
// Requires that private members are marked as readonly if they're never modified outside of the constructor
'@typescript-eslint/prefer-readonly': 'off',
// This rule enforces a consistent way to define records.
'@typescript-eslint/consistent-indexed-object-style': 'error',
// Disallows unnecessary constraints on generic types
'@typescript-eslint/no-unnecessary-type-constraint': 'error',
// Enforce consistent spacing inside braces
// disabling the base rule as it can report incorrect errors
'object-curly-spacing': 'off',
'@typescript-eslint/object-curly-spacing': 'error',
// This rule is aimed at ensuring there are spaces around infix operators.
// disabling the base rule as it can report incorrect errors
'space-infix-ops': 'off',
'@typescript-eslint/space-infix-ops': 'error',
// TypeScript provides a better mechanism (explicit `this` type)
// for ensuring proper `this` usage in functions not assigned to
// object properties.
'@babel/no-invalid-this': 'off',
// Handled by TypeScript itself
'no-undef': 'off',
'no-unused-expressions': 'off',
'no-unused-vars': 'off',
'no-useless-constructor': 'off',
'no-shadow': 'off',
'no-use-before-define': 'off',
semi: 'off',
quotes: 'off',
indent: 'off',
'brace-style': 'off',
'require-await': 'off',
'no-magic-numbers': 'off',
'no-extra-parens': 'off',
'no-empty-function': 'off',
'func-call-spacing': 'off',
'@shopify/no-fully-static-classes': 'off',
'sort-class-members/sort-class-members': 'off',
camelcase: 'off',
'no-array-constructor': 'off',
'no-dupe-args': 'off',
'no-dupe-keys': 'off',
'no-unreachable': 'off',
'valid-typeof': 'off',
'no-const-assign': 'off',
'no-new-symbol': 'off',
'no-this-before-super': 'off',
'no-redeclare': 'off',
// Does not support TS equivalent
'import/no-unresolved': 'off',
// Flag overloaded methods in TS
'no-dupe-class-members': 'off',
// Flag typedef files with multiple modules with export default
'import/export': 'off',
// Breaks @typescript-eslint/parser
strict: 'off',
'@shopify/prefer-early-return': 'off',
'array-callback-return': 'off',
'getter-return': 'off',
// Prefer TypeScript enums be defined using Pascal case
'@shopify/typescript/prefer-pascal-case-enums': 'error',
// Prefer TypeScript enums be defined using singular names
'@shopify/typescript/prefer-singular-enums': 'error',
// Prefer buildClientSchema for schema building.
'@shopify/typescript/prefer-build-client-schema': 'error',
},
},
],
};