dcee94b refactor(@angular-devkit/build-angular): split Webpack-specific functionality from i18n option creation

Author: Angular Builds

package.json

@@ -1,15 +1,15 @@
 {
   "name": "@angular-devkit/build-angular",
-  "version": "18.0.0-next.2+sha-03d0fca",
+  "version": "18.0.0-next.2+sha-dcee94b",
   "description": "Angular Webpack Build Facade",
   "main": "src/index.js",
   "typings": "src/index.d.ts",
   "builders": "builders.json",
   "dependencies": {
     "@ampproject/remapping": "2.3.0",
-    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#03d0fca",
-    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#03d0fca",
-    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#03d0fca",
+    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#dcee94b",
+    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#dcee94b",
+    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#dcee94b",
     "@babel/core": "7.24.4",
     "@babel/generator": "7.24.4",
     "@babel/helper-annotate-as-pure": "7.22.5",
@@ -20,7 +20,7 @@
     "@babel/preset-env": "7.24.4",
     "@babel/runtime": "7.24.4",
     "@discoveryjs/json-ext": "0.5.7",
-    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#03d0fca",
+    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#dcee94b",
     "@vitejs/plugin-basic-ssl": "1.1.0",
     "ansi-colors": "4.1.3",
     "autoprefixer": "10.4.19",

src/builders/dev-server/webpack-server.js

@@ -42,7 +42,7 @@ const service_worker_plugin_1 = require("../../tools/webpack/plugins/service-wor
 const stats_1 = require("../../tools/webpack/utils/stats");
 const utils_1 = require("../../utils");
 const color_1 = require("../../utils/color");
-const i18n_options_1 = require("../../utils/i18n-options");
+const i18n_webpack_1 = require("../../utils/i18n-webpack");
 const load_translations_1 = require("../../utils/load-translations");
 const package_chunk_sort_1 = require("../../utils/package-chunk-sort");
 const version_1 = require("../../utils/version");
@@ -266,7 +266,7 @@ async function setupLocalize(locale, i18n, browserOptions, webpackConfig, cacheO
             compiler.hooks.thisCompilation.tap('build-angular', (compilation) => {
                 if (i18n.shouldInline && i18nLoaderOptions.translation === undefined) {
                     // Reload translations
-                    (0, i18n_options_1.loadTranslations)(locale, localeDescription, context.workspaceRoot, loader, {
+                    (0, i18n_webpack_1.loadTranslations)(locale, localeDescription, context.workspaceRoot, loader, {
                         warn(message) {
                             (0, webpack_diagnostics_1.addWarning)(compilation, message);
                         },

src/utils/action-executor.d.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 import { InlineOptions } from './bundle-inline-options';
-import { I18nOptions } from './i18n-options';
+import { I18nOptions } from './i18n-webpack';
 export declare class BundleActionExecutor {
     private workerOptions;
     private workerPool?;

src/utils/i18n-inlining.d.ts

@@ -7,5 +7,5 @@
  */
 import { BuilderContext } from '@angular-devkit/architect';
 import { EmittedFiles } from '@angular-devkit/build-webpack';
-import { I18nOptions } from './i18n-options';
+import { I18nOptions } from './i18n-webpack';
 export declare function i18nInlineEmittedFiles(context: BuilderContext, emittedFiles: EmittedFiles[], i18n: I18nOptions, baseOutputPath: string, outputPaths: string[], scriptsEntryPointName: string[], emittedPath: string, missingTranslation: 'error' | 'warning' | 'ignore' | undefined): Promise<boolean>;

src/utils/i18n-options.d.ts

@@ -5,10 +5,7 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { BuilderContext } from '@angular-devkit/architect';
-import { Schema as BrowserBuilderSchema, I18NTranslation } from '../builders/browser/schema';
-import { Schema as ServerBuilderSchema } from '../builders/server/schema';
-import { TranslationLoader } from './load-translations';
+import type { TranslationLoader } from './load-translations';
 export interface LocaleDescription {
     files: {
         path: string;
@@ -30,11 +27,7 @@ export interface I18nOptions {
 export declare function createI18nOptions(projectMetadata: {
     i18n?: unknown;
 }, inline?: boolean | string[]): I18nOptions;
-export declare function configureI18nBuild<T extends BrowserBuilderSchema | ServerBuilderSchema>(context: BuilderContext, options: T): Promise<{
-    buildOptions: T;
-    i18n: I18nOptions;
-}>;
 export declare function loadTranslations(locale: string, desc: LocaleDescription, workspaceRoot: string, loader: TranslationLoader, logger: {
     warn: (message: string) => void;
     error: (message: string) => void;
-}, usedFormats?: Set<string>, duplicateTranslation?: I18NTranslation): void;
+}, usedFormats?: Set<string>, duplicateTranslation?: 'ignore' | 'error' | 'warning'): void;

src/utils/i18n-options.js

@@ -10,18 +10,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadTranslations = exports.configureI18nBuild = exports.createI18nOptions = void 0;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_module_1 = require("node:module");
-const node_os_1 = __importDefault(require("node:os"));
+exports.loadTranslations = exports.createI18nOptions = void 0;
 const node_path_1 = __importDefault(require("node:path"));
-const schema_1 = require("../builders/browser/schema");
-const read_tsconfig_1 = require("../utils/read-tsconfig");
-const load_translations_1 = require("./load-translations");
-/**
- * The base module location used to search for locale specific data.
- */
-const LOCALE_DATA_BASE_MODULE = '@angular/common/locales/global';
 function normalizeTranslationFileOption(option, locale, expectObjectInError) {
     if (typeof option === 'string') {
         return [option];
@@ -123,89 +113,6 @@ function createI18nOptions(projectMetadata, inline) {
     return i18n;
 }
 exports.createI18nOptions = createI18nOptions;
-async function configureI18nBuild(context, options) {
-    if (!context.target) {
-        throw new Error('The builder requires a target.');
-    }
-    const buildOptions = { ...options };
-    const tsConfig = await (0, read_tsconfig_1.readTsconfig)(buildOptions.tsConfig, context.workspaceRoot);
-    const metadata = await context.getProjectMetadata(context.target);
-    const i18n = createI18nOptions(metadata, buildOptions.localize);
-    // No additional processing needed if no inlining requested and no source locale defined.
-    if (!i18n.shouldInline && !i18n.hasDefinedSourceLocale) {
-        return { buildOptions, i18n };
-    }
-    const projectRoot = node_path_1.default.join(context.workspaceRoot, metadata.root || '');
-    // The trailing slash is required to signal that the path is a directory and not a file.
-    const projectRequire = (0, node_module_1.createRequire)(projectRoot + '/');
-    const localeResolver = (locale) => projectRequire.resolve(node_path_1.default.join(LOCALE_DATA_BASE_MODULE, locale));
-    // Load locale data and translations (if present)
-    let loader;
-    const usedFormats = new Set();
-    for (const [locale, desc] of Object.entries(i18n.locales)) {
-        if (!i18n.inlineLocales.has(locale) && locale !== i18n.sourceLocale) {
-            continue;
-        }
-        let localeDataPath = findLocaleDataPath(locale, localeResolver);
-        if (!localeDataPath) {
-            const [first] = locale.split('-');
-            if (first) {
-                localeDataPath = findLocaleDataPath(first.toLowerCase(), localeResolver);
-                if (localeDataPath) {
-                    context.logger.warn(`Locale data for '${locale}' cannot be found. Using locale data for '${first}'.`);
-                }
-            }
-        }
-        if (!localeDataPath) {
-            context.logger.warn(`Locale data for '${locale}' cannot be found. No locale data will be included for this locale.`);
-        }
-        else {
-            desc.dataPath = localeDataPath;
-        }
-        if (!desc.files.length) {
-            continue;
-        }
-        loader ??= await (0, load_translations_1.createTranslationLoader)();
-        loadTranslations(locale, desc, context.workspaceRoot, loader, {
-            warn(message) {
-                context.logger.warn(message);
-            },
-            error(message) {
-                throw new Error(message);
-            },
-        }, usedFormats, buildOptions.i18nDuplicateTranslation);
-        if (usedFormats.size > 1 && tsConfig.options.enableI18nLegacyMessageIdFormat !== false) {
-            // This limitation is only for legacy message id support (defaults to true as of 9.0)
-            throw new Error('Localization currently only supports using one type of translation file format for the entire application.');
-        }
-    }
-    // If inlining store the output in a temporary location to facilitate post-processing
-    if (i18n.shouldInline) {
-        // TODO: we should likely save these in the .angular directory in the next major version.
-        // We'd need to do a migration to add the temp directory to gitignore.
-        const tempPath = node_fs_1.default.mkdtempSync(node_path_1.default.join(node_fs_1.default.realpathSync(node_os_1.default.tmpdir()), 'angular-cli-i18n-'));
-        buildOptions.outputPath = tempPath;
-        process.on('exit', () => {
-            try {
-                node_fs_1.default.rmSync(tempPath, { force: true, recursive: true, maxRetries: 3 });
-            }
-            catch { }
-        });
-    }
-    return { buildOptions, i18n };
-}
-exports.configureI18nBuild = configureI18nBuild;
-function findLocaleDataPath(locale, resolver) {
-    // Remove private use subtags
-    const scrubbedLocale = locale.replace(/-x(-[a-zA-Z0-9]{1,8})+$/, '');
-    try {
-        return resolver(scrubbedLocale);
-    }
-    catch {
-        // fallback to known existing en-US locale data as of 14.0
-        return scrubbedLocale === 'en-US' ? findLocaleDataPath('en', resolver) : null;
-    }
-}
 function loadTranslations(locale, desc, workspaceRoot, loader, logger, usedFormats, duplicateTranslation) {
     let translations = undefined;
     for (const file of desc.files) {
@@ -230,12 +137,12 @@ function loadTranslations(locale, desc, workspaceRoot, loader, logger, usedForma
                 if (translations[id] !== undefined) {
                     const duplicateTranslationMessage = `[${file.path}]: Duplicate translations for message '${id}' when merging.`;
                     switch (duplicateTranslation) {
-                        case schema_1.I18NTranslation.Ignore:
+                        case 'ignore':
                             break;
-                        case schema_1.I18NTranslation.Error:
+                        case 'error':
                             logger.error(`ERROR ${duplicateTranslationMessage}`);
                             break;
-                        case schema_1.I18NTranslation.Warning:
+                        case 'warning':
                         default:
                             logger.warn(`WARNING ${duplicateTranslationMessage}`);
                             break;

src/utils/i18n-webpack.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { BuilderContext } from '@angular-devkit/architect';
+import { Schema as BrowserBuilderSchema } from '../builders/browser/schema';
+import { Schema as ServerBuilderSchema } from '../builders/server/schema';
+import { I18nOptions, loadTranslations } from './i18n-options';
+export { I18nOptions, loadTranslations };
+export declare function configureI18nBuild<T extends BrowserBuilderSchema | ServerBuilderSchema>(context: BuilderContext, options: T): Promise<{
+    buildOptions: T;
+    i18n: I18nOptions;
+}>;

src/utils/i18n-webpack.js

@@ -0,0 +1,108 @@
+"use strict";
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureI18nBuild = exports.loadTranslations = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_module_1 = require("node:module");
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const read_tsconfig_1 = require("../utils/read-tsconfig");
+const i18n_options_1 = require("./i18n-options");
+Object.defineProperty(exports, "loadTranslations", { enumerable: true, get: function () { return i18n_options_1.loadTranslations; } });
+const load_translations_1 = require("./load-translations");
+/**
+ * The base module location used to search for locale specific data.
+ */
+const LOCALE_DATA_BASE_MODULE = '@angular/common/locales/global';
+async function configureI18nBuild(context, options) {
+    if (!context.target) {
+        throw new Error('The builder requires a target.');
+    }
+    const buildOptions = { ...options };
+    const tsConfig = await (0, read_tsconfig_1.readTsconfig)(buildOptions.tsConfig, context.workspaceRoot);
+    const metadata = await context.getProjectMetadata(context.target);
+    const i18n = (0, i18n_options_1.createI18nOptions)(metadata, buildOptions.localize);
+    // No additional processing needed if no inlining requested and no source locale defined.
+    if (!i18n.shouldInline && !i18n.hasDefinedSourceLocale) {
+        return { buildOptions, i18n };
+    }
+    const projectRoot = node_path_1.default.join(context.workspaceRoot, metadata.root || '');
+    // The trailing slash is required to signal that the path is a directory and not a file.
+    const projectRequire = (0, node_module_1.createRequire)(projectRoot + '/');
+    const localeResolver = (locale) => projectRequire.resolve(node_path_1.default.join(LOCALE_DATA_BASE_MODULE, locale));
+    // Load locale data and translations (if present)
+    let loader;
+    const usedFormats = new Set();
+    for (const [locale, desc] of Object.entries(i18n.locales)) {
+        if (!i18n.inlineLocales.has(locale) && locale !== i18n.sourceLocale) {
+            continue;
+        }
+        let localeDataPath = findLocaleDataPath(locale, localeResolver);
+        if (!localeDataPath) {
+            const [first] = locale.split('-');
+            if (first) {
+                localeDataPath = findLocaleDataPath(first.toLowerCase(), localeResolver);
+                if (localeDataPath) {
+                    context.logger.warn(`Locale data for '${locale}' cannot be found. Using locale data for '${first}'.`);
+                }
+            }
+        }
+        if (!localeDataPath) {
+            context.logger.warn(`Locale data for '${locale}' cannot be found. No locale data will be included for this locale.`);
+        }
+        else {
+            desc.dataPath = localeDataPath;
+        }
+        if (!desc.files.length) {
+            continue;
+        }
+        loader ??= await (0, load_translations_1.createTranslationLoader)();
+        (0, i18n_options_1.loadTranslations)(locale, desc, context.workspaceRoot, loader, {
+            warn(message) {
+                context.logger.warn(message);
+            },
+            error(message) {
+                throw new Error(message);
+            },
+        }, usedFormats, buildOptions.i18nDuplicateTranslation);
+        if (usedFormats.size > 1 && tsConfig.options.enableI18nLegacyMessageIdFormat !== false) {
+            // This limitation is only for legacy message id support (defaults to true as of 9.0)
+            throw new Error('Localization currently only supports using one type of translation file format for the entire application.');
+        }
+    }
+    // If inlining store the output in a temporary location to facilitate post-processing
+    if (i18n.shouldInline) {
+        // TODO: we should likely save these in the .angular directory in the next major version.
+        // We'd need to do a migration to add the temp directory to gitignore.
+        const tempPath = node_fs_1.default.mkdtempSync(node_path_1.default.join(node_fs_1.default.realpathSync(node_os_1.default.tmpdir()), 'angular-cli-i18n-'));
+        buildOptions.outputPath = tempPath;
+        process.on('exit', () => {
+            try {
+                node_fs_1.default.rmSync(tempPath, { force: true, recursive: true, maxRetries: 3 });
+            }
+            catch { }
+        });
+    }
+    return { buildOptions, i18n };
+}
+exports.configureI18nBuild = configureI18nBuild;
+function findLocaleDataPath(locale, resolver) {
+    // Remove private use subtags
+    const scrubbedLocale = locale.replace(/-x(-[a-zA-Z0-9]{1,8})+$/, '');
+    try {
+        return resolver(scrubbedLocale);
+    }
+    catch {
+        // fallback to known existing en-US locale data as of 14.0
+        return scrubbedLocale === 'en-US' ? findLocaleDataPath('en', resolver) : null;
+    }
+}

src/utils/normalize-cache.js

@@ -10,7 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeCacheOptions = void 0;
 const node_path_1 = require("node:path");
 /** Version placeholder is replaced during the build process with actual package version */
-const VERSION = '18.0.0-next.2+sha-03d0fca';
+const VERSION = '18.0.0-next.2+sha-dcee94b';
 function hasCacheMetadata(value) {
     return (!!value &&
         typeof value === 'object' &&

src/utils/output-paths.d.ts

@@ -5,5 +5,5 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { I18nOptions } from './i18n-options';
+import { I18nOptions } from './i18n-webpack';
 export declare function ensureOutputPaths(baseOutputPath: string, i18n: I18nOptions): Map<string, string>;