/
isTypeReadonly.test.ts
277 lines (235 loc) · 9.07 KB
/
isTypeReadonly.test.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
import * as ts from 'typescript';
import { TSESTree } from '@typescript-eslint/utils';
import { parseForESLint } from '@typescript-eslint/parser';
import {
isTypeReadonly,
type ReadonlynessOptions,
} from '../src/isTypeReadonly';
import path from 'path';
describe('isTypeReadonly', () => {
const rootDir = path.join(__dirname, 'fixtures');
describe('TSTypeAliasDeclaration ', () => {
function getType(code: string): {
type: ts.Type;
checker: ts.TypeChecker;
} {
const { ast, services } = parseForESLint(code, {
project: './tsconfig.json',
filePath: path.join(rootDir, 'file.ts'),
tsconfigRootDir: rootDir,
});
const checker = services.program.getTypeChecker();
const esTreeNodeToTSNodeMap = services.esTreeNodeToTSNodeMap;
const declaration = ast.body[0] as TSESTree.TSTypeAliasDeclaration;
return {
type: checker.getTypeAtLocation(
esTreeNodeToTSNodeMap.get(declaration.id),
),
checker,
};
}
function runTestForAliasDeclaration(
code: string,
options: ReadonlynessOptions | undefined,
expected: boolean,
): void {
const { type, checker } = getType(code);
const result = isTypeReadonly(checker, type, options);
expect(result).toBe(expected);
}
describe('default options', () => {
const options = undefined;
function runTestIsReadonly(code: string): void {
runTestForAliasDeclaration(code, options, true);
}
function runTestIsNotReadonly(code: string): void {
runTestForAliasDeclaration(code, options, false);
}
describe('basics', () => {
describe('is readonly', () => {
const runTests = runTestIsReadonly;
// Record.
it.each([
['type Test = { readonly bar: string; };'],
['type Test = Readonly<{ bar: string; }>;'],
])('handles fully readonly records', runTests);
// Array.
it.each([
['type Test = Readonly<readonly string[]>;'],
['type Test = Readonly<ReadonlyArray<string>>;'],
])('handles fully readonly arrays', runTests);
// Array - special case.
// Note: Methods are mutable but arrays are treated special; hence no failure.
it.each([
['type Test = readonly string[];'],
['type Test = ReadonlyArray<string>;'],
])('treats readonly arrays as fully readonly', runTests);
// Set and Map.
it.each([
['type Test = Readonly<ReadonlySet<string>>;'],
['type Test = Readonly<ReadonlyMap<string, string>>;'],
])('handles fully readonly sets and maps', runTests);
// Private Identifier.
// Note: It can't be accessed from outside of class thus exempt from the checks.
it.each([
['class Foo { readonly #readonlyPrivateField = "foo"; }'],
['class Foo { #privateField = "foo"; }'],
['class Foo { #privateMember() {}; }'],
])('treat private identifier as readonly', runTests);
});
describe('is not readonly', () => {
const runTests = runTestIsNotReadonly;
// Record.
it.each([
['type Test = { foo: string; };'],
['type Test = { foo: string; readonly bar: number; };'],
])('handles non fully readonly records', runTests);
// Array.
it.each([['type Test = string[]'], ['type Test = Array<string>']])(
'handles non fully readonly arrays',
runTests,
);
// Set and Map.
// Note: Methods are mutable for ReadonlySet and ReadonlyMet; hence failure.
it.each([
['type Test = Set<string>;'],
['type Test = Map<string, string>;'],
['type Test = ReadonlySet<string>;'],
['type Test = ReadonlyMap<string, string>;'],
])('handles non fully readonly sets and maps', runTests);
});
});
describe('IndexSignature', () => {
describe('is readonly', () => {
const runTests = runTestIsReadonly;
it.each([
['type Test = { readonly [key: string]: string };'],
[
'type Test = { readonly [key: string]: { readonly foo: readonly string[]; }; };',
],
])(
'handles readonly PropertySignature inside a readonly IndexSignature',
runTests,
);
});
describe('is not readonly', () => {
const runTests = runTestIsNotReadonly;
it.each([
['type Test = { [key: string]: string };'],
['type Test = { readonly [key: string]: { foo: string[]; }; };'],
])(
'handles mutable PropertySignature inside a readonly IndexSignature',
runTests,
);
});
});
describe('Union', () => {
describe('is readonly', () => {
const runTests = runTestIsReadonly;
it.each([
[
'type Test = Readonly<{ foo: string; bar: number; }> & Readonly<{ bar: number; }>;',
],
['type Test = readonly string[] | readonly number[];'],
])('handles a union of 2 fully readonly types', runTests);
});
describe('is not readonly', () => {
const runTests = runTestIsNotReadonly;
it.each([
['type Test = { foo: string; bar: number; } | { bar: number; };'],
[
'type Test = { foo: string; bar: number; } | Readonly<{ bar: number; }>;',
],
[
'type Test = Readonly<{ foo: string; bar: number; }> | { bar: number; };',
],
])('handles a union of non fully readonly types', runTests);
});
});
describe('Intersection', () => {
describe('is readonly', () => {
const runTests = runTestIsReadonly;
it.each([
[
'type Test = Readonly<{ foo: string; bar: number; }> & Readonly<{ bar: number; }>;',
],
])('handles an intersection of 2 fully readonly types', runTests);
it.each([
[
'type Test = Readonly<{ foo: string; bar: number; }> & { foo: string; };',
],
])(
'handles an intersection of a fully readonly type with a mutable subtype',
runTests,
);
// Array - special case.
// Note: Methods are mutable but arrays are treated special; hence no failure.
it.each([
['type Test = ReadonlyArray<string> & Readonly<{ foo: string; }>;'],
[
'type Test = readonly [string, number] & Readonly<{ foo: string; }>;',
],
])('handles an intersections involving a readonly array', runTests);
});
describe('is not readonly', () => {
const runTests = runTestIsNotReadonly;
it.each([
['type Test = { foo: string; bar: number; } & { bar: number; };'],
[
'type Test = { foo: string; bar: number; } & Readonly<{ bar: number; }>;',
],
[
'type Test = Readonly<{ bar: number; }> & { foo: string; bar: number; };',
],
])('handles an intersection of non fully readonly types', runTests);
});
});
describe('Conditional Types', () => {
describe('is readonly', () => {
const runTests = runTestIsReadonly;
it.each([
[
'type Test<T> = T extends readonly number[] ? readonly string[] : readonly number[];',
],
])('handles conditional type that are fully readonly', runTests);
it.each([
[
'type Test<T> = T extends number[] ? readonly string[] : readonly number[];',
],
])('should ignore mutable conditions', runTests);
});
describe('is not readonly', () => {
const runTests = runTestIsNotReadonly;
it.each([
['type Test<T> = T extends number[] ? string[] : number[];'],
[
'type Test<T> = T extends number[] ? string[] : readonly number[];',
],
[
'type Test<T> = T extends number[] ? readonly string[] : number[];',
],
])('handles non fully readonly conditional types', runTests);
});
});
});
describe('treatMethodsAsReadonly', () => {
const options: ReadonlynessOptions = {
treatMethodsAsReadonly: true,
};
function runTestIsReadonly(code: string): void {
runTestForAliasDeclaration(code, options, true);
}
// function runTestIsNotReadonly(code: string): void {
// runTestForAliasDeclaration(code, options, false);
// }
describe('is readonly', () => {
const runTests = runTestIsReadonly;
// Set and Map.
it.each([
['type Test = ReadonlySet<string>;'],
['type Test = ReadonlyMap<string, string>;'],
])('handles non fully readonly sets and maps', runTests);
});
});
});
});