forked from nrwl/nx
/
remove-eslint-project-config-if-no-type-checking-rules.spec.ts
236 lines (220 loc) · 6.6 KB
/
remove-eslint-project-config-if-no-type-checking-rules.spec.ts
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
import {
addProjectConfiguration,
readJson,
Tree,
writeJson,
} from '@nrwl/devkit';
import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
import removeESLintProjectConfigIfNoTypeCheckingRules from './remove-eslint-project-config-if-no-type-checking-rules';
import type { Linter } from 'eslint';
const KNOWN_RULE_REQUIRING_TYPE_CHECKING = '@typescript-eslint/await-thenable';
describe('Remove ESLint parserOptions.project config if no rules requiring type-checking are in use', () => {
let tree: Tree;
beforeEach(async () => {
tree = createTreeWithEmptyWorkspace();
addProjectConfiguration(tree, 'react-app', {
root: 'apps/react-app',
sourceRoot: 'apps/react-app/src',
projectType: 'application',
targets: {},
});
addProjectConfiguration(tree, 'workspace-lib', {
root: 'libs/workspace-lib',
sourceRoot: 'libs/workspace-lib/src',
projectType: 'library',
targets: {},
});
addProjectConfiguration(tree, 'some-lib', {
root: 'libs/some-lib',
sourceRoot: 'libs/some-lib/src',
projectType: 'library',
targets: {},
});
addProjectConfiguration(tree, 'another-lib', {
root: 'libs/another-lib',
sourceRoot: 'libs/another-lib/src',
projectType: 'library',
targets: {},
});
});
it('should not update any configs if the root .eslintrc.json contains at least one rule requiring type-checking', async () => {
const rootEslintConfig = {
root: true,
ignorePatterns: ['**/*'],
plugins: ['@nrwl/nx'],
overrides: [
{
files: ['*.ts', '*.tsx', '*.js', '*.jsx'],
rules: {
'@nrwl/nx/enforce-module-boundaries': [
'error',
{
enforceBuildableLibDependency: true,
allow: [],
depConstraints: [
{ sourceTag: '*', onlyDependOnLibsWithTags: ['*'] },
],
},
],
},
},
{
files: ['*.ts', '*.tsx'],
extends: ['plugin:@nrwl/nx/typescript'],
rules: {
[KNOWN_RULE_REQUIRING_TYPE_CHECKING]: 'error',
},
},
{
files: ['*.js', '*.jsx'],
extends: ['plugin:@nrwl/nx/javascript'],
rules: {},
},
],
};
writeJson(tree, '.eslintrc.json', rootEslintConfig);
const projectEslintConfig1 = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
project: 'some-path-to-tsconfig.json',
},
rules: {},
},
],
};
writeJson(tree, 'apps/react-app/.eslintrc.json', projectEslintConfig1);
const projectEslintConfig2 = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
project: 'some-path-to-tsconfig.json',
},
rules: {},
},
],
};
writeJson(tree, 'libs/workspace-lib/.eslintrc.json', projectEslintConfig2);
await removeESLintProjectConfigIfNoTypeCheckingRules(tree);
// No change
expect(readJson(tree, 'apps/react-app/.eslintrc.json')).toEqual(
projectEslintConfig1
);
// No change
expect(readJson(tree, 'libs/workspace-lib/.eslintrc.json')).toEqual(
projectEslintConfig1
);
});
it('should remove the parserOptions.project from any project .eslintrc.json files that do not contain any rules requiring type-checking', async () => {
// Root doesn't contain any rules requiring type-checking
const rootEslintConfig = {
root: true,
ignorePatterns: ['**/*'],
plugins: ['@nrwl/nx'],
overrides: [],
};
writeJson(tree, '.eslintrc.json', rootEslintConfig);
const projectEslintConfig1: Linter.Config = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
project: 'some-path-to-tsconfig.json',
},
rules: {
[KNOWN_RULE_REQUIRING_TYPE_CHECKING]: 'error',
},
},
],
};
writeJson(tree, 'apps/react-app/.eslintrc.json', projectEslintConfig1);
const projectEslintConfig2: Linter.Config = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
project: 'some-path-to-tsconfig.json',
},
rules: {
// No rules requiring type-checking
},
},
],
};
writeJson(tree, 'libs/workspace-lib/.eslintrc.json', projectEslintConfig2);
const projectEslintConfig3: Linter.Config = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
project: 'some-path-to-tsconfig.json',
},
rules: {
[KNOWN_RULE_REQUIRING_TYPE_CHECKING]: 'off',
},
},
],
};
writeJson(tree, 'libs/another-lib/.eslintrc.json', projectEslintConfig3);
await removeESLintProjectConfigIfNoTypeCheckingRules(tree);
// No change - uses rule requiring type-checking
expect(readJson(tree, 'apps/react-app/.eslintrc.json')).toEqual(
projectEslintConfig1
);
// Updated - no more parserOptions.project
expect(readJson(tree, 'libs/workspace-lib/.eslintrc.json'))
.toMatchInlineSnapshot(`
Object {
"extends": "../../../.eslintrc.json",
"ignorePatterns": Array [
"!**/*",
],
"overrides": Array [
Object {
"files": Array [
"*.ts",
"*.tsx",
],
"rules": Object {},
},
],
}
`);
// Updated - no more parserOptions.project
expect(readJson(tree, 'libs/another-lib/.eslintrc.json'))
.toMatchInlineSnapshot(`
Object {
"extends": "../../../.eslintrc.json",
"ignorePatterns": Array [
"!**/*",
],
"overrides": Array [
Object {
"files": Array [
"*.ts",
"*.tsx",
],
"rules": Object {
"@typescript-eslint/await-thenable": "off",
},
},
],
}
`);
});
it('should not error if .eslintrc.json does not exist', async () => {
await removeESLintProjectConfigIfNoTypeCheckingRules(tree);
});
});