|
| 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.dev/license |
| 7 | + */ |
| 8 | + |
| 9 | +import ts from 'typescript'; |
| 10 | +import { |
| 11 | + confirmAsSerializable, |
| 12 | + ProgramInfo, |
| 13 | + projectFile, |
| 14 | + ProjectFile, |
| 15 | + ProjectFileID, |
| 16 | + Replacement, |
| 17 | + Serializable, |
| 18 | + TextUpdate, |
| 19 | + TsurgeFunnelMigration, |
| 20 | +} from '../../utils/tsurge'; |
| 21 | +import { |
| 22 | + migrateNgStyleBindings, |
| 23 | + calculateImportReplacements, |
| 24 | + createNgStyleImportsArrayRemoval, |
| 25 | +} from './util'; |
| 26 | +import {AbsoluteFsPath} from '@angular/compiler-cli'; |
| 27 | +import {NgComponentTemplateVisitor} from '../../utils/ng_component_template'; |
| 28 | +import {MigrationConfig} from './types'; |
| 29 | + |
| 30 | +export interface NgStyleMigrationData { |
| 31 | + file: ProjectFile; |
| 32 | + replacementCount: number; |
| 33 | + replacements: Replacement[]; |
| 34 | +} |
| 35 | + |
| 36 | +export interface NgStyleCompilationUnitData { |
| 37 | + ngStyleReplacements: Array<NgStyleMigrationData>; |
| 38 | + importReplacements: Record<ProjectFileID, {add: Replacement[]; addAndRemove: Replacement[]}>; |
| 39 | +} |
| 40 | + |
| 41 | +export class NgStyleMigration extends TsurgeFunnelMigration< |
| 42 | + NgStyleCompilationUnitData, |
| 43 | + NgStyleCompilationUnitData |
| 44 | +> { |
| 45 | + constructor(private readonly config: MigrationConfig = {}) { |
| 46 | + super(); |
| 47 | + } |
| 48 | + |
| 49 | + override async analyze(info: ProgramInfo): Promise<Serializable<NgStyleCompilationUnitData>> { |
| 50 | + const {sourceFiles, program} = info; |
| 51 | + const typeChecker = program.getTypeChecker(); |
| 52 | + const ngStyleReplacements: Array<NgStyleMigrationData> = []; |
| 53 | + const filesWithNgStyleDeclarations = new Set<ts.SourceFile>(); |
| 54 | + |
| 55 | + for (const sf of sourceFiles) { |
| 56 | + ts.forEachChild(sf, (node: ts.Node) => { |
| 57 | + if (!ts.isClassDeclaration(node)) { |
| 58 | + return; |
| 59 | + } |
| 60 | + |
| 61 | + const file = projectFile(sf, info); |
| 62 | + |
| 63 | + if (this.config.shouldMigrate && !this.config.shouldMigrate(file)) { |
| 64 | + return; |
| 65 | + } |
| 66 | + |
| 67 | + const templateVisitor = new NgComponentTemplateVisitor(typeChecker); |
| 68 | + templateVisitor.visitNode(node); |
| 69 | + |
| 70 | + const replacementsForStyle: Replacement[] = []; |
| 71 | + let replacementCountForStyle = 0; |
| 72 | + |
| 73 | + templateVisitor.resolvedTemplates.forEach((template) => { |
| 74 | + const {migrated, changed, replacementCount} = migrateNgStyleBindings( |
| 75 | + template.content, |
| 76 | + this.config, |
| 77 | + node, |
| 78 | + typeChecker, |
| 79 | + ); |
| 80 | + |
| 81 | + if (!changed) { |
| 82 | + return; |
| 83 | + } |
| 84 | + |
| 85 | + replacementCountForStyle += replacementCount; |
| 86 | + |
| 87 | + const fileToMigrate = template.inline |
| 88 | + ? file |
| 89 | + : projectFile(template.filePath as AbsoluteFsPath, info); |
| 90 | + const end = template.start + template.content.length; |
| 91 | + |
| 92 | + replacementsForStyle.push( |
| 93 | + prepareTextReplacement(fileToMigrate, migrated, template.start, end), |
| 94 | + ); |
| 95 | + }); |
| 96 | + |
| 97 | + if (replacementCountForStyle === 0) { |
| 98 | + return; |
| 99 | + } |
| 100 | + |
| 101 | + filesWithNgStyleDeclarations.add(sf); |
| 102 | + |
| 103 | + const importArrayRemoval = createNgStyleImportsArrayRemoval(node, file, typeChecker); |
| 104 | + if (importArrayRemoval) { |
| 105 | + replacementsForStyle.push(importArrayRemoval); |
| 106 | + } |
| 107 | + |
| 108 | + const existing = ngStyleReplacements.find((entry) => entry.file === file); |
| 109 | + if (existing) { |
| 110 | + existing.replacements.push(...replacementsForStyle); |
| 111 | + existing.replacementCount += replacementCountForStyle; |
| 112 | + } else { |
| 113 | + ngStyleReplacements.push({ |
| 114 | + file, |
| 115 | + replacements: replacementsForStyle, |
| 116 | + replacementCount: replacementCountForStyle, |
| 117 | + }); |
| 118 | + } |
| 119 | + }); |
| 120 | + } |
| 121 | + |
| 122 | + const importReplacements = calculateImportReplacements(info, filesWithNgStyleDeclarations); |
| 123 | + return confirmAsSerializable({ngStyleReplacements, importReplacements}); |
| 124 | + } |
| 125 | + |
| 126 | + override async combine( |
| 127 | + unitA: NgStyleCompilationUnitData, |
| 128 | + unitB: NgStyleCompilationUnitData, |
| 129 | + ): Promise<Serializable<NgStyleCompilationUnitData>> { |
| 130 | + const importReplacements: Record< |
| 131 | + ProjectFileID, |
| 132 | + {add: Replacement[]; addAndRemove: Replacement[]} |
| 133 | + > = {}; |
| 134 | + |
| 135 | + for (const unit of [unitA, unitB]) { |
| 136 | + for (const fileIDStr of Object.keys(unit.importReplacements)) { |
| 137 | + const fileID = fileIDStr as ProjectFileID; |
| 138 | + importReplacements[fileID] = unit.importReplacements[fileID]; |
| 139 | + } |
| 140 | + } |
| 141 | + |
| 142 | + return confirmAsSerializable({ |
| 143 | + ngStyleReplacements: [...unitA.ngStyleReplacements, ...unitB.ngStyleReplacements], |
| 144 | + importReplacements, |
| 145 | + }); |
| 146 | + } |
| 147 | + |
| 148 | + override async globalMeta( |
| 149 | + combinedData: NgStyleCompilationUnitData, |
| 150 | + ): Promise<Serializable<NgStyleCompilationUnitData>> { |
| 151 | + return confirmAsSerializable({ |
| 152 | + ngStyleReplacements: combinedData.ngStyleReplacements, |
| 153 | + importReplacements: combinedData.importReplacements, |
| 154 | + }); |
| 155 | + } |
| 156 | + |
| 157 | + override async stats(globalMetadata: NgStyleCompilationUnitData) { |
| 158 | + const touchedFilesCount = globalMetadata.ngStyleReplacements.length; |
| 159 | + const replacementCount = globalMetadata.ngStyleReplacements.reduce( |
| 160 | + (acc, cur) => acc + cur.replacementCount, |
| 161 | + 0, |
| 162 | + ); |
| 163 | + |
| 164 | + return confirmAsSerializable({ |
| 165 | + touchedFilesCount, |
| 166 | + replacementCount, |
| 167 | + }); |
| 168 | + } |
| 169 | + |
| 170 | + override async migrate(globalData: NgStyleCompilationUnitData) { |
| 171 | + const replacements: Replacement[] = []; |
| 172 | + |
| 173 | + replacements.push(...globalData.ngStyleReplacements.flatMap(({replacements}) => replacements)); |
| 174 | + |
| 175 | + for (const fileIDStr of Object.keys(globalData.importReplacements)) { |
| 176 | + const fileID = fileIDStr as ProjectFileID; |
| 177 | + const importReplacements = globalData.importReplacements[fileID]; |
| 178 | + replacements.push(...importReplacements.addAndRemove); |
| 179 | + } |
| 180 | + |
| 181 | + return {replacements}; |
| 182 | + } |
| 183 | +} |
| 184 | + |
| 185 | +function prepareTextReplacement( |
| 186 | + file: ProjectFile, |
| 187 | + replacement: string, |
| 188 | + start: number, |
| 189 | + end: number, |
| 190 | +): Replacement { |
| 191 | + return new Replacement( |
| 192 | + file, |
| 193 | + new TextUpdate({ |
| 194 | + position: start, |
| 195 | + end: end, |
| 196 | + toInsert: replacement, |
| 197 | + }), |
| 198 | + ); |
| 199 | +} |
0 commit comments