forked from typescript-eslint/typescript-eslint
-
Notifications
You must be signed in to change notification settings - Fork 1
/
convert.test.ts
345 lines (282 loc) · 10.1 KB
/
convert.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
import type { TSESTree } from '@typescript-eslint/types';
import { AST_NODE_TYPES } from '@typescript-eslint/types';
import * as ts from 'typescript';
import type { TSNode } from '../../src';
import type { ConverterOptions } from '../../src/convert';
import { Converter } from '../../src/convert';
describe('convert', () => {
function convertCode(code: string): ts.SourceFile {
return ts.createSourceFile(
'text.ts',
code,
ts.ScriptTarget.ESNext,
true,
ts.ScriptKind.TSX,
);
}
it('deeplyCopy should convert node correctly', () => {
const ast = convertCode('type foo = ?foo<T> | ?(() => void)?');
function fakeUnknownKind(node: ts.Node): void {
ts.forEachChild(node, fakeUnknownKind);
// @ts-expect-error -- intentionally writing to a readonly field
// eslint-disable-next-line deprecation/deprecation
node.kind = ts.SyntaxKind.UnparsedPrologue;
}
ts.forEachChild(ast, fakeUnknownKind);
const instance = new Converter(ast);
expect(instance.convertProgram()).toMatchSnapshot();
});
it('deeplyCopy should convert node with decorators correctly', () => {
const ast = convertCode('@test class foo {}');
const instance = new Converter(ast);
expect(
instance['deeplyCopy'](ast.statements[0] as ts.ClassDeclaration),
).toMatchSnapshot();
});
it('deeplyCopy should convert node with type parameters correctly', () => {
const ast = convertCode('class foo<T> {}');
const instance = new Converter(ast);
expect(
instance['deeplyCopy'](ast.statements[0] as ts.ClassDeclaration),
).toMatchSnapshot();
});
it('deeplyCopy should convert node with type arguments correctly', () => {
const ast = convertCode('new foo<T>()');
const instance = new Converter(ast);
expect(
instance['deeplyCopy'](
(ast.statements[0] as ts.ExpressionStatement)
.expression as ts.NewExpression,
),
).toMatchSnapshot();
});
it('deeplyCopy should convert array of nodes', () => {
const ast = convertCode('new foo<T>()');
const instance = new Converter(ast);
expect(instance['deeplyCopy'](ast)).toMatchSnapshot();
});
it('deeplyCopy should fail on unknown node', () => {
const ast = convertCode('type foo = ?foo<T> | ?(() => void)?');
const instance = new Converter(ast, {
errorOnUnknownASTType: true,
});
expect(() => instance['deeplyCopy'](ast)).toThrow(
'Unknown AST_NODE_TYPE: "TSSourceFile"',
);
});
it('nodeMaps should contain basic nodes', () => {
const ast = convertCode(`
'test';
2;
class foo {};
type bar = {};
`);
const instance = new Converter(ast, {
shouldPreserveNodeMaps: true,
});
instance.convertProgram();
const maps = instance.getASTMaps();
function checkMaps(child: ts.SourceFile | ts.Node): void {
child.forEachChild(node => {
if (
node.kind !== ts.SyntaxKind.EndOfFileToken &&
node.kind !== ts.SyntaxKind.JsxAttributes &&
node.kind !== ts.SyntaxKind.VariableDeclaration
) {
expect(node).toBe(
maps.esTreeNodeToTSNodeMap.get(
maps.tsNodeToESTreeNodeMap.get(node as TSNode),
),
);
}
checkMaps(node);
});
}
expect(ast).toBe(
maps.esTreeNodeToTSNodeMap.get(maps.tsNodeToESTreeNodeMap.get(ast)),
);
checkMaps(ast);
});
it('nodeMaps should contain jsx nodes', () => {
const ast = convertCode(`<a.b.c.d.e></a.b.c.d.e>`);
const instance = new Converter(ast, {
shouldPreserveNodeMaps: true,
});
instance.convertProgram();
const maps = instance.getASTMaps();
function checkMaps(child: ts.SourceFile | ts.Node): void {
child.forEachChild(node => {
if (
node.kind !== ts.SyntaxKind.EndOfFileToken &&
node.kind !== ts.SyntaxKind.JsxAttributes
) {
expect(node).toBe(
maps.esTreeNodeToTSNodeMap.get(
maps.tsNodeToESTreeNodeMap.get(node as TSNode),
),
);
}
checkMaps(node);
});
}
expect(ast).toBe(
maps.esTreeNodeToTSNodeMap.get(maps.tsNodeToESTreeNodeMap.get(ast)),
);
checkMaps(ast);
});
it('nodeMaps should contain export node', () => {
const ast = convertCode(`export function foo () {}`);
const instance = new Converter(ast, {
shouldPreserveNodeMaps: true,
});
const program = instance.convertProgram();
const maps = instance.getASTMaps();
function checkMaps(child: ts.SourceFile | ts.Node): void {
child.forEachChild(node => {
if (node.kind !== ts.SyntaxKind.EndOfFileToken) {
expect(ast).toBe(
maps.esTreeNodeToTSNodeMap.get(maps.tsNodeToESTreeNodeMap.get(ast)),
);
}
checkMaps(node);
});
}
expect(ast).toBe(
maps.esTreeNodeToTSNodeMap.get(maps.tsNodeToESTreeNodeMap.get(ast)),
);
expect(maps.esTreeNodeToTSNodeMap.get(program.body[0])).toBeDefined();
expect(program.body[0]).not.toBe(
maps.tsNodeToESTreeNodeMap.get(ast.statements[0] as TSNode),
);
checkMaps(ast);
});
it('should correctly create node with range and loc set', () => {
const ast = convertCode('');
const instance = new Converter(ast, {
shouldPreserveNodeMaps: true,
});
const tsNode: ts.KeywordToken<ts.SyntaxKind.AbstractKeyword> = {
...ts.factory.createToken(ts.SyntaxKind.AbstractKeyword),
end: 10,
pos: 0,
};
const convertedNode = instance['createNode'](tsNode, {
type: AST_NODE_TYPES.TSAbstractKeyword,
range: [0, 20],
loc: {
start: {
line: 10,
column: 20,
},
end: {
line: 15,
column: 25,
},
},
});
expect(convertedNode).toEqual({
type: AST_NODE_TYPES.TSAbstractKeyword,
range: [0, 20],
loc: {
start: {
line: 10,
column: 20,
},
end: {
line: 15,
column: 25,
},
},
});
});
it('should throw error on jsDoc node', () => {
const jsDocCode = [
'const x: function(new: number, string);',
'const x: function(this: number, string);',
'var g: function(number, number): number;',
];
for (const code of jsDocCode) {
const ast = convertCode(code);
const instance = new Converter(ast);
expect(() => instance.convertProgram()).toThrow(
'JSDoc types can only be used inside documentation comments.',
);
}
});
describe('allowInvalidAST', () => {
const code = 'const;';
it(`throws an error for an invalid AST when allowInvalidAST is false`, () => {
const ast = convertCode(code);
const instance = new Converter(ast);
expect(() => instance.convertProgram()).toThrow(
'A variable declaration list must have at least one variable declarator.',
);
});
it(`does not throw an error for an invalid AST when allowInvalidAST is true`, () => {
const ast = convertCode(code);
const instance = new Converter(ast, {
allowInvalidAST: true,
});
expect(() => instance.convertProgram()).not.toThrow();
});
});
describe('suppressDeprecatedPropertyWarnings', () => {
const getEsCallExpression = (
converterOptions?: ConverterOptions,
): TSESTree.CallExpression => {
const ast = convertCode(`callee<T>();`);
const tsCallExpression = (ast.statements[0] as ts.ExpressionStatement)
.expression as ts.CallExpression;
const instance = new Converter(ast, {
shouldPreserveNodeMaps: true,
...converterOptions,
});
instance.convertProgram();
const maps = instance.getASTMaps();
return maps.tsNodeToESTreeNodeMap.get(tsCallExpression);
};
it('logs on a deprecated property access when suppressDeprecatedPropertyWarnings is false', () => {
const warn = jest.spyOn(console, 'warn').mockImplementation();
const esCallExpression = getEsCallExpression({
suppressDeprecatedPropertyWarnings: false,
});
// eslint-disable-next-line deprecation/deprecation
esCallExpression.typeParameters;
expect(warn).toHaveBeenCalledWith(
`The 'typeParameters' property is deprecated on CallExpression nodes. Use 'typeArguments' instead. See https://typescript-eslint.io/linting/troubleshooting#the-key-property-is-deprecated-on-type-nodes-use-key-instead-warnings.`,
);
});
it('does not log on a subsequent deprecated property access when suppressDeprecatedPropertyWarnings is false', () => {
const warn = jest.spyOn(console, 'warn').mockImplementation();
const esCallExpression = getEsCallExpression({
suppressDeprecatedPropertyWarnings: false,
});
/* eslint-disable deprecation/deprecation */
esCallExpression.typeParameters;
esCallExpression.typeParameters;
/* eslint-enable deprecation/deprecation */
expect(warn).toHaveBeenCalledTimes(1);
});
it('does not log on a deprecated property access when suppressDeprecatedPropertyWarnings is true', () => {
const warn = jest.spyOn(console, 'warn').mockImplementation();
const esCallExpression = getEsCallExpression({
suppressDeprecatedPropertyWarnings: true,
});
// eslint-disable-next-line deprecation/deprecation
esCallExpression.typeParameters;
expect(warn).not.toHaveBeenCalled();
});
it('does not allow enumeration of deprecated properties', () => {
const esCallExpression = getEsCallExpression();
expect(Object.keys(esCallExpression)).not.toContain('typeParameters');
});
it('allows writing to the deprecated property as a new enumerable value', () => {
const esCallExpression = getEsCallExpression();
// eslint-disable-next-line deprecation/deprecation
esCallExpression.typeParameters = undefined;
// eslint-disable-next-line deprecation/deprecation
expect(esCallExpression.typeParameters).toBeUndefined();
expect(Object.keys(esCallExpression)).toContain('typeParameters');
});
});
});