/
ts-compiler.spec.ts
506 lines (428 loc) · 15.7 KB
/
ts-compiler.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
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
import { readFileSync } from 'fs'
import { join } from 'path'
import { LogLevels } from 'bs-logger'
import { createConfigSet, makeCompiler } from '../__helpers__/fakers'
import { logTargetMock } from '../__helpers__/mocks'
import { mockFolder } from '../__helpers__/path'
import ProcessedSource from '../__helpers__/processed-source'
import { TsCompiler } from './ts-compiler'
const logTarget = logTargetMock()
describe('TsCompiler', () => {
describe('isolatedModule true', () => {
const baseTsJestConfig = {
isolatedModules: true,
}
test('should transpile code with useESM true', () => {
const compiler = makeCompiler({
tsJestConfig: { ...baseTsJestConfig, useESM: true },
})
const fileName = join(mockFolder, 'thing.spec.ts')
const compiledOutput = compiler.getCompiledOutput(readFileSync(fileName, 'utf-8'), fileName, true)
expect(new ProcessedSource(compiledOutput, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
test('should compile js file for allowJs true', () => {
const fileName = 'foo.js'
const compiler = makeCompiler({
tsJestConfig: { ...baseTsJestConfig, tsconfig: { allowJs: true } },
})
const source = 'export default 42'
const compiledOutput = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiledOutput, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
describe('jsx option', () => {
const fileName = 'foo.tsx'
const source = `
const App = () => {
return <>Test</>
}
`
it('should compile tsx file for jsx preserve', () => {
const compiler = makeCompiler({
tsJestConfig: {
...baseTsJestConfig,
tsconfig: {
jsx: 'preserve' as any,
},
},
})
const compiledOutput = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiledOutput, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
it('should compile tsx file for other jsx options', () => {
const compiler = makeCompiler({
tsJestConfig: {
...baseTsJestConfig,
tsconfig: {
jsx: 'react' as any,
},
},
})
const compiledOutput = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiledOutput, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
})
describe('source maps', () => {
const source = 'const f = (v: number) => v\nconst t: number = f(5)'
const fileName = 'test-source-map-transpiler.ts'
it('should have correct source maps without mapRoot', () => {
const compiler = makeCompiler({ tsJestConfig: { ...baseTsJestConfig, tsconfig: false } })
const compiledOutput = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiledOutput, fileName).outputSourceMaps).toMatchObject({
file: fileName,
sources: [fileName],
sourcesContent: [source],
})
})
it('should have correct source maps with mapRoot', () => {
const compiler = makeCompiler({
tsJestConfig: {
...baseTsJestConfig,
tsconfig: {
mapRoot: './',
},
},
})
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputSourceMaps).toMatchObject({
file: fileName,
sources: [fileName],
sourcesContent: [source],
})
})
})
describe('diagnostics', () => {
it('should not report diagnostics related to typings', () => {
const compiler = makeCompiler({ tsJestConfig: { ...baseTsJestConfig, tsconfig: false } })
expect(() =>
compiler.getCompiledOutput(
`
const f = (v: number) => v
const t: string = f(5)
const v: boolean = t
`,
'foo.ts',
false,
),
).not.toThrowError()
})
it('should report diagnostics related to codes with exclude config is undefined', () => {
const compiler = makeCompiler({ tsJestConfig: { ...baseTsJestConfig, tsconfig: false } })
expect(() =>
compiler.getCompiledOutput(
`
const f = (v: number) = v
const t: string = f(5)
`,
'foo.ts',
false,
),
).toThrowErrorMatchingSnapshot()
})
it('should report diagnostics related to codes with exclude config matches file name', () => {
const compiler = makeCompiler({
tsJestConfig: { ...baseTsJestConfig, tsconfig: false, diagnostics: { exclude: ['foo.ts'] } },
})
expect(() =>
compiler.getCompiledOutput(
`
const f = (v: number) = v
const t: string = f(5)
`,
'foo.ts',
false,
),
).toThrowErrorMatchingSnapshot()
})
it('should not report diagnostics related to codes with exclude config does not match file name', () => {
const compiler = makeCompiler({
tsJestConfig: { ...baseTsJestConfig, tsconfig: false, diagnostics: { exclude: ['bar.ts'] } },
})
expect(() =>
compiler.getCompiledOutput(
`
const f = (v: number) = v
const t: string = f(5)
`,
'foo.ts',
false,
),
).not.toThrowError()
})
})
test('should use correct custom AST transformers', () => {
// eslint-disable-next-line no-console
console.log = jest.fn()
const fileName = 'foo.js'
const compiler = makeCompiler({
tsJestConfig: {
...baseTsJestConfig,
tsconfig: {
allowJs: true,
},
astTransformers: {
before: ['dummy-transformer'],
after: ['dummy-transformer'],
afterDeclarations: ['dummy-transformer'],
},
},
})
const source = 'export default 42'
compiler.getCompiledOutput(source, fileName, false)
// eslint-disable-next-line no-console
expect(console.log).toHaveBeenCalledTimes(3)
})
})
describe('isolatedModule false', () => {
const baseTsJestConfig = { tsconfig: require.resolve('../../tsconfig.spec.json') }
const jestCacheFS = new Map<string, string>()
beforeEach(() => {
logTarget.clear()
})
test('should compile codes with useESM true', () => {
const compiler = new TsCompiler(
createConfigSet({
tsJestConfig: {
...baseTsJestConfig,
useESM: true,
tsconfig: {
esModuleInterop: false,
allowSyntheticDefaultImports: false,
},
},
}),
new Map(),
)
const fileName = join(mockFolder, 'thing.spec.ts')
const compiledOutput = compiler.getCompiledOutput(readFileSync(fileName, 'utf-8'), fileName, true)
expect(new ProcessedSource(compiledOutput, fileName).outputCodeWithoutMaps).toMatchSnapshot()
// @ts-expect-error _compilerOptions is a private property
expect(compiler._compilerOptions.esModuleInterop).toEqual(true)
// @ts-expect-error _compilerOptions is a private property
expect(compiler._compilerOptions.allowSyntheticDefaultImports).toEqual(true)
// @ts-expect-error _initialCompilerOptions is a private property
expect(compiler._initialCompilerOptions.esModuleInterop).not.toEqual(true)
// @ts-expect-error _initialCompilerOptions is a private property
expect(compiler._initialCompilerOptions.allowSyntheticDefaultImports).not.toEqual(true)
})
describe('allowJs option', () => {
const fileName = 'test-allow-js.js'
const source = 'export default 42'
jestCacheFS.set(fileName, source)
it('should compile js file for allowJs true with outDir', () => {
const compiler = makeCompiler(
{
tsJestConfig: { tsconfig: { allowJs: true, outDir: '$$foo$$' } },
},
jestCacheFS,
)
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
it('should compile js file for allowJs true without outDir', () => {
const compiler = makeCompiler(
{
tsJestConfig: { tsconfig: { allowJs: true } },
},
jestCacheFS,
)
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
})
describe('jsx option', () => {
const fileName = 'test-jsx.tsx'
const source = `
const App = () => {
return <>Test</>
}
`
jestCacheFS.set(fileName, source)
it('should compile tsx file for jsx preserve', () => {
const compiler = makeCompiler(
{
tsJestConfig: {
tsconfig: {
jsx: 'preserve' as any,
},
},
},
jestCacheFS,
)
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
it('should compile tsx file for other jsx options', () => {
const compiler = makeCompiler(
{
tsJestConfig: {
tsconfig: {
jsx: 'react' as any,
},
},
},
jestCacheFS,
)
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputCodeWithoutMaps).toMatchSnapshot()
})
})
describe('source maps', () => {
const source = 'const gsm = (v: number) => v\nconst h: number = gsm(5)'
const fileName = 'test-source-map.ts'
jestCacheFS.set(fileName, source)
it('should have correct source maps without mapRoot', () => {
const compiler = makeCompiler(
{ tsJestConfig: { tsconfig: require.resolve('../../tsconfig.spec.json') } },
jestCacheFS,
)
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputSourceMaps).toMatchObject({
file: fileName,
sources: [fileName],
sourcesContent: [source],
})
})
it('should have correct source maps with mapRoot', () => {
const compiler = makeCompiler(
{
tsJestConfig: {
tsconfig: {
mapRoot: './',
},
},
},
jestCacheFS,
)
const compiled = compiler.getCompiledOutput(source, fileName, false)
expect(new ProcessedSource(compiled, fileName).outputSourceMaps).toMatchObject({
file: fileName,
sources: [fileName],
sourcesContent: [source],
})
})
})
describe('module resolution', () => {
it(`should use moduleResolutionCache`, () => {
jest.unmock('typescript')
const ts = require('typescript')
const moduleResolutionCacheMock = (ts.createModuleResolutionCache = jest.fn().mockImplementation(() => {}))
makeCompiler({
tsJestConfig: baseTsJestConfig,
})
expect(moduleResolutionCacheMock).toHaveBeenCalled()
expect(moduleResolutionCacheMock.mock.calls[0].length).toBe(3)
moduleResolutionCacheMock.mockRestore()
})
})
describe('getResolvedModulesMap', () => {
const fileName = 'foo.ts'
const fileContent = 'const foo = 1'
test('should return undefined when file name is not known to compiler', () => {
const compiler = makeCompiler({
tsJestConfig: baseTsJestConfig,
})
expect(compiler.getResolvedModulesMap(fileContent, fileName)).toBeUndefined()
})
test('should return undefined when it is isolatedModules true', () => {
const compiler = makeCompiler({
tsJestConfig: {
...baseTsJestConfig,
isolatedModules: true,
},
})
expect(compiler.getResolvedModulesMap(fileContent, fileName)).toBeUndefined()
})
test('should return undefined when file has no resolved modules', () => {
const jestCacheFS = new Map<string, string>()
jestCacheFS.set(fileName, fileContent)
const compiler = makeCompiler(
{
tsJestConfig: baseTsJestConfig,
},
jestCacheFS,
)
expect(compiler.getResolvedModulesMap(fileContent, fileName)).toBeUndefined()
})
test('should return resolved modules when file has resolved modules', () => {
const jestCacheFS = new Map<string, string>()
const fileContentWithModules = readFileSync(join(__dirname, '..', '__mocks__', 'thing.spec.ts'), 'utf-8')
jestCacheFS.set(fileName, fileContentWithModules)
const compiler = makeCompiler(
{
tsJestConfig: baseTsJestConfig,
},
jestCacheFS,
)
expect(compiler.getResolvedModulesMap(fileContentWithModules, fileName)).toBeDefined()
})
})
describe('diagnostics', () => {
const importedFileName = require.resolve('../__mocks__/thing.ts')
const importedFileContent = readFileSync(importedFileName, 'utf-8')
it(`shouldn't report diagnostics when file name doesn't match diagnostic file pattern`, () => {
jestCacheFS.set(importedFileName, importedFileContent)
const compiler = makeCompiler(
{
tsJestConfig: {
...baseTsJestConfig,
diagnostics: { exclude: ['foo.spec.ts'] },
},
},
jestCacheFS,
)
expect(() => compiler.getCompiledOutput(importedFileContent, importedFileName, false)).not.toThrowError()
})
it(`shouldn't report diagnostic when processing file isn't used by any test files`, () => {
jestCacheFS.set('foo.ts', importedFileContent)
const compiler = makeCompiler(
{
tsJestConfig: baseTsJestConfig,
},
jestCacheFS,
)
logTarget.clear()
compiler.getCompiledOutput(importedFileContent, 'foo.ts', false)
expect(logTarget.filteredLines(LogLevels.debug, Infinity)).toMatchSnapshot()
})
it('should throw error when cannot compile', () => {
const fileName = 'test-cannot-compile.d.ts'
const source = `
interface Foo {
a: string
}
`
jestCacheFS.set(fileName, source)
const compiler = makeCompiler(
{
tsJestConfig: baseTsJestConfig,
},
jestCacheFS,
)
expect(() => compiler.getCompiledOutput(source, fileName, false)).toThrowErrorMatchingSnapshot()
})
})
test('should pass Program instance into custom transformers', () => {
// eslint-disable-next-line no-console
console.log = jest.fn()
const fileName = join(mockFolder, 'thing.spec.ts')
const compiler = makeCompiler(
{
tsJestConfig: {
...baseTsJestConfig,
astTransformers: {
before: ['dummy-transformer'],
after: ['dummy-transformer'],
afterDeclarations: ['dummy-transformer'],
},
},
},
jestCacheFS,
)
compiler.getCompiledOutput(readFileSync(fileName, 'utf-8'), fileName, false)
// eslint-disable-next-line no-console
expect(console.log).toHaveBeenCalled()
// eslint-disable-next-line no-console
expect(((console.log as any) as jest.MockInstance<any, any>).mock.calls[0][0].emit).toBeDefined()
})
})
})