@codfish/eslint-config 0.0.0-PR-155--2a9a213 → 0.0.0-PR-128--814f77e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +18 -132
  2. package/dist/dapp.d.ts +1 -1
  3. package/dist/docker.d.ts +1 -1
  4. package/dist/index.d.ts +1 -1
  5. package/dist/rules/config-files.d.ts +1 -1
  6. package/dist/rules/jest.d.ts +3 -0
  7. package/dist/rules/jest.d.ts.map +1 -0
  8. package/dist/rules/react.d.ts +1 -1
  9. package/dist/rules/vitest.d.ts +3 -0
  10. package/dist/rules/vitest.d.ts.map +1 -0
  11. package/dist/utils.d.ts +0 -5
  12. package/dist/utils.d.ts.map +1 -1
  13. package/index.js +60 -127
  14. package/package.json +27 -34
  15. package/rules/jest.js +34 -0
  16. package/rules/react.js +17 -49
  17. package/rules/vitest.js +39 -0
  18. package/utils.js +5 -13
  19. package/dist/rules/tests.d.ts +0 -3
  20. package/dist/rules/tests.d.ts.map +0 -1
  21. package/dist/rules/typescript.d.ts +0 -38
  22. package/dist/rules/typescript.d.ts.map +0 -1
  23. package/dist/tests/integration/eslint-execution.spec.d.ts +0 -2
  24. package/dist/tests/integration/eslint-execution.spec.d.ts.map +0 -1
  25. package/dist/tests/integration/react-integration.spec.d.ts +0 -2
  26. package/dist/tests/integration/react-integration.spec.d.ts.map +0 -1
  27. package/dist/tests/integration/rule-application.spec.d.ts +0 -2
  28. package/dist/tests/integration/rule-application.spec.d.ts.map +0 -1
  29. package/dist/tests/scenarios/edge-cases.spec.d.ts +0 -2
  30. package/dist/tests/scenarios/edge-cases.spec.d.ts.map +0 -1
  31. package/dist/tests/unit/config-loading.spec.d.ts +0 -2
  32. package/dist/tests/unit/config-loading.spec.d.ts.map +0 -1
  33. package/dist/tests/unit/dynamic-detection.spec.d.ts +0 -2
  34. package/dist/tests/unit/dynamic-detection.spec.d.ts.map +0 -1
  35. package/dist/tests/unit/utils.spec.d.ts +0 -2
  36. package/dist/tests/unit/utils.spec.d.ts.map +0 -1
  37. package/rules/tests.js +0 -52
  38. package/rules/typescript.js +0 -56
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # @codfish/eslint-config
2
2
 
3
3
  > Modern ESLint configuration with TypeScript, React/Next.js, YAML, Testing Library, and testing framework support using
4
- > ESLint v10+ flat config format.
4
+ > ESLint v9+ flat config format.d
5
5
 
