doc-kit/eslint.config.mjs at main · nodejs/doc-kit · GitHub

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
import pluginJs from '@eslint/js';
import { defineConfig } from 'eslint/config';
import importX from 'eslint-plugin-import-x';
import jsdoc from 'eslint-plugin-jsdoc';
import react from 'eslint-plugin-react-x';
import globals from 'globals';

export default defineConfig([
  pluginJs.configs.recommended,
  importX.flatConfigs.recommended,
  react.configs.recommended,
  {
    ignores: ['out/', 'src/generators/api-links/__tests__/fixtures/'],
  },
  {
    files: ['**/*.{mjs,jsx}'],
    plugins: { jsdoc },
    languageOptions: {
      ecmaVersion: 'latest',
      parserOptions: {
        ecmaFeatures: {
          jsx: true,
        },
      },
      globals: { ...globals.nodeBuiltin },
    },
    rules: {
      'object-shorthand': 'error',
      'import-x/namespace': 'off',
      'import-x/no-named-as-default': 'off',
      'import-x/no-named-as-default-member': 'off',
      'import-x/no-unresolved': 'off',
      'import-x/order': [
        'error',
        {
          groups: [
            'builtin',
            'external',
            'internal',
            ['sibling', 'parent'],
            'index',
            'unknown',
          ],
          'newlines-between': 'always',
          alphabetize: {
            order: 'asc',
            caseInsensitive: true,
          },
        },
      ],
      // We use [] as default props.
      'react-x/no-unstable-default-props': 'off',
      curly: ['error', 'all'],
    },
  },
  {
    files: ['src/**/*.mjs', 'bin/**/*.mjs'],
    plugins: {
      jsdoc,
    },
    languageOptions: {
      ecmaVersion: 'latest',
      globals: { ...globals.nodeBuiltin },
    },
    rules: {
      'jsdoc/check-alignment': 'error',
      'jsdoc/check-indentation': 'error',
      'jsdoc/require-jsdoc': [
        'error',
        {
          require: {
            FunctionDeclaration: true,
            MethodDefinition: true,
            ClassDeclaration: true,
            ArrowFunctionExpression: true,
            FunctionExpression: true,
          },
        },
      ],
    },
  },
  // Override rules for test files to disable JSDoc rules
  {
    files: ['**/__tests__/**'],
    rules: {
      'jsdoc/check-alignment': 'off',
      'jsdoc/check-indentation': 'off',
      'jsdoc/require-jsdoc': 'off',
      'jsdoc/require-param': 'off',
    },
  },
  {
    files: [
      'src/generators/legacy-html/assets/*.js',
      'src/generators/web/ui/**/*',
    ],
    languageOptions: {
      globals: {
        ...globals.browser,
        // SERVER and CLIENT denote server-only and client-only
        // codepaths in our web generator
        CLIENT: 'readonly',
        SERVER: 'readonly',
      },
      ecmaVersion: 'latest',
    },
  },
]);