refactor(@angular-devkit/build-angular): remove deprecated i18n options from server and browser builder

BREAKING CHANGE:

Removal of deprecated browser and server command options.
- `i18nFile`,  use `locales` object in the project metadata instead.
- `i18nFormat`, No longer needed as the format will be determined automatically.
- `i18nLocale`, use `localize` option instead.

Author: alan-agius4

packages/angular_devkit/build_angular/src/browser/index.ts

@@ -668,7 +668,7 @@ export function buildWebpackBrowser(
                       const { content, warnings, errors } = await indexHtmlGenerator.process({
                         baseHref: getLocaleBaseHref(i18n, locale) || options.baseHref,
                         // i18nLocale is used when Ivy is disabled
-                        lang: locale || options.i18nLocale,
+                        lang: locale || undefined,
                         outputPath,
                         files: mapEmittedFilesToFileInfo(files),
                         noModuleFiles: mapEmittedFilesToFileInfo(noModuleFiles),

packages/angular_devkit/build_angular/src/browser/schema.json

@@ -208,21 +208,6 @@
       "description": "Log progress to the console while building.",
       "default": true
     },
-    "i18nFile": {
-      "type": "string",
-      "description": "Localization file to use for i18n.",
-      "x-deprecated": "Use 'locales' object in the project metadata instead."
-    },
-    "i18nFormat": {
-      "type": "string",
-      "description": "Format of the localization file specified with --i18n-file.",
-      "x-deprecated": "No longer needed as the format will be determined automatically."
-    },
-    "i18nLocale": {
-      "type": "string",
-      "description": "Locale to use for i18n.",
-      "x-deprecated": "Use 'localize' instead."
-    },
     "i18nMissingTranslation": {
       "type": "string",
       "description": "How to handle missing translations for i18n.",

packages/angular_devkit/build_angular/src/dev-server/index.ts

@@ -218,10 +218,7 @@ export function serveWebpackBrowser(
     }
 
     let locale: string | undefined;
-    if (browserOptions.i18nLocale) {
-      // Deprecated VE option
-      locale = browserOptions.i18nLocale;
-    } else if (i18n.shouldInline) {
+    if (i18n.shouldInline) {
       // Dev-server only supports one locale
       locale = [...i18n.inlineLocales][0];
     } else if (i18n.hasDefinedSourceLocale) {

packages/angular_devkit/build_angular/src/extract-i18n/index.ts

@@ -167,9 +167,6 @@ export async function execute(
         vendor: true,
       },
       buildOptimizer: false,
-      i18nLocale: i18n.sourceLocale,
-      i18nFormat: format,
-      i18nFile: outFile,
       aot: true,
       progress: options.progress,
       assets: [],

packages/angular_devkit/build_angular/src/server/schema.json

@@ -120,21 +120,6 @@
       "description": "Log progress to the console while building.",
       "default": true
     },
-    "i18nFile": {
-      "type": "string",
-      "description": "Localization file to use for i18n.",
-      "x-deprecated": "Use 'locales' object in the project metadata instead."
-    },
-    "i18nFormat": {
-      "type": "string",
-      "description": "Format of the localization file specified with --i18n-file.",
-      "x-deprecated": "No longer needed as the format will be determined automatically."
-    },
-    "i18nLocale": {
-      "type": "string",
-      "description": "Locale to use for i18n.",
-      "x-deprecated": "Use 'localize' instead."
-    },
     "i18nMissingTranslation": {
       "type": "string",
       "description": "How to handle missing translations for i18n.",

packages/angular_devkit/build_angular/src/utils/build-options.ts

@@ -35,12 +35,6 @@ export interface BuildOptions {
   deployUrl?: string;
   verbose?: boolean;
   progress?: boolean;
-  /** @deprecated since version 9. Use 'locales' object in the project metadata instead.*/
-  i18nFile?: string;
-  /** @deprecated since version 9. No longer needed as the format will be determined automatically.*/
-  i18nFormat?: string;
-  /** @deprecated since version 9. Use 'localize' instead.*/
-  i18nLocale?: string;
   localize?: Localize;
   i18nMissingTranslation?: I18NMissingTranslation;
   /** @deprecated since version 11.0. No longer required to disable CSS extraction for HMR.*/

packages/angular_devkit/build_angular/src/utils/i18n-options.ts

@@ -30,7 +30,6 @@ export interface I18nOptions {
   >;
   flatOutput?: boolean;
   readonly shouldInline: boolean;
-  veCompatLocale?: string;
   hasDefinedSourceLocale?: boolean;
 }
 
@@ -160,50 +159,9 @@ export async function configureI18nBuild<T extends BrowserBuilderSchema | Server
 
   const buildOptions = { ...options };
   const tsConfig = readTsconfig(buildOptions.tsConfig, context.workspaceRoot);
-  const usingIvy = tsConfig.options.enableIvy !== false;
   const metadata = await context.getProjectMetadata(context.target);
   const i18n = createI18nOptions(metadata, buildOptions.localize);
 
-  // Until 11.0, support deprecated i18n options when not using new localize option
-  // i18nFormat is automatically calculated
-  if (buildOptions.localize === undefined && usingIvy) {
-    mergeDeprecatedI18nOptions(i18n, buildOptions.i18nLocale, buildOptions.i18nFile);
-  } else if (buildOptions.localize !== undefined && !usingIvy) {
-    if (
-      buildOptions.localize === true ||
-      (Array.isArray(buildOptions.localize) && buildOptions.localize.length > 1)
-    ) {
-      throw new Error(
-        `Localization with multiple locales in one build is not supported with View Engine.`,
-      );
-    }
-
-    for (const deprecatedOption of ['i18nLocale', 'i18nFormat', 'i18nFile']) {
-      // tslint:disable-next-line: no-any
-      if (typeof (buildOptions as any)[deprecatedOption] !== 'undefined') {
-        context.logger.warn(
-          `Option 'localize' and deprecated '${deprecatedOption}' found.  Using 'localize'.`,
-        );
-      }
-    }
-
-    if (
-      buildOptions.localize === false ||
-      (Array.isArray(buildOptions.localize) && buildOptions.localize.length === 0)
-    ) {
-      buildOptions.i18nFile = undefined;
-      buildOptions.i18nLocale = undefined;
-      buildOptions.i18nFormat = undefined;
-    }
-  }
-
-  // Clear deprecated options when using Ivy to prevent unintended behavior
-  if (usingIvy) {
-    buildOptions.i18nFile = undefined;
-    buildOptions.i18nFormat = undefined;
-    buildOptions.i18nLocale = undefined;
-  }
-
   // No additional processing needed if no inlining requested and no source locale defined.
   if (!i18n.shouldInline && !i18n.hasDefinedSourceLocale) {
     return { buildOptions, i18n };
@@ -298,31 +256,6 @@ export async function configureI18nBuild<T extends BrowserBuilderSchema | Server
         desc.translation = loadResult.translations;
       }
     }
-
-    // Legacy message id's require the format of the translations
-    if (usedFormats.size > 0) {
-      buildOptions.i18nFormat = [...usedFormats][0];
-    }
-
-    // Provide support for using the Ivy i18n options with VE
-    if (!usingIvy) {
-      i18n.veCompatLocale = buildOptions.i18nLocale = [...i18n.inlineLocales][0];
-
-      if (buildOptions.i18nLocale !== i18n.sourceLocale) {
-        if (i18n.locales[buildOptions.i18nLocale].files.length > 1) {
-          throw new Error(
-            'Localization with View Engine only supports using a single translation file per locale.',
-          );
-        }
-        buildOptions.i18nFile = i18n.locales[buildOptions.i18nLocale].files[0].path;
-      }
-
-      // Clear inline locales to prevent any new i18n related processing
-      i18n.inlineLocales.clear();
-
-      // Update the output path to include the locale to mimic Ivy localize behavior
-      buildOptions.outputPath = path.join(buildOptions.outputPath, buildOptions.i18nLocale);
-    }
   }
 
   // If inlining store the output in a temporary location to facilitate post-processing
@@ -341,34 +274,6 @@ export async function configureI18nBuild<T extends BrowserBuilderSchema | Server
   return { buildOptions, i18n };
 }
 
-function mergeDeprecatedI18nOptions(
-  i18n: I18nOptions,
-  i18nLocale: string | undefined,
-  i18nFile: string | undefined,
-): I18nOptions {
-  if (i18nFile !== undefined && i18nLocale === undefined) {
-    throw new Error(`Option 'i18nFile' cannot be used without the 'i18nLocale' option.`);
-  }
-
-  if (i18nLocale !== undefined) {
-    i18n.inlineLocales.clear();
-    i18n.inlineLocales.add(i18nLocale);
-
-    if (i18nFile !== undefined) {
-      i18n.locales[i18nLocale] = { files: [{ path: i18nFile }], baseHref: '' };
-    } else {
-      // If no file, treat the locale as the source locale
-      // This mimics deprecated behavior
-      i18n.sourceLocale = i18nLocale;
-      i18n.locales[i18nLocale] = { files: [], baseHref: '' };
-    }
-
-    i18n.flatOutput = true;
-  }
-
-  return i18n;
-}
-
 function findLocaleDataBasePath(projectRoot: string): string | null {
   try {
     const commonPath = path.dirname(

packages/angular_devkit/build_angular/src/utils/output-paths.ts

@@ -10,14 +10,9 @@ import { join } from 'path';
 import { I18nOptions } from './i18n-options';
 
 export function ensureOutputPaths(baseOutputPath: string, i18n: I18nOptions): Map<string, string> {
-  const outputPaths: [string, string][] =
-    i18n.shouldInline
-      ? [...i18n.inlineLocales].map(l => [l, i18n.flatOutput ? baseOutputPath : join(baseOutputPath, l)])
-      : [
-          i18n.veCompatLocale
-            ? [i18n.veCompatLocale, join(baseOutputPath, i18n.veCompatLocale)]
-            : ['', baseOutputPath],
-        ];
+  const outputPaths: [string, string][] = i18n.shouldInline
+    ? [...i18n.inlineLocales].map(l => [l, i18n.flatOutput ? baseOutputPath : join(baseOutputPath, l)])
+    : [['', baseOutputPath]];
 
   for (const [, outputPath] of outputPaths) {
     if (!existsSync(outputPath)) {

tests/legacy-cli/e2e/tests/i18n/ivy-localize-basehref.ts

@@ -8,7 +8,7 @@
 import { expectFileToMatch } from '../../utils/fs';
 import { ng } from '../../utils/process';
 import { updateJsonFile } from '../../utils/project';
-import { externalServer, langTranslations, setupI18nConfig } from './legacy';
+import { externalServer, langTranslations, setupI18nConfig } from './setup';
 
 const baseHrefs = {
   'en-US': '/en/',
@@ -18,7 +18,7 @@ const baseHrefs = {
 
 export default async function() {
   // Setup i18n tests and config.
-  await setupI18nConfig(true);
+  await setupI18nConfig();
 
   // Update angular.json
   await updateJsonFile('angular.json', workspaceJson => {

tests/legacy-cli/e2e/tests/i18n/ivy-localize-dl-arb.ts

@@ -1,9 +1,9 @@
 import { executeTest } from './ivy-localize-dl-xliff2';
-import { setupI18nConfig } from './legacy';
+import { setupI18nConfig } from './setup';
 
 export default async function() {
   // Setup i18n tests and config.
-  await setupI18nConfig(true, 'arb');
+  await setupI18nConfig('arb');
 
   // Execute the tests
   await executeTest();