offscale.github.io/eslint.config.js at master · offscale/offscale.github.io · 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
/**
 * @file eslint.config.js
 * @description Flat ESLint configuration enforcing 100% JSDoc documentation coverage
 * (files, modules, classes, functions, methods, parameters, and return types) and strict type safety.
 */

const js = require('@eslint/js');
const jsdoc = require('eslint-plugin-jsdoc');
const tseslint = require('typescript-eslint');
const globals = require('globals');

module.exports = [
    {
        ignores: [
            'node_modules/**',
            'dist/**',
            'coverage/**',
            'cdd-web-ui/**/*.js'
        ]
    },
    js.configs.recommended,
    ...tseslint.configs.recommended,
    jsdoc.configs['flat/recommended'],
    {
        files: [
            'script.js',
            'script.test.js',
            'jest.config.js',
            'eslint.config.js',
            'vite.config.js',
            'cdd-web-ui/docs-ui/src/**/*.d.ts'
        ],
        languageOptions: {
            ecmaVersion: 2022,
            sourceType: 'commonjs',
            globals: {
                ...globals.browser,
                ...globals.node,
                ...globals.jest
            }
        },
        settings: {
            jsdoc: {
                mode: 'typescript'
            }
        },
        rules: {
            '@typescript-eslint/no-require-imports': 'off',
            '@typescript-eslint/no-explicit-any': 'error',
            '@typescript-eslint/no-empty-object-type': [
                'error',
                {
                    allowInterfaces: 'with-single-extends'
                }
            ],
            'jsdoc/require-file-overview': [
                'error',
                {
                    tags: {
                        file: {
                            initialCommentsOnly: true,
                            mustExist: false,
                            preventDuplicates: true
                        },
                        module: {
                            initialCommentsOnly: true,
                            mustExist: false,
                            preventDuplicates: true
                        }
                    }
                }
            ],
            'jsdoc/require-jsdoc': [
                'error',
                {
                    publicOnly: false,
                    require: {
                        ArrowFunctionExpression: true,
                        ClassDeclaration: true,
                        ClassExpression: true,
                        FunctionDeclaration: true,
                        FunctionExpression: true,
                        MethodDefinition: true
                    },
                    contexts: [
                        'TSInterfaceDeclaration',
                        'TSTypeAliasDeclaration',
                        'TSMethodSignature',
                        'TSPropertySignature'
                    ]
                }
            ],
            'jsdoc/require-description': 'error',
            'jsdoc/require-param': 'error',
            'jsdoc/require-param-description': 'error',
            'jsdoc/require-param-name': 'error',
            'jsdoc/require-param-type': 'off',
            'jsdoc/require-returns': 'error',
            'jsdoc/require-returns-description': 'error',
            'jsdoc/require-returns-type': 'off',
            'jsdoc/valid-types': 'error',
            'jsdoc/tag-lines': 'off',
            'jsdoc/no-undefined-types': 'off'
        }
    },
    {
        files: [
            'script.js',
            'script.test.js',
            'jest.config.js',
            'eslint.config.js',
            'vite.config.js'
        ],
        rules: {
            'jsdoc/require-param-type': 'error',
            'jsdoc/require-returns-type': 'error'
        }
    }
];