fix(migrations): avoid generating imports with forward slashes (#48993)

crisbeto · pkozlowski-opensource · commit bdbf21d04ba7 · 2023-02-08T15:19:59.000+01:00
We're using Node's `path` utilities to remap existing imports and create new ones which can yield paths with forward slash separators. These changes add some logic to ensure that we only generate forward slashes. PR Close #48993
diff --git a/packages/core/schematics/ng-generate/standalone-migration/index.ts b/packages/core/schematics/ng-generate/standalone-migration/index.ts
@@ -18,7 +18,7 @@ import {canMigrateFile, createProgramOptions} from '../../utils/typescript/compi
 import {pruneNgModules} from './prune-modules';
 import {toStandaloneBootstrap} from './standalone-bootstrap';
 import {toStandalone} from './to-standalone';
-import {ChangesByFile} from './util';
+import {ChangesByFile, normalizePath} from './util';
 
 enum MigrationMode {
   toStandalone = 'convert-to-standalone',
@@ -31,8 +31,6 @@ interface Options {
   mode: MigrationMode;
 }
 
-const normalizePath = (path: string): string => path.replace(/\\/g, '/');
-
 export default function(options: Options): Rule {
   return async (tree) => {
     const {buildPaths, testPaths} = await getProjectTsConfigPaths(tree);
diff --git a/packages/core/schematics/ng-generate/standalone-migration/util.ts b/packages/core/schematics/ng-generate/standalone-migration/util.ts
@@ -107,9 +107,16 @@ export class ChangeTracker {
   addImport(
       sourceFile: ts.SourceFile, symbolName: string, moduleName: string,
       alias: string|null = null): ts.Expression {
-    return this._importManager.addImportToSourceFile(
-        sourceFile, symbolName,
-        this._importRemapper ? this._importRemapper(moduleName) : moduleName, alias);
+    if (this._importRemapper) {
+      moduleName = this._importRemapper(moduleName);
+    }
+
+    // It's common for paths to be manipulated with Node's `path` utilties which
+    // can yield a path with back slashes. Normalize them since outputting such
+    // paths will also cause TS to escape the forward slashes.
+    moduleName = normalizePath(moduleName);
+
+    return this._importManager.addImportToSourceFile(sourceFile, symbolName, moduleName, alias);
   }
 
   /**
@@ -257,5 +264,11 @@ export function getRelativeImportPath(fromFile: string, toFile: string): string
     path = './' + path;
   }
 
-  return path;
+  // Using the Node utilities can yield paths with forward slashes on Windows.
+  return normalizePath(path);
+}
+
+/** Normalizes a path to use posix separators. */
+export function normalizePath(path: string): string {
+  return path.replace(/\\/g, '/');
 }
