/
isTypeReadonly.test.ts
278 lines (227 loc) · 9.1 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
278
import * as ts from 'typescript';
import { TSESTree } from '@typescript-eslint/experimental-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,
};
}
describe('basics', () => {
describe('is readonly', () => {
describe('default options', () => {
it('handles a record with only readonly props', () => {
const { type, checker } = getType(
`type Test = { readonly bar: string; };`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(true);
});
it('handles a shallowly mutable record wrapped in Readonly', () => {
const { type: receiver, checker } = getType(
`type Test = Readonly<{ bar: string; }>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(true);
});
it('handles an readonly readonly array', () => {
const { type: receiver, checker } = getType(
`type Test = Readonly<readonly string[]>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(true);
});
it('handles an readonly ReadonlyArray', () => {
const { type: receiver, checker } = getType(
`type Test = Readonly<ReadonlyArray<string>>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(true);
});
it('handles an readonly ReadonlySet', () => {
const { type: receiver, checker } = getType(
`type Test = Readonly<ReadonlySet<string>>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(true);
});
// Methods are mutable but arrays have a special exemption; hence no failure.
it('handles a readonly array', () => {
const { type: receiver, checker } = getType(
`type Test = readonly string[];`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(true);
});
// Methods are mutable but arrays have a special exemption; hence no failure.
it('handles a ReadonlyArray', () => {
const { type: receiver, checker } = getType(
`type Test = ReadonlyArray<string>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(true);
});
});
describe('treatMethodsAsReadonly', () => {
const options: ReadonlynessOptions = {
treatMethodsAsReadonly: true,
};
it('handles a ReadonlySet', () => {
const { type: receiver, checker } = getType(
`type Test = ReadonlySet<string>;`,
);
const result = isTypeReadonly(checker, receiver, options);
expect(result).toBe(true);
});
it('handles a ReadonlyMap', () => {
const { type: receiver, checker } = getType(
`type Test = ReadonlyMap<string, string>;`,
);
const result = isTypeReadonly(checker, receiver, options);
expect(result).toBe(true);
});
});
});
describe('is not readonly', () => {
it('fails with record with mutable props', () => {
const { type: receiver, checker } = getType(
`type Test = { bar: string; };`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(false);
});
it('fails with a mutable array', () => {
const { type: receiver, checker } = getType(`type Test = string[];`);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(false);
});
it('fails with a mutable Array', () => {
const { type: receiver, checker } = getType(
`type Test = Array<string>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(false);
});
// Methods are mutable; hence failure.
it('fails with a ReadonlySet', () => {
const { type: receiver, checker } = getType(
`type Test = ReadonlySet<string>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(false);
});
// Methods are mutable; hence failure.
it('fails with a ReadonlyMap', () => {
const { type: receiver, checker } = getType(
`type Test = ReadonlyMap<string, string>;`,
);
const result = isTypeReadonly(checker, receiver);
expect(result).toBe(false);
});
});
});
describe('Intersection', () => {
describe('is readonly', () => {
describe('default options', () => {
it('handles an intersection of 2 records', () => {
const { type, checker } = getType(
`type Test = Readonly<{ foo: string; bar: number; }> & Readonly<{ bar: number; }>;`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(true);
});
it('handles a readonly intersection of readonly array and readonly record', () => {
const { type, checker } = getType(
`type Test = Readonly<ReadonlyArray<string> & { readonly foo: string; }>;`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(true);
});
it('handles a intersection of readonly readonly array and readonly record', () => {
const { type, checker } = getType(
`type Test = Readonly<ReadonlyArray<string>> & Readonly<{ readonly foo: string; }>;`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(true);
});
});
describe('treatMethodsAsReadonly', () => {
const options: ReadonlynessOptions = {
treatMethodsAsReadonly: true,
};
it('handles an intersection of readonly array and readonly record', () => {
const { type, checker } = getType(
`type Test = ReadonlyArray<string> & { readonly foo: string; };`,
);
const result = isTypeReadonly(checker, type, options);
expect(result).toBe(true);
});
});
});
describe('is not readonly', () => {
it('fails with an intersection of mutables', () => {
const { type, checker } = getType(
`type Test = { foo: string; bar: number; } & { bar: number; };`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(false);
});
it('fails with an intersection of mutable to readonly', () => {
const { type, checker } = getType(
`type Test = { foo: string; bar: number; } & Readonly<{ bar: number; }>;`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(false);
});
it('fails with an intersection of readonly to mutable', () => {
const { type, checker } = getType(
`type Test = { foo: string; bar: number; } & Readonly<{ bar: number; }>;`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(false);
});
});
});
describe('IndexSignature', () => {
describe('is readonly', () => {
it('handles readonly PropertySignature inside a readonly IndexSignature', () => {
const { type, checker } = getType(
`type Test = { readonly [key: string]: { readonly foo: readonly string[]; }; };`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(true);
});
});
describe('is not readonly', () => {
it('fails with a mutable PropertySignature inside a readonly IndexSignature', () => {
const { type, checker } = getType(
`type Test = { readonly [key: string]: { foo: string[]; }; };`,
);
const result = isTypeReadonly(checker, type);
expect(result).toBe(false);
});
});
});
});
});