Repository navigation
Expand file tree
/
Copy patheslint.config.js
More file actions
339 lines (322 loc) · 10.9 KB
/
Copy patheslint.config.js
File metadata and controls
339 lines (322 loc) · 10.9 KB
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
'use strict'
const path = require('node:path')
const {
convertIgnorePatternToMinimatch,
includeIgnoreFile,
} = require('@eslint/compat')
const js = require('@eslint/js')
const tsParser = require('@typescript-eslint/parser')
const {
createTypeScriptImportResolver,
} = require('eslint-import-resolver-typescript')
const importXPlugin = require('eslint-plugin-import-x')
const nodePlugin = require('eslint-plugin-n')
const sortDestructureKeysPlugin = require('eslint-plugin-sort-destructure-keys')
const unicornPlugin = require('eslint-plugin-unicorn')
const globals = require('globals')
const tsEslint = require('typescript-eslint')
const constants = require('@socketsecurity/registry/lib/constants')
const { BIOME_JSON, GITIGNORE, LATEST, TSCONFIG_JSON } = constants
const { flatConfigs: origImportXFlatConfigs } = importXPlugin
const rootPath = __dirname
const rootTsConfigPath = path.join(rootPath, TSCONFIG_JSON)
const nodeGlobalsConfig = Object.fromEntries(
Object.entries(globals.node).map(([k]) => [k, 'readonly']),
)
const biomeConfigPath = path.join(rootPath, BIOME_JSON)
const biomeConfig = require(biomeConfigPath)
const biomeIgnores = {
name: 'Imported biome.json ignore patterns',
ignores: biomeConfig.files.includes
.filter(p => p.startsWith('!'))
.map(p => convertIgnorePatternToMinimatch(p.slice(1))),
}
const gitignorePath = path.join(rootPath, GITIGNORE)
const gitIgnores = includeIgnoreFile(gitignorePath)
if (process.env.LINT_DIST) {
const isNotDistGlobPattern = p => !/(?:^|[\\/])dist/.test(p)
biomeIgnores.ignores = biomeIgnores.ignores?.filter(isNotDistGlobPattern)
gitIgnores.ignores = gitIgnores.ignores?.filter(isNotDistGlobPattern)
}
if (process.env.LINT_EXTERNAL) {
const isNotExternalGlobPattern = p => !/(?:^|[\\/])external/.test(p)
biomeIgnores.ignores = biomeIgnores.ignores?.filter(isNotExternalGlobPattern)
gitIgnores.ignores = gitIgnores.ignores?.filter(isNotExternalGlobPattern)
}
const sharedPlugins = {
'sort-destructure-keys': sortDestructureKeysPlugin,
unicorn: unicornPlugin,
}
const sharedRules = {
'unicorn/consistent-function-scoping': 'error',
curly: 'error',
'no-await-in-loop': 'error',
'no-control-regex': 'error',
'no-empty': ['error', { allowEmptyCatch: true }],
'no-new': 'error',
'no-proto': 'error',
'no-undef': 'error',
'no-unused-vars': [
'error',
{
argsIgnorePattern: '^_|^this$',
ignoreRestSiblings: true,
varsIgnorePattern: '^_',
},
],
'no-var': 'error',
'no-warning-comments': ['warn', { terms: ['fixme'] }],
'prefer-const': 'error',
'sort-destructure-keys/sort-destructure-keys': 'error',
'sort-imports': ['error', { ignoreDeclarationSort: true }],
}
const sharedRulesForImportX = {
...origImportXFlatConfigs.recommended.rules,
'import-x/extensions': [
'error',
'never',
{
cjs: 'ignorePackages',
js: 'ignorePackages',
json: 'always',
mjs: 'ignorePackages',
mts: 'ignorePackages',
ts: 'ignorePackages',
},
],
'import-x/order': [
'warn',
{
groups: [
'builtin',
'external',
'internal',
['parent', 'sibling', 'index'],
'type',
],
pathGroups: [
{
pattern: '@socket{registry,security}/**',
group: 'internal',
},
],
pathGroupsExcludedImportTypes: ['type'],
'newlines-between': 'always',
alphabetize: {
order: 'asc',
},
},
],
}
const sharedRulesForNode = {
'n/exports-style': ['error', 'module.exports'],
'n/no-missing-require': ['off'],
// The n/no-unpublished-bin rule does does not support non-trivial glob
// patterns used in package.json "files" fields. In those cases we simplify
// the glob patterns used.
'n/no-unpublished-bin': 'error',
'n/no-unsupported-features/es-builtins': 'error',
'n/no-unsupported-features/es-syntax': 'error',
'n/no-unsupported-features/node-builtins': [
'error',
{
ignores: [
'fetch',
'fs.promises.cp',
'module.enableCompileCache',
'readline/promises',
'test',
'test.describe',
],
// Lazily access constants.maintainedNodeVersions.
version: constants.maintainedNodeVersions.current,
},
],
'n/prefer-node-protocol': 'error',
}
function getImportXFlatConfigs(isEsm) {
return {
recommended: {
...origImportXFlatConfigs.recommended,
languageOptions: {
...origImportXFlatConfigs.recommended.languageOptions,
ecmaVersion: LATEST,
sourceType: isEsm ? 'module' : 'script',
},
rules: {
...sharedRulesForImportX,
'import-x/no-named-as-default-member': 'off',
},
},
typescript: {
...origImportXFlatConfigs.typescript,
plugins: origImportXFlatConfigs.recommended.plugins,
settings: {
...origImportXFlatConfigs.typescript.settings,
'import-x/resolver-next': [
createTypeScriptImportResolver({
project: rootTsConfigPath,
}),
],
},
rules: {
...sharedRulesForImportX,
// TypeScript compilation already ensures that named imports exist in
// the referenced module.
'import-x/named': 'off',
'import-x/no-named-as-default-member': 'off',
'import-x/no-unresolved': 'off',
},
},
}
}
const importFlatConfigsForScript = getImportXFlatConfigs(false)
const importFlatConfigsForModule = getImportXFlatConfigs(true)
module.exports = [
gitIgnores,
biomeIgnores,
{
files: ['**/*.{cts,mts,ts}'],
...js.configs.recommended,
...importFlatConfigsForModule.typescript,
languageOptions: {
...js.configs.recommended.languageOptions,
...importFlatConfigsForModule.typescript.languageOptions,
globals: {
...js.configs.recommended.languageOptions?.globals,
...importFlatConfigsForModule.typescript.languageOptions?.globals,
...nodeGlobalsConfig,
BufferConstructor: 'readonly',
BufferEncoding: 'readonly',
NodeJS: 'readonly',
},
parser: tsParser,
parserOptions: {
...js.configs.recommended.languageOptions?.parserOptions,
...importFlatConfigsForModule.typescript.languageOptions?.parserOptions,
projectService: {
...importFlatConfigsForModule.typescript.languageOptions
?.parserOptions?.projectService,
allowDefaultProject: [
// Allow paths like src/utils/*.test.mts.
'src/*/*.test.mts',
// Allow paths like src/commands/optimize/*.test.mts.
'src/*/*/*.test.mts',
'test/*.mts',
'vitest.config.mts',
],
defaultProject: 'tsconfig.json',
tsconfigRootDir: rootPath,
// Need this to glob the test files in /src. Otherwise it won't work.
maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING: 1_000_000,
},
},
},
linterOptions: {
...js.configs.recommended.linterOptions,
...importFlatConfigsForModule.typescript.linterOptions,
reportUnusedDisableDirectives: 'off',
},
plugins: {
...js.configs.recommended.plugins,
...importFlatConfigsForModule.typescript.plugins,
...nodePlugin.configs['flat/recommended-module'].plugins,
...sharedPlugins,
'@typescript-eslint': tsEslint.plugin,
},
rules: {
...js.configs.recommended.rules,
...importFlatConfigsForModule.typescript.rules,
...nodePlugin.configs['flat/recommended-module'].rules,
...sharedRulesForNode,
...sharedRules,
'@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
'@typescript-eslint/consistent-type-assertions': [
'error',
{ assertionStyle: 'as' },
],
'@typescript-eslint/no-misused-new': 'error',
'@typescript-eslint/no-this-alias': [
'error',
{ allowDestructuring: true },
],
// Returning unawaited promises in a try/catch/finally is dangerous
// (the `catch` won't catch if the promise is rejected, and the `finally`
// won't wait for the promise to resolve). Returning unawaited promises
// elsewhere is probably fine, but this lint rule doesn't have a way
// to only apply to try/catch/finally (the 'in-try-catch' option *enforces*
// not awaiting promises *outside* of try/catch/finally, which is not what
// we want), and it's nice to await before returning anyways, since you get
// a slightly more comprehensive stack trace upon promise rejection.
'@typescript-eslint/return-await': ['error', 'always'],
// Disable the following rules because they don't play well with TypeScript.
'n/hashbang': 'off',
'n/no-extraneous-import': 'off',
'n/no-missing-import': 'off',
'no-redeclare': 'off',
'no-unused-vars': 'off',
},
},
{
files: ['**/*.{cjs,js}'],
...js.configs.recommended,
...importFlatConfigsForScript.recommended,
...nodePlugin.configs['flat/recommended-script'],
languageOptions: {
...js.configs.recommended.languageOptions,
...importFlatConfigsForModule.recommended.languageOptions,
...nodePlugin.configs['flat/recommended-script'].languageOptions,
globals: {
...js.configs.recommended.languageOptions?.globals,
...importFlatConfigsForModule.recommended.languageOptions?.globals,
...nodePlugin.configs['flat/recommended-script'].languageOptions
?.globals,
...nodeGlobalsConfig,
},
},
plugins: {
...js.configs.recommended.plugins,
...importFlatConfigsForScript.recommended.plugins,
...nodePlugin.configs['flat/recommended-script'].plugins,
...sharedPlugins,
},
rules: {
...js.configs.recommended.rules,
...importFlatConfigsForScript.recommended.rules,
...nodePlugin.configs['flat/recommended-script'].rules,
...sharedRulesForNode,
...sharedRules,
},
},
{
files: ['**/*.mjs'],
...js.configs.recommended,
...importFlatConfigsForModule.recommended,
...nodePlugin.configs['flat/recommended-module'],
languageOptions: {
...js.configs.recommended.languageOptions,
...importFlatConfigsForModule.recommended.languageOptions,
...nodePlugin.configs['flat/recommended-module'].languageOptions,
globals: {
...js.configs.recommended.languageOptions?.globals,
...importFlatConfigsForModule.recommended.languageOptions?.globals,
...nodePlugin.configs['flat/recommended-module'].languageOptions
?.globals,
...nodeGlobalsConfig,
},
},
plugins: {
...js.configs.recommended.plugins,
...importFlatConfigsForModule.recommended.plugins,
...nodePlugin.configs['flat/recommended-module'].plugins,
...sharedPlugins,
},
rules: {
...js.configs.recommended.rules,
...importFlatConfigsForModule.recommended.rules,
...nodePlugin.configs['flat/recommended-module'].rules,
...sharedRulesForNode,
...sharedRules,
},
},
]