forked from typescript-eslint/typescript-eslint
/
isTypeReadonly.test.ts
166 lines (140 loc) · 5.17 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
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);
});
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('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);
});
});
});
});