docs-v2/eslint.config.js at master · sirosimo/docs-v2 · 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
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
import globals from 'globals';
import jsdocPlugin from 'eslint-plugin-jsdoc';
import pluginJs from '@eslint/js';
import tseslint from 'typescript-eslint';
import importPlugin from 'eslint-plugin-import';
import a11yPlugin from 'eslint-plugin-jsx-a11y';
import prettierConfig from 'eslint-config-prettier';

/** @type {import('eslint').Linter.Config[]} */
export default [
  // Base configurations
  {
    languageOptions: {
      globals: {
        ...globals.browser,
        // Hugo-specific globals
        hugo: 'readonly',
        params: 'readonly',
        // Common libraries used in docs
        Alpine: 'readonly',
        CodeMirror: 'readonly',
        d3: 'readonly',
      },
      ecmaVersion: 2022,
      sourceType: 'module',
    },
  },

  // JavaScript config (extract rules only)
  {
    rules: { ...pluginJs.configs.recommended.rules },
  },

  // TypeScript configurations with proper plugin format
  {
    plugins: {
      '@typescript-eslint': tseslint.plugin,
    },
    rules: { ...tseslint.configs.recommended.rules },
  },

  // Import plugin with proper plugin format
  {
    plugins: {
      import: importPlugin,
    },
    rules: { ...importPlugin.configs.recommended.rules },
  },

  // Accessibility rules with proper plugin format
  {
    plugins: {
      'jsx-a11y': a11yPlugin,
    },
    rules: { ...a11yPlugin.configs.recommended.rules },
  },

  // Add to your config array:
  {
    plugins: {
      jsdoc: jsdocPlugin,
    },
    rules: {
      'jsdoc/require-description': 'warn',
      'jsdoc/require-param-description': 'warn',
      'jsdoc/require-returns-description': 'warn',
      // Add more JSDoc rules as needed
    },
  },

  // Prettier compatibility (extract rules only)
  {
    rules: { ...prettierConfig.rules },
  },

  // Custom rules for documentation project
  {
    rules: {
      // Documentation projects often need to use console for examples
      'no-console': 'off',

      // Module imports
      'import/extensions': ['error', 'ignorePackages'],
      'import/no-unresolved': 'off', // Hugo handles module resolution differently

      // Code formatting
      'max-len': ['warn', { code: 80, ignoreUrls: true, ignoreStrings: true }],
      quotes: ['error', 'single', { avoidEscape: true }],

      // Hugo template string linting (custom rule)
      'no-template-curly-in-string': 'off', // Allow ${} in strings for Hugo templates

      // Accessibility
      'jsx-a11y/anchor-is-valid': 'warn',
    },
  },

  // Configuration for Node.js helper scripts
  {
    files: ['helper-scripts/**/*.js'],
    languageOptions: {
      globals: {
        ...globals.node,
      },
    },
    rules: {
      // Node.js specific rules
    },
  },

  // Configuration for specific file patterns
  {
    files: ['**/*.js'],
    rules: {
      // Rules specific to JavaScript files
    },
  },
  {
    files: ['assets/js/**/*.js'],
    rules: {
      // Rules specific to JavaScript in Hugo assets
      // Prevent imports from debug-helpers.js
      'no-restricted-imports': [
        'error',
        {
          paths: [
            {
              name: './utils/debug-helpers.js',
              message:
                'Remove debugging functions before committing. Debug helpers should not be used in production code.',
            },
            {
              name: '/utils/debug-helpers.js',
              message:
                'Remove debugging functions before committing. Debug helpers should not be used in production code.',
            },
          ],
        },
      ],
      // Prevent use of debug functions in production code
      'no-restricted-syntax': [
        'error',
        {
          selector: 'CallExpression[callee.name=/^debug(Log|Break|Inspect)$/]',
          message:
            'Remove debugging functions before committing. Debug helpers should not be used in production code.',
        },
      ],
    },
  },
  {
    files: ['**/*.ts'],
    rules: {
      // Rules specific to TypeScript files
    },
  },
  {
    // Ignore rules for build files and external dependencies
    ignores: [
      '**/node_modules/**',
      '**/public/**',
      '**/resources/**',
      '**/.hugo_build.lock',
    ],
  },
];