fix(@angular/cli): allow schematic arguments named help

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

@@ -33,23 +33,41 @@ import {
 import { jsonHelpUsage } from './utilities/json-help';
 import { createNormalizeOptionsMiddleware } from './utilities/normalize-options-middleware';
 
-export async function runCommand(args: string[], logger: logging.Logger): Promise<number> {
+export function parseInitialCommandArguments(args: string[]) {
   const {
     $0,
     _,
-    help = false,
     dryRun = false,
     jsonHelp = false,
     getYargsCompletions = false,
     ...rest
   } = yargsParser(args, {
-    boolean: ['help', 'json-help', 'get-yargs-completions', 'dry-run'],
+    // Do not treat bare `help` as the help flag; it can be a schematic argument (e.g. `ng g m help`).
+    boolean: ['json-help', 'get-yargs-completions', 'dry-run'],
     alias: { 'collection': 'c' },
   });
 
+  const help =
+    jsonHelp || args.some((arg) => arg === '--help' || arg === '-h' || arg.startsWith('--help='));
+
   // When `getYargsCompletions` is true the scriptName 'ng' at index 0 is not removed.
   const positional = getYargsCompletions ? _.slice(1) : _;
 
+  return {
+    $0,
+    positional,
+    help,
+    dryRun,
+    jsonHelp,
+    getYargsCompletions,
+    rest,
+  };
+}
+
+export async function runCommand(args: string[], logger: logging.Logger): Promise<number> {
+  const { positional, help, dryRun, jsonHelp, getYargsCompletions, rest } =
+    parseInitialCommandArguments(args);
+
   let workspace: AngularWorkspace | undefined;
   let globalConfiguration: AngularWorkspace;
   try {

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

@@ -0,0 +1,38 @@
+/**
+ * @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.dev/license
+ */
+
+import { parseInitialCommandArguments } from './command-runner';
+
+describe('parseInitialCommandArguments', () => {
+  it('should not treat a schematic argument named help as the help flag', () => {
+    const { help, positional } = parseInitialCommandArguments(['generate', 'm', 'help']);
+
+    expect(help).toBeFalse();
+    expect(positional).toEqual(['generate', 'm', 'help']);
+  });
+
+  it('should treat --help as the help flag', () => {
+    const { help, positional } = parseInitialCommandArguments(['generate', 'm', '--help']);
+
+    expect(help).toBeTrue();
+    expect(positional).toEqual(['generate', 'm']);
+  });
+
+  it('should treat -h as the help flag', () => {
+    const { help } = parseInitialCommandArguments(['generate', '-h']);
+
+    expect(help).toBeTrue();
+  });
+
+  it('should treat --json-help as the help flag', () => {
+    const { help, jsonHelp } = parseInitialCommandArguments(['generate', '--json-help']);
+
+    expect(jsonHelp).toBeTrue();
+    expect(help).toBeTrue();
+  });
+});