feat(@angular-devkit/build-angular): add esbuild-based builder initial support for fileReplacements

clydin · dgp1130 · commit 1c527a9da5b5 · 2022-09-16T11:35:57.000-07:00
Support for the `fileReplacements` option from the Webpack-based builder has now been integrated into
the experimental esbuild-based browser application builder. The option will no longer be ignored during
builds. Only the officially supported form of the option (`replace`/`with` fields) is implemented.
diff --git a/packages/angular_devkit/build_angular/src/builders/browser-esbuild/compiler-plugin.ts b/packages/angular_devkit/build_angular/src/builders/browser-esbuild/compiler-plugin.ts
@@ -128,6 +128,7 @@ export function createCompilerPlugin(
     tsconfig: string;
     advancedOptimizations?: boolean;
     thirdPartySourcemaps?: boolean;
+    fileReplacements?: Record<string, string>;
   },
   styleOptions: BundleStylesheetOptions,
 ): Plugin {
@@ -256,6 +257,13 @@ export function createCompilerPlugin(
           return { content: contents };
         };
 
+        // Augment TypeScript Host for file replacements option
+        if (pluginOptions.fileReplacements) {
+          // Temporary deep import for file replacements support
+          const { augmentHostWithReplacements } = require('@ngtools/webpack/src/ivy/host');
+          augmentHostWithReplacements(host, pluginOptions.fileReplacements);
+        }
+
         // Create the Angular specific program that contains the Angular compiler
         const angularProgram = new compilerCli.NgtscProgram(rootNames, compilerOptions, host);
         const angularCompiler = angularProgram.compiler;
@@ -316,7 +324,9 @@ export function createCompilerPlugin(
         async (args) => {
           assert.ok(fileEmitter, 'Invalid plugin execution order');
 
-          const typescriptResult = await fileEmitter(args.path);
+          const typescriptResult = await fileEmitter(
+            pluginOptions.fileReplacements?.[args.path] ?? args.path,
+          );
           if (!typescriptResult) {
             // No TS result indicates the file is not part of the TypeScript program.
             // If allowJs is enabled and the file is JS then defer to the next load hook.
diff --git a/packages/angular_devkit/build_angular/src/builders/browser-esbuild/experimental-warnings.ts b/packages/angular_devkit/build_angular/src/builders/browser-esbuild/experimental-warnings.ts
@@ -13,7 +13,6 @@ const UNSUPPORTED_OPTIONS: Array<keyof BrowserBuilderOptions> = [
   'allowedCommonJsDependencies',
   'budgets',
   'extractLicenses',
-  'fileReplacements',
   'progress',
   'scripts',
   'statsJson',
diff --git a/packages/angular_devkit/build_angular/src/builders/browser-esbuild/index.ts b/packages/angular_devkit/build_angular/src/builders/browser-esbuild/index.ts
@@ -249,6 +249,17 @@ async function bundleCode(
   sourcemapOptions: SourceMapClass,
   tsconfig: string,
 ) {
+  let fileReplacements: Record<string, string> | undefined;
+  if (options.fileReplacements) {
+    for (const replacement of options.fileReplacements) {
+      fileReplacements ??= {};
+      fileReplacements[path.join(workspaceRoot, replacement.replace)] = path.join(
+        workspaceRoot,
+        replacement.with,
+      );
+    }
+  }
+
   return bundle({
     absWorkingDir: workspaceRoot,
     bundle: true,
@@ -288,6 +299,7 @@ async function bundleCode(
           thirdPartySourcemaps: sourcemapOptions.vendor,
           tsconfig,
           advancedOptimizations: options.buildOptimizer,
+          fileReplacements,
         },
         // Component stylesheet options
         {
diff --git a/packages/angular_devkit/build_angular/src/builders/browser-esbuild/schema.json b/packages/angular_devkit/build_angular/src/builders/browser-esbuild/schema.json
@@ -461,38 +461,19 @@
       ]
     },
     "fileReplacement": {
-      "oneOf": [
-        {
-          "type": "object",
-          "properties": {
-            "src": {
-              "type": "string",
-              "pattern": "\\.(([cm]?j|t)sx?|json)$"
-            },
-            "replaceWith": {
-              "type": "string",
-              "pattern": "\\.(([cm]?j|t)sx?|json)$"
-            }
-          },
-          "additionalProperties": false,
-          "required": ["src", "replaceWith"]
+      "type": "object",
+      "properties": {
+        "replace": {
+          "type": "string",
+          "pattern": "\\.(([cm]?j|t)sx?|json)$"
         },
-        {
-          "type": "object",
-          "properties": {
-            "replace": {
-              "type": "string",
-              "pattern": "\\.(([cm]?j|t)sx?|json)$"
-            },
-            "with": {
-              "type": "string",
-              "pattern": "\\.(([cm]?j|t)sx?|json)$"
-            }
-          },
-          "additionalProperties": false,
-          "required": ["replace", "with"]
+        "with": {
+          "type": "string",
+          "pattern": "\\.(([cm]?j|t)sx?|json)$"
         }
-      ]
+      },
+      "additionalProperties": false,
+      "required": ["replace", "with"]
     },
     "budget": {
       "type": "object",