6
6
  [![version](https://img.shields.io/npm/v/@codfish/eslint-config.svg)](http://npm.im/@codfish/eslint-config)
7
7
  [![downloads](https://img.shields.io/npm/dm/@codfish/eslint-config.svg)](http://npm-stat.com/charts.html?package=@codfish/eslint-config&from=2015-08-01)
@@ -18,16 +18,10 @@
18
18
  - [Installation](#installation)
19
19
  - [Usage](#usage)
20
20
  - [Opinionated Highlights](#opinionated-highlights)
21
- - [IDE Setup](#ide-setup)
22
- - [VS Code / Cursor](#vs-code--cursor)
23
21
  - [Prettier Configuration](#prettier-configuration)
24
22
  - [Use in combination with prettier-plugin-tailwindcss](#use-in-combination-with-prettier-plugin-tailwindcss)
25
23
  - [Example scripts](#example-scripts)
26
24
  - [Commitlint Configuration](#commitlint-configuration)
27
- - [Upgrading to ESLint 10](#upgrading-to-eslint-10)
28
- - [Breaking Changes in ESLint 10](#breaking-changes-in-eslint-10)
29
- - [Migration Steps](#migration-steps)
30
- - [What Changed](#what-changed)
31
25
  - [Migration from Legacy Config](#migration-from-legacy-config)
32
26
 
33
27
  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -35,14 +29,14 @@
35
29
 
36
30
  ## Features
37
31
 
38
- - **Modern ESLint v10+ flat config**: Uses the new flat configuration format
32
+ - **Modern ESLint v9+ flat config**: Uses the new flat configuration format
39
33
  - **Dynamic feature detection**: Automatically configures based on your project's dependencies
40
34
  - **TypeScript support**: Full TypeScript linting with modern typescript-eslint parser and rules
41
35
  - **React ecosystem**: React, React Hooks, and JSX accessibility rules when React is detected
42
36
  - **Next.js support**: Automatically configures Next.js official plugin linting rules when detected
43
37
  - **Test framework agnostic**: Supports Jest and Vitest with automatic detection
44
38
  - **Testing Library integration**: Automatically includes Testing Library rules for test files
45
- - **Multi-format support**: Built-in linting and formatting for Markdown, HTML, JSON, YAML/YML files
39
+ - **YAML/YML support**: Built-in linting for YAML configuration files
46
40
  - **Prettier integration**: Built-in Prettier configuration with conflict resolution via eslint-config-prettier
47
41
  - **ESM architecture**: Built with ECMAScript modules and full TypeScript typing
48
42
  - **Docker support**: Optional configuration for dockerized applications
@@ -53,7 +47,7 @@
53
47
  Install the package and required peer dependencies:
54
48
 
55
49
  ```sh
56
- npm i -D eslint@10 @codfish/eslint-config
50
+ npm i -D eslint@9 @codfish/eslint-config
57
51
 
58
52
  # Optionally, you can uninstall plugins or presets you don't need to manage anymore,
59
53
  # @codfish/eslint-config includes them all.
@@ -64,7 +58,6 @@ npm uninstall typescript-eslint \
64
58
  eslint-plugin-prettier \
65
59
  eslint-plugin-react \
66
60
  eslint-plugin-react-hooks \
67
- @tanstack/eslint-plugin-query \
68
61
  eslint-plugin-simple-import-sort \
69
62
  eslint-plugin-testing-library \
70
63
  eslint-plugin-yml \
@@ -72,15 +65,14 @@ npm uninstall typescript-eslint \
72
65
  eslint-plugin-next \
73
66
  commitlint \
74
67
  @commitlint/cli \
75
- @commitlint/config-conventional \
76
- prettier # optional, see note
68
+ @commitlint/config-conventional
77
69
  ```
78
70
 
79
71
  > [!NOTE]
80
72
  >
81
- > ESLint now handles linting and formatting for JavaScript, TypeScript, Markdown, HTML, JSON, and YAML files
82
- > automatically. If you want to format additional file types (like CSS, SCSS, etc.), you can leave Prettier installed as
83
- > a dev dependency in your project.
73
+ > Optionally, you can uninstall prettier as well. If you don't have prettier installed already but you want to format
74
+ > other file types (like Markdown, JSON, CSS, etc.), you can install it as a dev dependency: `npm i -D prettier`. Then
75
+ > you can use Prettier to format your non-JS files directly. Eslint will still run Prettier as an ESLint rule.
84
76
 
85
77
  ## Usage
86
78
 
@@ -287,47 +279,10 @@ This configuration includes some opinionated settings that you might want to cus
287
279
  See the [configuration examples below](#usage) for instructions on overriding these settings to match your team's
288
280
  preferences.
289
281
 
290
- ## IDE Setup
291
-
292
- ### VS Code / Cursor
293
-
294
- For the best development experience with VS Code or Cursor (or any VS Code-based IDE), install the
295
- [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and configure it to
296
- auto-fix on save:
297
-
298
- Add these settings to your `.vscode/settings.json` or user settings:
299
-
300
- ```json
301
- {
302
- "editor.codeActionsOnSave": {
303
- "source.fixAll": "explicit"
304
- },
305
- "eslint.validate": [
306
- "javascript",
307
- "javascriptreact",
308
- "typescript",
309
- "typescriptreact",
310
- "markdown",
311
- "json",
312
- "jsonc",
313
- "html",
314
- "yml",
315
- "yaml"
316
- ]
317
- }
318
- ```
319
-
320
- This configuration enables:
321
-
322
- - Automatic linting and formatting on save for all supported file types
323
- - ESLint validation for Markdown, JSON, YAML, and HTML files
324
- - A unified development experience across your entire codebase
325
-
326
282
  ## Prettier Configuration
327
283
 
328
- **Prettier is included and runs automatically** through ESLint for JavaScript, TypeScript, JSX, TSX, Markdown, HTML,
329
- JSON, and YAML files using the [built-in configuration](./prettier.js). **You don't need to install or configure
330
- Prettier separately** for these file types.
284
+ **Prettier is included and runs automatically** through ESLint for JavaScript, TypeScript, JSX, and TSX files using the
285
+ [built-in configuration](./prettier.js). **You don't need to install or configure Prettier separately** for basic usage.
331
286
 
332
287
  You can then override the default config by creating your own Prettier config file, or extend the built-in config:
333
288
 
@@ -383,7 +338,7 @@ export default {
383
338
  ### Use in combination with prettier-plugin-tailwindcss
384
339
 
385
340
  ```sh
386
- npm i -D eslint@10 @codfish/eslint-config prettier-plugin-tailwindcss
341
+ npm i -D eslint@9 @codfish/eslint-config prettier-plugin-tailwindcss
387
342
  ```
388
343
 
389
344
  ```js
@@ -404,7 +359,7 @@ export default {
404
359
 
405
360
  Optionally, you can add these scripts to your `package.json` for common linting workflows:
406
361
 
407
- **Recommended scripts:**
362
+ **Basic scripts (no separate Prettier installation needed):**
408
363
 
409
364
  ```json
410
365
  {
@@ -413,32 +368,24 @@ Optionally, you can add these scripts to your `package.json` for common linting
413
368
  "fix": "eslint . --fix"
414
369
  },
415
370
  "lint-staged": {
416
- "*.{js,jsx,ts,tsx,md,json,yml,yaml,html}": ["eslint --fix"]
371
+ "*.{js,jsx,ts,tsx}": ["eslint --fix"]
417
372
  }
418
373
  }
419
374
  ```
420
375
 
421
- > [!NOTE]
422
- >
423
- > ESLint now handles linting and formatting for JavaScript, TypeScript, Markdown, HTML, JSON, and YAML files. You don't
424
- > need to run Prettier separately for these file types.
425
-
426
- **With Prettier for other file types (CSS, SCSS, etc.):**
427
-
428
- If you want to format additional file types not covered by ESLint (like CSS, SCSS), you can install Prettier and add
429
- these scripts:
376
+ **With Prettier installed separately (for formatting non-JS files):**
430
377
 
431
378
  ```json
432
379
  {
433
380
  "scripts": {
434
381
  "lint": "eslint .",
435
382
  "fix": "eslint . --fix",
436
- "format": "prettier --write \"**/*.{css,scss}\"",
383
+ "format": "prettier --config ./node_modules/@codfish/eslint-config/prettier.js --write \"**/*.{json,css,md}\"",
437
384
  "check": "npm run lint && npm run format -- --check --no-write"
438
385
  },
439
386
  "lint-staged": {
440
- "*.{js,jsx,ts,tsx,md,json,yml,yaml,html}": ["eslint --fix"],
441
- "*.{css,scss}": ["prettier --write"]
387
+ "*.{js,jsx,ts,tsx}": ["eslint --fix"],
388
+ "*.{json,css,md}": ["prettier --write --config ./node_modules/@codfish/eslint-config/prettier.js"]
442
389
  }
443
390
  }
444
391
  ```
@@ -505,72 +452,11 @@ jobs:
505
452
  --verbose
506
453
  ```
507
454
 
508
- ## Upgrading to ESLint 10
509
-
510
- This package now requires **ESLint 10.0.0 or higher** and **Node.js v20.19.0 or higher**.
511
-
512
- ### Breaking Changes in ESLint 10
513
-
514
- - **ESLint 10 Required**: Minimum ESLint version is now 10.0.0
515
- - **Node.js v20.19.0+**: Minimum Node.js version increased from v20.0.0 to v20.19.0
516
- - **Legacy eslintrc removed**: ESLint 10 completely removes the deprecated eslintrc config system (this package already
517
- uses flat config)
518
- - **Improved JSX tracking**: ESLint 10 properly tracks JSX references in scope analysis, which may surface previously
519
- hidden unused import warnings in React files
520
- - **New recommended rules**: Three new rules enabled in `eslint:recommended`:
521
- - `no-unassigned-vars` - Disallow variables that are assigned but never used
522
- - `no-useless-assignment` - Disallow assignments that don't change the value
523
- - `preserve-caught-error` - Enforce that caught errors are not reassigned
524
-
525
- ### Migration Steps
526
-
527
- 1. **Update Node.js** (if needed):
528
-
529
- ```sh
530
- node --version # Ensure you're on v20.19.0+ or v22.13.0+
531
- ```
532
-
533
- 2. **Update ESLint and this config**:
534
-
535
- ```sh
536
- npm install --save-dev eslint@10 @codfish/eslint-config@latest
537
- ```
538
-
539
- 3. **Install dependencies with legacy peer deps** (required until all plugins update):
540
-
541
- ```sh
542
- npm install --legacy-peer-deps
543
- ```
544
-
545
- This is necessary because some ESLint plugins haven't updated their `peerDependencies` to include ESLint 10 yet. The
546
- plugins still work correctly with ESLint 10.
547
-
548
- 4. **Run linting** and check for new violations:
549
-
550
- ```sh
551
- npm run lint
552
- ```
553
-
554
- 5. **Review React files** for newly reported unused imports. ESLint 10's improved JSX tracking may flag imports that
555
- were previously ignored but are actually used in JSX.
556
-
557
- ### What Changed
558
-
559
- Since this package already uses ESLint's flat config format (the biggest change in ESLint 9), the upgrade to ESLint 10
560
- is relatively smooth. The main changes are:
561
-
562
- - ✅ Flat config format (already implemented)
563
- - ✅ Plugin configurations updated to ESLint 10-compatible versions
564
- - ✅ All tests passing with ESLint 10
565
- - ⚠️ Some plugins show peer dependency warnings but work correctly (ecosystem is catching up)
566
-
567
- For more details, see the [ESLint 10 Migration Guide](https://eslint.org/docs/latest/use/migrate-to-10.0.0).
568
-
569
455
  ## Migration from Legacy Config
570
456
 
571
457
  If you're upgrading from an older version that used Airbnb presets:
572
458
 
573
- 1. **Update to ESLint v10+**: `npm install --save-dev eslint@10`
459
+ 1. **Update to ESLint v9+**: `npm install --save-dev eslint@9`
574
460
  2. **Switch to flat config**: Replace `.eslintrc.js` with `eslint.config.js`
575
461
  3. **Use import syntax**: Change from `require()` to `import` statements
576
462
  4. **Remove explicit React config**: React support is now automatically detected
package/dist/dapp.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- declare const _default: import("eslint/config").Config[];
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
2
  export default _default;
3
3
  //# sourceMappingURL=dapp.d.ts.map
package/dist/docker.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- declare const _default: import("eslint/config").Config[];
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
2
  export default _default;
3
3
  //# sourceMappingURL=docker.d.ts.map
package/dist/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- declare const _default: import("eslint/config").Config[];
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
2
  export default _default;
3
3
  //# sourceMappingURL=index.d.ts.map
@@ -1,3 +1,3 @@
1
- declare const _default: import("eslint/config").Config[];
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
2
  export default _default;
3
3
  //# sourceMappingURL=config-files.d.ts.map
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
+ export default _default;
3
+ //# sourceMappingURL=jest.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jest.d.ts","sourceRoot":"","sources":["../../rules/jest.js"],"names":[],"mappings":""}
@@ -1,3 +1,3 @@
1
- declare const _default: import("eslint/config").Config[];
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
2
  export default _default;
3
3
  //# sourceMappingURL=react.d.ts.map
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
2
+ export default _default;
3
+ //# sourceMappingURL=vitest.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"vitest.d.ts","sourceRoot":"","sources":["../../rules/vitest.js"],"names":[],"mappings":""}
package/dist/utils.d.ts CHANGED
@@ -1,8 +1,3 @@
1
- /**
2
- * Get the version of a dependency from the consumer's package.json.
3
- * Returns the major version as a string (e.g. '18', '19'), or null if not found.
4
- */
5
- export function getDepVersion(dep: any): string | null;
6
1
  export function hasLocalConfig(moduleName: any, searchOptions?: {}): boolean;
7
2
  export function hasDep(props: any): boolean;
8
3
  export function hasDevDep(props: any): boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../utils.js"],"names":[],"mappings":"AAyBA;;;GAGG;AACH,uDAKC;AAED,6EAKC;AA1BgC,4CAA+D;AAA/D,+CAA+D;AAA/D,gDAA+D;AAMzF,8CAA8E;AAE9E,yDAAmE"}
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../utils.js"],"names":[],"mappings":"AA4BA,6EAKC;AAfgC,4CAA+D;AAA/D,+CAA+D;AAA/D,gDAA+D;AAMzF,8CAA8E;AAE9E,yDAAmE"}
package/index.js CHANGED
@@ -1,40 +1,33 @@
1
1
  import js from '@eslint/js';
2
- import json from '@eslint/json';
3
- import markdown from '@eslint/markdown';
4
- import html from '@html-eslint/eslint-plugin';
5
- import htmlParser from '@html-eslint/parser';
6
2
  import { defineConfig } from 'eslint/config';
7
- import prettierConfig from 'eslint-plugin-prettier/recommended';
3
+ import prettier from 'eslint-plugin-prettier/recommended';
8
4
  import simpleImportSortPlugin from 'eslint-plugin-simple-import-sort';
9
5
  import ymlPlugin from 'eslint-plugin-yml';
10
6
  import globals from 'globals';
7
+ import tseslint from 'typescript-eslint';
11
8
 
12
9
  import prettierBuiltInConfig from './prettier.js';
13
10
  import configFilesConfig from './rules/config-files.js';
11
+ import jestConfig from './rules/jest.js';
14
12
  import reactConfig from './rules/react.js';
15
- import testConfig from './rules/tests.js';
16
- import tseslintConfig, { rules as tsRules } from './rules/typescript.js';
13
+ import vitestConfig from './rules/vitest.js';
17
14
  import { hasLocalConfig, ifAnyDep } from './utils.js';
15
+
18
16
  const useBuiltinPrettierConfig = !hasLocalConfig('prettier');
19
17
 
20
18
  /**
21
- * Modern ESLint configuration with dynamic feature detection.
22
- * Supports TypeScript, React, Vitest, Prettier, YAML, and more.
23
- *
24
- * React ESLint configuration. Includes React, React Hooks, and JSX accessibility rules.
25
- * - https://github.com/jsx-eslint/eslint-plugin-react
26
- * - https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks
27
- * - https://github.com/jsx-eslint/eslint-plugin-jsx-a11y
19
+ * Modern ESLint configuration with dynamic feature detection
20
+ * Supports TypeScript, React, Jest, Vitest, Prettier, YAML, and Next.js
28
21
  */
29
22
  export default defineConfig([
23
+ js.configs.recommended,
24
+
25
+ tseslint.configs.recommended,
26
+
30
27
  // Base opinionated rules
31
28
  {
32
29
  name: 'codfish/base',
33
30
 
34
- files: ['**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}'],
35
-
36
- extends: [js.configs.recommended, ...tseslintConfig],
37
-
38
31
  plugins: {
39
32
  'simple-import-sort': simpleImportSortPlugin,
40
33
  },
@@ -42,9 +35,6 @@ export default defineConfig([
42
35
  languageOptions: {
43
36
  ecmaVersion: 'latest',
44
37
  sourceType: 'module',
45
- parserOptions: {
46
- ecmaFeatures: { jsx: true },
47
- },
48
38
  globals: {
49
39
  ...globals.browser,
50
40
  ...globals.node,
@@ -56,10 +46,8 @@ export default defineConfig([
56
46
  // Error handling rules to enforce using the Error object
57
47
  'no-throw-literal': 'error',
58
48
  'prefer-promise-reject-errors': 'error',
59
- 'no-unused-vars': ['error', { ignoreRestSiblings: true }],
60
- 'no-empty-function': 'off',
61
49
 
62
- // Asynchronous functions that don't use await might not need to be asynchronous functions
50
+ // Asynchronous functions that dont use await might not need to be asynchronous functions
63
51
  // Usually result of refactoring, leads to misunderstanding/misusage
64
52
  'require-await': 'error',
65
53
 
@@ -87,58 +75,62 @@ export default defineConfig([
87
75
  },
88
76
  ],
89
77
  'simple-import-sort/exports': 'error',
90
- 'sort-imports': 'off',
91
78
 
92
- // 1. Encouraging `lodash-es` imports per file
79
+ // 2. Encouraging `lodash-es` imports per file
93
80
  // lodash imports should use `lodash-es` package and should be imported per file.
94
- // E.G: `import get from "lodash-es/get"`
81
+ // E.G: `import get from 'lodash-es/get'`
95
82
  // More details in https://stackoverflow.com/questions/35250500/correct-way-to-import-lodash#answer-35251059
96
- // 2. Prevent relative imports - use path aliases instead
97
- // Use `@/` for src imports and `@tests/` for test imports
98
- // 3. Prevent vitest globals imports - these are available globally
99
83
  'no-restricted-imports': [
100
84
  'error',
101
85
  {
102
86
  paths: [
103
87
  {
104
88
  name: 'lodash',
105
- message: 'Please use lodash-es direct import E.G: `import get from "lodash-es/get"`',
89
+ message: "Please use lodash-es direct import E.G: `import get from 'lodash-es/get'`",
106
90
  },
107
91
  {
108
92
  name: 'lodash-es',
109
- message: 'Please use lodash-es direct import E.G: `import get from "lodash-es/get"`',
110
- },
111
- {
112
- name: 'jest',
113
- importNames: ['describe', 'expect', 'test', 'it', 'jest'],
114
- message:
115
- 'These jest globals (describe, expect, test, it, jest) are available globally and should not be imported. Remove this import statement.',
116
- },
117
- {
118
- name: 'vitest',
119
- importNames: ['describe', 'expect', 'test', 'it', 'vi'],
120
- message:
121
- 'These vitest globals (describe, expect, test, it, vi) are available globally and should not be imported. Remove this import statement.',
93
+ message: "Please use lodash-es direct import E.G: `import get from 'lodash-es/get'`",
122
94
  },
123
95
  ],
124
96
  patterns: [
125
97
  {
126
98
  group: ['lodash/*'],
127
- message: 'Please use lodash-es direct import E.G: `import get from "lodash-es/get"`',
128
- },
129
- {
130
- // Prevent relative imports going back 1+ directories. Use @/ or @tests/ aliases instead.
131
- // Ensures consistent and cleaner import paths, and avoids confusing import hell with deeply nested files.
132
- group: ['../*', '../../*', '../../../*', '../../../../*'],
133
- message:
134
- 'Relative imports going back 1+ directories are not allowed. Use path aliases: @/ for src/*, @tests/ for tests/* imports. For example, instead of `import x from "../components/*"`, use `import x from "@/components/*"`',
99
+ message: "Please use lodash-es direct import E.G: `import get from 'lodash-es/get'`",
135
100
  },
136
101
  ],
137
102
  },
138
103
  ],
104
+ },
105
+ },
139
106
 
140
- // TypeScript rules (empty object when typescript is not installed)
141
- ...tsRules,
107
+ {
108
+ name: 'codfish/ts-overrides',
109
+
110
+ files: ['**/*.ts', '**/*.tsx'],
111
+
112
+ rules: {
113
+ '@typescript-eslint/no-empty-function': 'off',
114
+ '@typescript-eslint/naming-convention': [
115
+ 'error',
116
+ {
117
+ selector: ['interface', 'typeAlias'],
118
+ format: ['PascalCase'],
119
+ custom: {
120
+ regex: '^I[A-Z]', // prevent prefixing interfaces and type alias declarations with "I"
121
+ match: false,
122
+ },
123
+ },
124
+ ],
125
+ '@typescript-eslint/ban-ts-comment': [
126
+ 'error',
127
+ {
128
+ // If you need to use a ts comment, make sure you have a description.
129
+ 'ts-ignore': 'allow-with-description',
130
+ 'ts-expect-error': 'allow-with-description',
131
+ 'ts-nocheck': 'allow-with-description',
132
+ },
133
+ ],
142
134
  },
143
135
  },
144
136
 
@@ -183,34 +175,18 @@ export default defineConfig([
183
175
  '.expo',
184
176
  '**/tmp/',
185
177
  '**/temp/',
186
- '**/.tmp',
187
- '.nx',
188
- '**/.eslintcache',
178
+ '.tmp',
179
+ '.eslintcache',
189
180
  '*.tsbuildinfo',
190
181
  'node_modules',
191
- '**/node_modules/',
192
- '**/pnpm-lock.yaml',
193
- '**/pnpm-lock.*.yaml',
194
- '.history',
195
- '**/.yarn',
196
- '**/yarn.lock',
197
- '**/package-lock.json',
198
- '**/.yarnrc.yml',
199
- 'pacts',
200
- '.claude',
201
- '.__mf__temp',
182
+ 'pnpm-lock.yaml',
183
+ 'pnpm-lock.*.yaml',
202
184
  ],
203
185
  },
204
186
 
205
187
  // Configuration files (eslint, prettier, etc.)
206
188
  configFilesConfig,
207
189
 
208
- // React configuration (dynamic)
209
- ifAnyDep('react', reactConfig, []),
210
-
211
- // Jest OR Vitest configuration (dynamic)
212
- ifAnyDep(['jest', 'vitest'], testConfig, []),
213
-
214
190
  // YML files
215
191
  ymlPlugin.configs['flat/standard'],
216
192
  ymlPlugin.configs['flat/prettier'], // handles conflicting rules with the yml plugin
@@ -225,67 +201,24 @@ export default defineConfig([
225
201
  },
226
202
  },
227
203
 
228
- // JSON files
229
- {
230
- name: 'codfish/json',
231
- files: ['**/*.json'],
232
- ignores: ['**/tsconfig*.json', '**/package-lock.json'],
233
- plugins: { json },
234
- language: 'json/json',
235
- extends: ['json/recommended'],
236
- },
237
-
238
- // JSONC files (JSON with Comments) - for files that allow comments
239
- {
240
- name: 'codfish/jsonc',
241
- files: ['**/*.jsonc'],
242
- plugins: { json },
243
- language: 'json/jsonc',
244
- extends: ['json/recommended'],
245
- },
246
-
247
- // JSON5 files - for TypeScript configs (supports comments AND trailing commas)
248
- {
249
- name: 'codfish/json5',
250
- files: ['**/tsconfig*.json', '**/*.json5'],
251
- plugins: { json },
252
- language: 'json/json5',
253
- extends: ['json/recommended'],
254
- },
204
+ // React configuration (dynamic)
205
+ ifAnyDep('react', reactConfig, []),
255
206
 
256
- // Markdown files
257
- {
258
- name: 'codfish/markdown',
259
- files: ['**/*.md'],
260
- plugins: { markdown },
261
- extends: ['markdown/recommended'],
262
- rules: {
263
- // Allow GitHub-style alerts and checkbox syntax (task lists)
264
- 'markdown/no-missing-label-refs': [
265
- 'error',
266
- { allowLabels: ['!NOTE', '!WARNING', '!IMPORTANT', '!TIP', '!CAUTION', '', 'x', 'X'] },
267
- ],
268
- },
269
- },
207
+ // Jest OR Vitest configuration (dynamic)
208
+ ifAnyDep('jest', jestConfig, []),
270
209
 
271
- // HTML files
272
- {
273
- name: 'codfish/html',
274
- files: ['**/*.html'],
275
- plugins: { html },
276
- languageOptions: { parser: htmlParser },
277
- },
210
+ // Vitest configuration (dynamic)
211
+ ifAnyDep('vitest', vitestConfig, []),
278
212
 
279
213
  // Prettier plugin is responsible for running prettier as an ESLint
280
214
  // rule and turning off ESLint rules that might conflict.
281
215
  // IMPORTANT: KEEP THIS LAST TO OVERRIDE ESLINT!
282
- {
283
- files: ['**/*.{js,ts,jsx,tsx,md,yml,yaml,html,json,jsonc,json5}'],
284
-
285
- extends: [prettierConfig],
216
+ prettier,
286
217
 
218
+ {
287
219
  rules: {
288
- // Reset prettier rule passing in custom prettier config.
220
+ // Reset prettier rule passing in codfish's prettier config.
221
+ // IMPORTANT: KEEP THIS LAST TO OVERRIDE PRETTIER PLUGIN!
289
222
  'prettier/prettier': useBuiltinPrettierConfig ? ['error', prettierBuiltInConfig] : 'error',
290
223
  },
291
224
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codfish/eslint-config",
3
- "version": "0.0.0-PR-155--2a9a213",
3
+ "version": "0.0.0-PR-128--814f77e",
4
4
  "description": "Modern ESLint configuration with TypeScript, React, and testing framework support.",
5
5
  "type": "module",
6
6
  "repository": {
@@ -45,54 +45,47 @@
45
45
  "scripts": {
46
46
  "build": "tsc --emitDeclarationOnly",
47
47
  "dev": "tsc --watch",
48
- "typecheck": "tsc --noEmit",
49
- "lint": "eslint",
50
- "format": "eslint --fix",
48
+ "type-check": "tsc --noEmit",
49
+ "lint": "eslint .",
50
+ "fix": "prettier --write \"**/*.{json,css,scss,md}\" --config ./prettier.js && npm run lint -- --fix",
51
51
  "test": "vitest",
52
+ "test:watch": "vitest --watch",
52
53
  "test:coverage": "vitest --coverage",
53
54
  "prepublishOnly": "npm run build",
54
55
  "prepare": "husky"
55
56
  },
56
57
  "dependencies": {
57
- "@commitlint/cli": "^20.4.2",
58
- "@commitlint/config-conventional": "^20.4.2",
59
- "@eslint/js": "^10.0.0",
60
- "@eslint/json": "^1.0.1",
61
- "@eslint/markdown": "^8.0.0",
62
- "@html-eslint/eslint-plugin": "^0.58.0",
63
- "@html-eslint/parser": "^0.58.0",
64
- "@next/eslint-plugin-next": "^16.1.6",
65
- "@tanstack/eslint-plugin-query": "^5.91.4",
66
- "@vitest/eslint-plugin": "^1.6.9",
58
+ "@commitlint/cli": "^19.8.1",
59
+ "@commitlint/config-conventional": "^19.8.1",
60
+ "@eslint/js": "^9.35.0",
61
+ "@vitest/eslint-plugin": "^1.3.10",
67
62
  "cosmiconfig": "^9.0.0",
68
63
  "eslint-config-prettier": "^10.1.8",
69
- "eslint-plugin-jest": "^29.15.0",
64
+ "eslint-plugin-jest": "^29.0.1",
70
65
  "eslint-plugin-jsx-a11y": "^6.10.2",
71
- "eslint-plugin-prettier": "^5.5.5",
66
+ "eslint-plugin-prettier": "^5.5.4",
72
67
  "eslint-plugin-react": "^7.37.5",
73
- "eslint-plugin-react-hooks": "^7.0.1",
74
- "eslint-plugin-react-refresh": "^0.5.2",
68
+ "eslint-plugin-react-hooks": "^5.2.0",
75
69
  "eslint-plugin-simple-import-sort": "^12.1.1",
76
- "eslint-plugin-testing-library": "^7.16.0",
77
- "eslint-plugin-yml": "^3.3.0",
78
- "globals": "^17.3.0",
70
+ "eslint-plugin-testing-library": "^7.1.0",
71
+ "eslint-plugin-yml": "^1.16.0",
72
+ "@next/eslint-plugin-next": "^15.1.6",
73
+ "globals": "^16.4.0",
79
74
  "lodash.has": "^4.5.2",
80
- "prettier": ">= 3",
81
- "read-package-up": "^12.0.0",
82
- "typescript-eslint": "^8.56.1"
75
+ "prettier": "^3.6.2",
76
+ "read-package-up": "^11.0.0",
77
+ "typescript-eslint": "^8.44.0"
83
78
  },
84
79
  "devDependencies": {
85
- "@types/node": "^25.3.3",
86
- "@vitest/coverage-v8": "^4.0.18",
87
- "doctoc": "^2.3.0",
88
- "eslint": "^10.0.2",
80
+ "doctoc": "^2.2.1",
81
+ "eslint": "^9.35.0",
89
82
  "husky": "^9.1.7",
90
- "lint-staged": "^17.0.0",
91
- "typescript": "^6.0.0",
92
- "vitest": "^4.0.18"
83
+ "lint-staged": "^16.1.6",
84
+ "typescript": "^5.9.2",
85
+ "vitest": "^1.0.0"
93
86
  },
94
87
  "engines": {
95
- "node": ">=20.19.0"
88
+ "node": ">=20.0.0"
96
89
  },
97
90
  "files": [
98
91
  "dist",
@@ -105,7 +98,7 @@
105
98
  "commitlint.js"
106
99
  ],
107
100
  "peerDependencies": {
108
- "eslint": ">= 10",
101
+ "eslint": ">= 9",
109
102
  "prettier": ">= 3"
110
103
  },
111
104
  "peerDependenciesMeta": {
@@ -128,6 +121,6 @@
128
121
  ]
129
122
  },
130
123
  "volta": {
131
- "node": "24.14.1"
124
+ "node": "24.8.0"
132
125
  }
133
126
  }
package/rules/jest.js ADDED
@@ -0,0 +1,34 @@
1
+ import { defineConfig } from 'eslint/config';
2
+ import jest from 'eslint-plugin-jest';
3
+ import testingLibrary from 'eslint-plugin-testing-library';
4
+
5
+ import { ifAnyDep } from '../utils.js';
6
+
7
+ /**
8
+ * Jest ESLint configuration for flat config format
9
+ * Includes Jest-specific rules, globals, and Testing Library rules for test files
10
+ */
11
+ export default defineConfig([
12
+ {
13
+ name: 'codfish/jest',
14
+
15
+ files: [
16
+ '**/__tests__/**/*.{js,ts,jsx,tsx}',
17
+ '**/*.{test,spec}.{js,ts,jsx,tsx}',
18
+ '**/jest.config.{js,ts}',
19
+ '**/jest.setup.{js,ts}',
20
+ '**/setupTests.{js,ts}',
21
+ '**/testUtils.{js,ts}',
22
+ 'tests/**/*.{js,ts,jsx,tsx}',
23
+ ],
24
+
25
+ ...jest.configs['flat/recommended'],
26
+
27
+ ...ifAnyDep('react-testing-library', testingLibrary.configs['flat/react'], {}),
28
+ ...ifAnyDep('vue-testing-library', testingLibrary.configs['flat/vue'], {}),
29
+
30
+ rules: {
31
+ 'no-console': 'off',
32
+ },
33
+ },
34
+ ]);
package/rules/react.js CHANGED
@@ -1,13 +1,11 @@
1
1
  import nextPlugin from '@next/eslint-plugin-next';
2
- import tanstackQuery from '@tanstack/eslint-plugin-query';
3
2
  import { defineConfig } from 'eslint/config';
4
3
  import jsxA11y from 'eslint-plugin-jsx-a11y';
5
4
  import react from 'eslint-plugin-react';
6
5
  import reactHooks from 'eslint-plugin-react-hooks';
7
- import reactRefresh from 'eslint-plugin-react-refresh';
8
6
  import globals from 'globals';
9
7
 
10
- import { getDepVersion, ifAnyDep } from '../utils.js';
8
+ import { ifAnyDep } from '../utils.js';
11
9
 
12
10
  /**
13
11
  * React ESLint configuration. Includes React, React Hooks, and JSX accessibility rules.
@@ -20,17 +18,10 @@ export default defineConfig([
20
18
  {
21
19
  name: 'codfish/react',
22
20
 
23
- files: ['**/*.jsx', '**/*.tsx', '**/*.mjsx', '**/*.mtsx'],
21
+ files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
24
22
 
25
- extends: [
26
- react.configs.flat.recommended,
27
- reactHooks.configs.flat['recommended-latest'],
28
- reactRefresh.configs.recommended,
29
- jsxA11y.flatConfigs.recommended,
30
- ifAnyDep('@tanstack/react-query', tanstackQuery.configs['flat/recommended']),
31
- ifAnyDep('next', nextPlugin.configs.recommended),
32
- ifAnyDep('next', nextPlugin.configs['core-web-vitals']),
33
- ].filter(Boolean),
23
+ ...react.configs.flat.recommended,
24
+ ...jsxA11y.flatConfigs.recommended,
34
25
 
35
26
  languageOptions: {
36
27
  globals: {
@@ -38,49 +29,26 @@ export default defineConfig([
38
29
  ...globals.browser,
39
30
  },
40
31
  },
32
+ },
41
33
 
42
- settings: {
43
- react: {
44
- // Avoid 'detect' — it uses context.getFilename() which was removed in ESLint 10.
45
- // Read the major version from the consumer's package.json instead.
46
- version: getDepVersion('react') || 'detect',
47
- },
48
- },
49
-
50
- rules: {
51
- // React 17+ uses automatic JSX runtime, no need to import React
52
- 'react/react-in-jsx-scope': 'off',
53
- 'react/jsx-uses-react': 'off',
54
-
55
- // TypeScript provides type checking, no need for PropTypes
56
- 'react/prop-types': 'off',
57
-
58
- // this rule is too noisey and doesn't account for certain valid use cases
59
- 'react-hooks/exhaustive-deps': 'off',
60
-
61
- // sometimes autoFocus is needed for better UX. @todo - revisit later?
62
- 'jsx-a11y/no-autofocus': 'off',
63
-
64
- 'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
34
+ // React Hooks configuration
35
+ reactHooks.configs['recommended-latest'],
65
36
 
66
- ...ifAnyDep('@tanstack/react-query', { '@tanstack/query/exhaustive-deps': 'error' }, {}),
37
+ // Next.js configuration (dynamic)
38
+ ifAnyDep(
39
+ 'next',
40
+ {
41
+ ...(nextPlugin?.flatConfig?.recommended || {}),
42
+ ...(nextPlugin?.flatConfig?.coreWebVitals || {}),
67
43
 
68
- ...ifAnyDep(
69
- 'next',
70
- {
71
- // annoying cause this is common in Next.js, i.e. generateMetadata()
72
- 'react-refresh/only-export-components': ['off'],
73
- },
74
- {},
75
- ),
44
+ name: 'codfish/next',
76
45
  },
77
- },
46
+ {},
47
+ ),
78
48
 
79
49
  {
80
- name: 'codfish/react-next-config',
81
- files: ['next.config.js', 'next.config.ts'],
82
50
  rules: {
83
- 'require-await': 'off',
51
+ 'react-hooks/exhaustive-deps': 'off',
84
52
  },
85
53
  },
86
54
  ]);
@@ -0,0 +1,39 @@
1
+ import vitest from '@vitest/eslint-plugin';
2
+ import { defineConfig } from 'eslint/config';
3
+ import testingLibrary from 'eslint-plugin-testing-library';
4
+ import globals from 'globals';
5
+
6
+ import { ifAnyDep } from '../utils.js';
7
+
8
+ /**
9
+ * Vitest ESLint configuration for flat config format
10
+ * Includes Vitest-specific rules, globals, and Testing Library rules for test files
11
+ */
12
+ export default defineConfig([
13
+ {
14
+ files: [
15
+ '**/*.{spec,test}.{js,ts,jsx,tsx}',
16
+ '**/tests/**/*.{js,ts,jsx,tsx}',
17
+ '**/__mocks__/**/*.{js,ts,jsx,tsx}',
18
+ '**/__tests__/**/*.{js,ts,jsx,tsx}',
19
+ ],
20
+
21
+ ...vitest.configs.recommended,
22
+
23
+ ...ifAnyDep('react-testing-library', testingLibrary.configs['flat/react'], {}),
24
+ ...ifAnyDep('vue-testing-library', testingLibrary.configs['flat/vue'], {}),
25
+
26
+ name: 'codfish/vitest',
27
+
28
+ languageOptions: {
29
+ globals: {
30
+ ...vitest.environments.env.globals,
31
+ ...globals.node,
32
+ },
33
+ },
34
+
35
+ rules: {
36
+ 'no-console': 'off',
37
+ },
38
+ },
39
+ ]);
package/utils.js CHANGED
@@ -8,9 +8,12 @@
8
8
  import fs from 'node:fs';
9
9
  import { cosmiconfigSync } from 'cosmiconfig';
10
10
  import has from 'lodash.has';
11
- import { readPackageUpSync } from 'read-package-up';
11
+ import { readPackageUp } from 'read-package-up';
12
12
 
13
- const { packageJson: pkg, path: pkgPath } = readPackageUpSync({ cwd: fs.realpathSync(process.cwd()) }) || {};
13
+ const { packageJson: pkg, path: pkgPath } =
14
+ (await readPackageUp({
15
+ cwd: fs.realpathSync(process.cwd()),
16
+ })) || {};
14
17
 
15
18
  const hasPkgProp = props => [props].flat().some(prop => has(pkg, prop));
16
19
  const hasPkgSubProp = pkgProp => props => hasPkgProp([props].flat().map(p => `${pkgProp}.${p}`));
@@ -23,17 +26,6 @@ export const hasAnyDep = args => [hasDep, hasDevDep, hasPeerDep].some(fn => fn(a
23
26
 
24
27
  export const ifAnyDep = (deps, t, f) => (hasAnyDep([deps].flat()) ? t : f);
25
28
 
26
- /**
27
- * Get the version of a dependency from the consumer's package.json.
28
- * Returns the major version as a string (e.g. '18', '19'), or null if not found.
29
- */
30
- export function getDepVersion(dep) {
31
- const spec = pkg?.dependencies?.[dep] || pkg?.devDependencies?.[dep] || pkg?.peerDependencies?.[dep];
32
- if (!spec) return null;
33
- const match = spec.match(/\d+/);
34
- return match ? match[0] : null;
35
- }
36
-
37
29
  export function hasLocalConfig(moduleName, searchOptions = {}) {
38
30
  const explorerSync = cosmiconfigSync(moduleName, searchOptions);
39
31
  const result = explorerSync.search(pkgPath || './');
@@ -1,3 +0,0 @@
1
- declare const _default: import("eslint/config").Config[];
2
- export default _default;
3
- //# sourceMappingURL=tests.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tests.d.ts","sourceRoot":"","sources":["../../rules/tests.js"],"names":[],"mappings":""}
@@ -1,38 +0,0 @@
1
- export default tseslintConfig;
2
- export const rules: {
3
- '@typescript-eslint/no-unused-vars': (string | {
4
- ignoreRestSiblings: boolean;
5
- })[];
6
- '@typescript-eslint/no-empty-function': string;
7
- '@typescript-eslint/naming-convention': (string | {
8
- selector: string[];
9
- format: string[];
10
- custom: {
11
- regex: string;
12
- match: boolean;
13
- };
14
- })[];
15
- '@typescript-eslint/ban-ts-comment': (string | {
16
- 'ts-ignore': string;
17
- 'ts-expect-error': string;
18
- 'ts-nocheck': string;
19
- })[];
20
- '@typescript-eslint/no-restricted-types': (string | {
21
- types: {
22
- 'React.FC': {
23
- message: string;
24
- };
25
- 'React.FunctionComponent': {
26
- message: string;
27
- };
28
- };
29
- })[];
30
- } | {
31
- '@typescript-eslint/no-unused-vars'?: never;
32
- '@typescript-eslint/no-empty-function'?: never;
33
- '@typescript-eslint/naming-convention'?: never;
34
- '@typescript-eslint/ban-ts-comment'?: never;
35
- '@typescript-eslint/no-restricted-types'?: never;
36
- };
37
- declare const tseslintConfig: import("eslint").Linter.Config[];
38
- //# sourceMappingURL=typescript.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../rules/typescript.js"],"names":[],"mappings":";AAeA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwCO;AA9CP,8BACa,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACsC"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=eslint-execution.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"eslint-execution.spec.d.ts","sourceRoot":"","sources":["../../../tests/integration/eslint-execution.spec.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=react-integration.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"react-integration.spec.d.ts","sourceRoot":"","sources":["../../../tests/integration/react-integration.spec.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=rule-application.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"rule-application.spec.d.ts","sourceRoot":"","sources":["../../../tests/integration/rule-application.spec.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=edge-cases.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"edge-cases.spec.d.ts","sourceRoot":"","sources":["../../../tests/scenarios/edge-cases.spec.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=config-loading.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"config-loading.spec.d.ts","sourceRoot":"","sources":["../../../tests/unit/config-loading.spec.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=dynamic-detection.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"dynamic-detection.spec.d.ts","sourceRoot":"","sources":["../../../tests/unit/dynamic-detection.spec.js"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=utils.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.spec.d.ts","sourceRoot":"","sources":["../../../tests/unit/utils.spec.js"],"names":[],"mappings":""}
package/rules/tests.js DELETED
@@ -1,52 +0,0 @@
1
- import vitest from '@vitest/eslint-plugin';
2
- import { defineConfig } from 'eslint/config';
3
- import jest from 'eslint-plugin-jest';
4
- import testingLibrary from 'eslint-plugin-testing-library';
5
- import globals from 'globals';
6
-
7
- import { ifAnyDep } from '../utils.js';
8
-
9
- /**
10
- * Jest ESLint configuration for flat config format
11
- * Includes Jest-specific rules, globals, and Testing Library rules for test files
12
- */
13
- export default defineConfig({
14
- name: 'codfish/tests',
15
-
16
- files: [
17
- '**/*.{spec,test}.{js,ts,jsx,tsx}',
18
- '**/tests/**/*.{js,ts,jsx,tsx}',
19
- '**/__mocks__/**/*.{js,ts,jsx,tsx}',
20
- '**/__tests__/**/*.{js,ts,jsx,tsx}',
21
- '**/jest.config.{js,ts}',
22
- '**/jest.setup.{js,ts}',
23
- '**/vitest.config.{js,ts}',
24
- '**/vitest.setup.{js,ts}',
25
- '**/setupTests.{js,ts}',
26
- '**/testUtils.{js,ts}',
27
- 'tests/**/*.{js,ts,jsx,tsx}',
28
- ],
29
-
30
- extends: [
31
- ifAnyDep('jest', jest.configs['flat/recommended'], false),
32
- ifAnyDep('vitest', vitest.configs.recommended, false),
33
- ifAnyDep('@testing-library/dom', testingLibrary.configs['flat/dom'], false),
34
- ifAnyDep('@testing-library/react', testingLibrary.configs['flat/react'], false),
35
- ifAnyDep('@testing-library/vue', testingLibrary.configs['flat/vue'], false),
36
- ifAnyDep('@testing-library/svelte', testingLibrary.configs['flat/svelte'], false),
37
- ifAnyDep('@testing-library/angular', testingLibrary.configs['flat/angular'], false),
38
- ifAnyDep('@testing-library/marko', testingLibrary.configs['flat/marko'], false),
39
- ].filter(Boolean),
40
-
41
- languageOptions: {
42
- globals: {
43
- ...globals.node,
44
- ...ifAnyDep('jest', globals.jest, {}),
45
- ...ifAnyDep('vitest', globals.vitest, {}),
46
- },
47
- },
48
-
49
- rules: {
50
- 'no-console': 'off',
51
- },
52
- });
@@ -1,56 +0,0 @@
1
- import { hasAnyDep } from '../utils.js';
2
-
3
- /**
4
- * TypeScript ESLint configuration. Dynamically loads typescript-eslint
5
- * only when typescript is installed in the consuming project.
6
- *
7
- * - https://typescript-eslint.io/
8
- */
9
- const hasTypeScript = hasAnyDep('typescript');
10
- const tseslintConfig =
11
- /** @type {import('eslint').Linter.Config[]} */
12
- (hasTypeScript ? [(await import('typescript-eslint')).configs.recommended] : []);
13
-
14
- export default tseslintConfig;
15
-
16
- export const rules = hasTypeScript
17
- ? {
18
- // Allows destructuring of rest properties even if they are unused
19
- '@typescript-eslint/no-unused-vars': ['error', { ignoreRestSiblings: true }],
20
- '@typescript-eslint/no-empty-function': 'off',
21
- '@typescript-eslint/naming-convention': [
22
- 'error',
23
- {
24
- selector: ['interface', 'typeAlias'],
25
- format: ['PascalCase'],
26
- custom: {
27
- regex: '^I[A-Z]', // prevent prefixing interfaces and type alias declarations with "I"
28
- match: false,
29
- },
30
- },
31
- ],
32
- '@typescript-eslint/ban-ts-comment': [
33
- 'error',
34
- {
35
- // If you need to use a ts comment, make sure you have a description.
36
- 'ts-ignore': 'allow-with-description',
37
- 'ts-expect-error': 'allow-with-description',
38
- 'ts-nocheck': 'allow-with-description',
39
- },
40
- ],
41
-
42
- '@typescript-eslint/no-restricted-types': [
43
- 'error',
44
- {
45
- types: {
46
- 'React.FC': {
47
- message: 'Useless and has some drawbacks, see https://github.com/facebook/create-react-app/pull/8177',
48
- },
49
- 'React.FunctionComponent': {
50
- message: 'Useless and has some drawbacks, see https://github.com/facebook/create-react-app/pull/8177',
51
- },
52
- },
53
- },
54
- ],
55
- }
56
- : {};