glsp-client/eslint.config.mjs at master · eclipse-glsp/glsp-client · 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
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
import glspConfig from '@eclipse-glsp/eslint-config';

// Relative index and src imports restricted by the shared @eclipse-glsp/eslint-config.
// Must be included in every `no-restricted-imports` override since flat config replaces the entire rule value.
const restrictedBaseImports = ['..', '../index', '../..', '../../index', 'src'];

export default [
    ...glspConfig,
    // Ignore JS/MJS/CJS config/build files and scripts directory
    { ignores: ['**/*.js', '**/*.mjs', '**/*.cjs', '**/scripts/'] },
    // TypeScript parser options
    {
        files: ['**/*.{ts,tsx}'],
        languageOptions: {
            parserOptions: {
                project: './tsconfig.eslint.json',
                tsconfigRootDir: import.meta.dirname
            }
        }
    },
    // Disable @typescript-eslint/no-unused-expressions (chai-friendly rule handles this)
    {
        files: ['**/*.{ts,tsx}'],
        rules: {
            '@typescript-eslint/no-unused-expressions': 'off'
        }
    },
    // Disable import-x/namespace for test files (sinon namespace not resolved correctly)
    {
        files: ['**/*.spec.{ts,tsx}'],
        rules: {
            'import-x/namespace': 'off'
        }
    },
    // Default rules for all TS files
    {
        files: ['**/*.{ts,tsx}'],
        rules: {
            'no-restricted-imports': [
                'warn',
                ...restrictedBaseImports,
                {
                    name: 'sprotty',
                    message: "The sprotty default exports are customized and reexported by GLSP. Please use '@eclipse-glsp/client' instead"
                },
                {
                    name: 'sprotty-protocol',
                    message:
                        "The sprotty-protocol default exports are customized and reexported by GLSP. Please use '@eclipse-glsp/client' instead"
                },
                {
                    name: 'uuid',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/protocol') instead of importing 'uuid' directly."
                },
                {
                    name: 'uuid/*',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/protocol') instead of importing 'uuid' directly."
                }
            ],
            '@typescript-eslint/no-unused-vars': [
                'error',
                {
                    args: 'none',
                    caughtErrors: 'none',
                    varsIgnorePattern: 'svg|html'
                }
            ]
        }
    },
    // packages/protocol: restrict sprotty and uuid direct imports
    {
        files: ['packages/protocol/src/**/*.{ts,tsx}'],
        rules: {
            'no-restricted-imports': [
                'warn',
                ...restrictedBaseImports,
                {
                    name: 'sprotty',
                    message: "The protocol package should not have any direct 'sprotty' dependencies. Try to use 'sprotty-protocol' instead"
                },
                {
                    name: 'sprotty/*',
                    message: "The protocol package should not have any direct 'sprotty' dependencies. Try to use 'sprotty-protocol' instead"
                },
                {
                    name: 'uuid',
                    message:
                        "Use the 'generateUuid'/'isUuid' helpers (from this package's 'utils/uuid' module) instead of importing 'uuid' directly."
                },
                {
                    name: 'uuid/*',
                    message:
                        "Use the 'generateUuid'/'isUuid' helpers (from this package's 'utils/uuid' module) instead of importing 'uuid' directly."
                }
            ]
        }
    },
    // packages/glsp-sprotty: restrict sprotty-protocol direct imports
    {
        files: ['packages/glsp-sprotty/src/**/*.{ts,tsx}'],
        rules: {
            'no-restricted-imports': [
                'warn',
                ...restrictedBaseImports,
                {
                    name: 'sprotty-protocol',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: 'sprotty-protocol/*',
                    message: "Please use '@eclipse-glsp/protocol' instead"
                },
                {
                    name: 'uuid',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/protocol') instead of importing 'uuid' directly."
                },
                {
                    name: 'uuid/*',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/protocol') instead of importing 'uuid' directly."
                }
            ]
        }
    },
    // packages/client: restrict direct sprotty/sprotty-protocol/@eclipse-glsp/protocol imports
    {
        files: ['packages/client/src/**/*.{ts,tsx}'],
        rules: {
            'no-restricted-imports': [
                'warn',
                ...restrictedBaseImports,
                {
                    name: 'sprotty',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: 'sprotty/*',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: 'sprotty-protocol',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: 'sprotty-protocol/*',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: '@eclipse-glsp/protocol',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: '@eclipse-glsp/protocol/*',
                    message: 'Please use @eclipse-glsp/sprotty instead'
                },
                {
                    name: 'uuid',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/sprotty') instead of importing 'uuid' directly."
                },
                {
                    name: 'uuid/*',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/sprotty') instead of importing 'uuid' directly."
                }
            ]
        }
    },
    // examples: only consume the public '@eclipse-glsp/client' API; the lower layers
    // (protocol, sprotty, raw sprotty/sprotty-protocol) are re-exported through it.
    {
        files: ['examples/*/src/**/*.{ts,tsx}'],
        rules: {
            'no-restricted-imports': [
                'warn',
                ...restrictedBaseImports,
                {
                    name: 'sprotty',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: 'sprotty/*',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: 'sprotty-protocol',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: 'sprotty-protocol/*',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: '@eclipse-glsp/protocol',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: '@eclipse-glsp/protocol/*',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: '@eclipse-glsp/sprotty',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: '@eclipse-glsp/sprotty/*',
                    message: 'Please use @eclipse-glsp/client instead'
                },
                {
                    name: 'uuid',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/client') instead of importing 'uuid' directly."
                },
                {
                    name: 'uuid/*',
                    message: "Use the 'generateUuid'/'isUuid' helpers (from '@eclipse-glsp/client') instead of importing 'uuid' directly."
                }
            ]
        }
    }
];