build: update dependency yargs to v18

See associated pull request for more information.

Closes #30399 as a pr takeover

Author: alan-agius4

packages/angular/cli/package.json

@@ -37,7 +37,7 @@
     "pacote": "21.0.0",
     "resolve": "1.22.10",
     "semver": "7.7.2",
-    "yargs": "17.7.2"
+    "yargs": "18.0.0"
   },
   "ng-update": {
     "migrations": "@schematics/angular/migrations/migration-collection.json",

packages/angular/cli/src/command-builder/command-runner.ts

@@ -27,7 +27,7 @@ import {
   demandCommandFailureMessage,
 } from './utilities/command';
 import { jsonHelpUsage } from './utilities/json-help';
-import { normalizeOptionsMiddleware } from './utilities/normalize-options-middleware';
+import { createNormalizeOptionsMiddleware } from './utilities/normalize-options-middleware';
 
 const yargsParser = Parser as unknown as typeof Parser.default;
 
@@ -88,7 +88,7 @@ export async function runCommand(args: string[], logger: logging.Logger): Promis
   if (jsonHelp) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const usageInstance = (localYargs as any).getInternalMethods().getUsageInstance();
-    usageInstance.help = () => jsonHelpUsage();
+    usageInstance.help = () => jsonHelpUsage(localYargs);
   }
 
   // Add default command to support version option when no subcommand is specified
@@ -127,7 +127,7 @@ export async function runCommand(args: string[], logger: logging.Logger): Promis
     .epilogue('For more information, see https://angular.dev/cli/.\n')
     .demandCommand(1, demandCommandFailureMessage)
     .recommendCommands()
-    .middleware(normalizeOptionsMiddleware)
+    .middleware(createNormalizeOptionsMiddleware(localYargs))
     .version(false)
     .showHelpOnFail(false)
     .strict()

packages/angular/cli/src/command-builder/utilities/json-help.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import yargs from 'yargs';
+import { Argv } from 'yargs';
 import { FullDescribe } from '../command-module';
 
 interface JsonHelpOption {
@@ -42,9 +42,9 @@ export interface JsonHelp extends JsonHelpDescription {
 
 const yargsDefaultCommandRegExp = /^\$0|\*/;
 
-export function jsonHelpUsage(): string {
+export function jsonHelpUsage(localYargs: Argv): string {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const localYargs = yargs as any;
+  const localYargsInstance = localYargs as any;
   const {
     deprecatedOptions,
     alias: aliases,
@@ -56,13 +56,13 @@ export function jsonHelpUsage(): string {
     demandedOptions,
     default: defaultVal,
     hiddenOptions = [],
-  } = localYargs.getOptions();
+  } = localYargsInstance.getOptions();
 
-  const internalMethods = localYargs.getInternalMethods();
+  const internalMethods = localYargsInstance.getInternalMethods();
   const usageInstance = internalMethods.getUsageInstance();
   const context = internalMethods.getContext();
   const descriptions = usageInstance.getDescriptions();
-  const groups = localYargs.getGroups();
+  const groups = localYargsInstance.getGroups();
   const positional = groups[usageInstance.getPositionalGroupName()] as string[] | undefined;
 
   const hidden = new Set(hiddenOptions);
@@ -124,7 +124,7 @@ export function jsonHelpUsage(): string {
 
   const output: JsonHelp = {
     name: [...context.commands].pop(),
-    command: `${command?.replace(yargsDefaultCommandRegExp, localYargs['$0'])}${defaultSubCommand}`,
+    command: `${command?.replace(yargsDefaultCommandRegExp, localYargsInstance['$0'])}${defaultSubCommand}`,
     ...parseDescription(rawDescription),
     options: normalizeOptions.sort((a, b) => a.name.localeCompare(b.name)),
     subcommands: otherSubcommands.length ? otherSubcommands : undefined,

packages/angular/cli/src/command-builder/utilities/normalize-options-middleware.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import * as yargs from 'yargs';
+import type { Arguments, Argv } from 'yargs';
 
 /**
  * A Yargs middleware that normalizes non Array options when the argument has been provided multiple times.
@@ -17,21 +17,23 @@ import * as yargs from 'yargs';
  *
  * See: https://github.com/yargs/yargs-parser/pull/163#issuecomment-516566614
  */
-export function normalizeOptionsMiddleware(args: yargs.Arguments): void {
-  // `getOptions` is not included in the types even though it's public API.
-  // https://github.com/yargs/yargs/issues/2098
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const { array } = (yargs as any).getOptions();
-  const arrayOptions = new Set(array);
+export function createNormalizeOptionsMiddleware(localeYargs: Argv): (args: Arguments) => void {
+  return (args: Arguments) => {
+    // `getOptions` is not included in the types even though it's public API.
+    // https://github.com/yargs/yargs/issues/2098
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const { array } = (localeYargs as any).getOptions();
+    const arrayOptions = new Set(array);
 
-  for (const [key, value] of Object.entries(args)) {
-    if (key !== '_' && Array.isArray(value) && !arrayOptions.has(key)) {
-      const newValue = value.pop();
-      // eslint-disable-next-line no-console
-      console.warn(
-        `Option '${key}' has been specified multiple times. The value '${newValue}' will be used.`,
-      );
-      args[key] = newValue;
+    for (const [key, value] of Object.entries(args)) {
+      if (key !== '_' && Array.isArray(value) && !arrayOptions.has(key)) {
+        const newValue = value.pop();
+        // eslint-disable-next-line no-console
+        console.warn(
+          `Option '${key}' has been specified multiple times. The value '${newValue}' will be used.`,
+        );
+        args[key] = newValue;
+      }
     }
-  }
+  };
 }

packages/angular/cli/src/commands/completion/cli.ts

@@ -7,7 +7,7 @@
  */
 
 import { join } from 'node:path';
-import yargs, { Argv } from 'yargs';
+import { Argv } from 'yargs';
 import { CommandModule, CommandModuleImplementation } from '../../command-builder/command-module';
 import { addCommandModuleToYargs } from '../../command-builder/utilities/command';
 import { colors } from '../../utilities/color';
@@ -64,11 +64,13 @@ class CompletionScriptCommandModule extends CommandModule implements CommandModu
   describe = 'Generate a bash and zsh real-time type-ahead autocompletion script.';
   longDescriptionPath = undefined;
 
+  private localYargs: Argv | undefined;
+
   builder(localYargs: Argv): Argv {
-    return localYargs;
+    return (this.localYargs = localYargs);
   }
 
   run(): void {
-    yargs.showCompletionScript();
+    this.localYargs?.showCompletionScript();
   }
 }