|
| 1 | +/** |
| 2 | + * @license |
| 3 | + * Copyright Google LLC All Rights Reserved. |
| 4 | + * |
| 5 | + * Use of this source code is governed by an MIT-style license that can be |
| 6 | + * found in the LICENSE file at https://angular.io/license |
| 7 | + */ |
| 8 | + |
| 9 | +import { EmptyTree } from '@angular-devkit/schematics'; |
| 10 | +import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing'; |
| 11 | +import { parse as parseJson } from 'jsonc-parser'; |
| 12 | +import { Builders, ProjectType, WorkspaceSchema } from '../../utility/workspace-models'; |
| 13 | + |
| 14 | +describe('Migration to update target compiler options', () => { |
| 15 | + const schematicName = 'update-tsconfig-target'; |
| 16 | + const schematicRunner = new SchematicTestRunner( |
| 17 | + 'migrations', |
| 18 | + require.resolve('../migration-collection.json'), |
| 19 | + ); |
| 20 | + |
| 21 | + function createJsonFile(tree: UnitTestTree, filePath: string, content: {}) { |
| 22 | + tree.create(filePath, JSON.stringify(content, undefined, 2)); |
| 23 | + } |
| 24 | + |
| 25 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 26 | + function readJsonFile(tree: UnitTestTree, filePath: string): any { |
| 27 | + return parseJson(tree.readContent(filePath).toString()); |
| 28 | + } |
| 29 | + |
| 30 | + let tree: UnitTestTree; |
| 31 | + |
| 32 | + beforeEach(() => { |
| 33 | + tree = new UnitTestTree(new EmptyTree()); |
| 34 | + |
| 35 | + // Workspace configuration |
| 36 | + const angularConfig: WorkspaceSchema = { |
| 37 | + version: 1, |
| 38 | + projects: { |
| 39 | + app: { |
| 40 | + root: '', |
| 41 | + sourceRoot: 'src', |
| 42 | + projectType: ProjectType.Application, |
| 43 | + prefix: 'app', |
| 44 | + architect: { |
| 45 | + build: { |
| 46 | + builder: Builders.Browser, |
| 47 | + options: { |
| 48 | + tsConfig: 'src/tsconfig.app.json', |
| 49 | + main: '', |
| 50 | + polyfills: '', |
| 51 | + }, |
| 52 | + configurations: { |
| 53 | + production: { |
| 54 | + tsConfig: 'src/tsconfig.app.prod.json', |
| 55 | + }, |
| 56 | + }, |
| 57 | + }, |
| 58 | + test: { |
| 59 | + builder: Builders.Karma, |
| 60 | + options: { |
| 61 | + karmaConfig: '', |
| 62 | + tsConfig: 'src/tsconfig.spec.json', |
| 63 | + }, |
| 64 | + }, |
| 65 | + server: { |
| 66 | + builder: Builders.Server, |
| 67 | + options: { |
| 68 | + tsConfig: 'src/tsconfig.server.json', |
| 69 | + outputPath: '', |
| 70 | + main: '', |
| 71 | + }, |
| 72 | + }, |
| 73 | + }, |
| 74 | + }, |
| 75 | + }, |
| 76 | + }; |
| 77 | + |
| 78 | + createJsonFile(tree, 'angular.json', angularConfig); |
| 79 | + |
| 80 | + // Create tsconfigs |
| 81 | + const compilerOptions = { target: 'es5', module: 'esnext' }; |
| 82 | + |
| 83 | + // Workspace |
| 84 | + createJsonFile(tree, 'tsconfig.json', { compilerOptions }); |
| 85 | + |
| 86 | + // Application |
| 87 | + createJsonFile(tree, 'src/tsconfig.app.json', { compilerOptions }); |
| 88 | + createJsonFile(tree, 'src/tsconfig.app.prod.json', { compilerOptions }); |
| 89 | + createJsonFile(tree, 'src/tsconfig.spec.json', { compilerOptions }); |
| 90 | + |
| 91 | + // Server |
| 92 | + createJsonFile(tree, 'src/tsconfig.server.json', { compilerOptions }); |
| 93 | + }); |
| 94 | + |
| 95 | + it(`should update target in workspace 'tsconfig.json'`, async () => { |
| 96 | + const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise(); |
| 97 | + const { target } = readJsonFile(newTree, 'tsconfig.json').compilerOptions; |
| 98 | + expect(target).toBe('es2020'); |
| 99 | + }); |
| 100 | + |
| 101 | + it(`should update target in 'tsconfig.json' which is referenced in option`, async () => { |
| 102 | + const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise(); |
| 103 | + const { target } = readJsonFile(newTree, 'src/tsconfig.spec.json').compilerOptions; |
| 104 | + expect(target).toBe('es2020'); |
| 105 | + }); |
| 106 | + |
| 107 | + it(`should update target in 'tsconfig.json' which is referenced in a configuration`, async () => { |
| 108 | + const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise(); |
| 109 | + const { target } = readJsonFile(newTree, 'src/tsconfig.app.prod.json').compilerOptions; |
| 110 | + expect(target).toBe('es2020'); |
| 111 | + }); |
| 112 | + |
| 113 | + it(`should not update target in 'tsconfig.server.json'`, async () => { |
| 114 | + const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise(); |
| 115 | + const { target } = readJsonFile(newTree, 'src/tsconfig.server.json').compilerOptions; |
| 116 | + expect(target).toBe('es5'); |
| 117 | + }); |
| 118 | + |
| 119 | + it('should not update target if it is greater than es2020', async () => { |
| 120 | + const tsConfigPath = 'src/tsconfig.app.json'; |
| 121 | + tree.delete(tsConfigPath); |
| 122 | + createJsonFile(tree, tsConfigPath, { compilerOptions: { target: 'es2021' } }); |
| 123 | + const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise(); |
| 124 | + const { target } = readJsonFile(newTree, tsConfigPath).compilerOptions; |
| 125 | + expect(target).toBe('es2021'); |
| 126 | + }); |
| 127 | +}); |
0 commit comments