refactor(@angular-devkit/architect-cli): replace parser with yargs-parser

BREAKING CHANGE: camel case arguments are no longer allowed.

Author: alan-agius4

package.json

@@ -104,7 +104,6 @@
     "@types/karma": "^6.3.0",
     "@types/loader-utils": "^2.0.0",
     "@types/minimatch": "3.0.5",
-    "@types/minimist": "^1.2.0",
     "@types/node": "~12.12.6",
     "@types/node-fetch": "^2.1.6",
     "@types/npm-package-arg": "^6.1.0",
@@ -168,7 +167,6 @@
     "magic-string": "0.25.7",
     "mini-css-extract-plugin": "2.5.3",
     "minimatch": "5.0.1",
-    "minimist": "^1.2.0",
     "ng-packagr": "14.0.0-next.1",
     "node-fetch": "^2.2.0",
     "npm-package-arg": "9.0.0",

packages/angular_devkit/architect_cli/BUILD.bazel

@@ -20,9 +20,9 @@ ts_library(
         "//packages/angular_devkit/architect/node",
         "//packages/angular_devkit/core",
         "//packages/angular_devkit/core/node",
-        "@npm//@types/minimist",
         "@npm//@types/node",
         "@npm//@types/progress",
+        "@npm//@types/yargs-parser",
         "@npm//ansi-colors",
         "@npm//rxjs",
     ],

packages/angular_devkit/architect_cli/bin/architect.ts

@@ -9,13 +9,13 @@
 
 import { Architect, BuilderInfo, BuilderProgressState, Target } from '@angular-devkit/architect';
 import { WorkspaceNodeModulesArchitectHost } from '@angular-devkit/architect/node';
-import { logging, schema, tags, workspaces } from '@angular-devkit/core';
+import { json, logging, schema, tags, workspaces } from '@angular-devkit/core';
 import { NodeJsSyncHost, createConsoleLogger } from '@angular-devkit/core/node';
 import * as ansiColors from 'ansi-colors';
 import { existsSync } from 'fs';
-import minimist from 'minimist';
 import * as path from 'path';
 import { tap } from 'rxjs/operators';
+import yargsParser from 'yargs-parser';
 import { MultiProgressBar } from '../src/progress';
 
 function findUp(names: string | string[], from: string) {
@@ -78,24 +78,43 @@ async function _executeTarget(
   parentLogger: logging.Logger,
   workspace: workspaces.WorkspaceDefinition,
   root: string,
-  argv: minimist.ParsedArgs,
+  argv: yargsParser.Arguments,
   registry: schema.SchemaRegistry,
 ) {
   const architectHost = new WorkspaceNodeModulesArchitectHost(workspace, root);
   const architect = new Architect(architectHost, registry);
 
   // Split a target into its parts.
-  const targetStr = argv._.shift() || '';
+  const {
+    _: [targetStr = ''],
+    help,
+    ...options
+  } = argv;
   const [project, target, configuration] = targetStr.split(':');
   const targetSpec = { project, target, configuration };
 
-  delete argv['help'];
   const logger = new logging.Logger('jobs');
   const logs: logging.LogEntry[] = [];
   logger.subscribe((entry) => logs.push({ ...entry, message: `${entry.name}: ` + entry.message }));
 
-  const { _, ...options } = argv;
-  const run = await architect.scheduleTarget(targetSpec, options, { logger });
+  // Camelize options as yargs will return the object in kebab-case when camel casing is disabled.
+
+  // Casting temporary until https://github.com/DefinitelyTyped/DefinitelyTyped/pull/59065 is merged and released.
+  const { camelCase, decamelize } = yargsParser as yargsParser.Parser & {
+    camelCase(str: string): string;
+    decamelize(str: string, joinString?: string): string;
+  };
+
+  const camelCasedOptions: json.JsonObject = {};
+  for (const [key, value] of Object.entries(options)) {
+    if (/[A-Z]/.test(key)) {
+      throw new Error(`Unknown argument ${key}. Did you mean ${decamelize(key)}?`);
+    }
+
+    camelCasedOptions[camelCase(key)] = value;
+  }
+
+  const run = await architect.scheduleTarget(targetSpec, camelCasedOptions, { logger });
   const bars = new MultiProgressBar<number, BarInfo>(':name :bar (:current/:total) :status');
 
   run.progress.subscribe((update) => {
@@ -107,7 +126,7 @@ async function _executeTarget(
       name: (
         (update.target ? _targetStringFromTarget(update.target) : update.builder.name) +
         ' '.repeat(80)
-      ).substr(0, 40),
+      ).substring(0, 40),
     };
 
     if (update.status !== undefined) {
@@ -175,7 +194,15 @@ async function _executeTarget(
 
 async function main(args: string[]): Promise<number> {
   /** Parse the command line. */
-  const argv = minimist(args, { boolean: ['help'] });
+  const argv = yargsParser(args, {
+    boolean: ['help'],
+    configuration: {
+      'dot-notation': false,
+      'boolean-negation': true,
+      'strip-aliased': true,
+      'camel-case-expansion': false,
+    },
+  });
 
   /** Create the DevKit Logger used through the CLI. */
   const logger = createConsoleLogger(argv['verbose'], process.stdout, process.stderr, {

packages/angular_devkit/architect_cli/package.json

@@ -17,10 +17,10 @@
     "@angular-devkit/architect": "0.0.0-EXPERIMENTAL-PLACEHOLDER",
     "@angular-devkit/core": "0.0.0-PLACEHOLDER",
     "ansi-colors": "4.1.1",
-    "minimist": "1.2.5",
     "progress": "2.0.3",
     "rxjs": "6.6.7",
-    "symbol-observable": "4.0.0"
+    "symbol-observable": "4.0.0",
+    "yargs-parser": "21.0.1"
   },
   "devDependencies": {
     "@types/progress": "2.0.5"

yarn.lock

@@ -1980,11 +1980,6 @@
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.5.tgz#1001cc5e6a3704b83c236027e77f2f58ea010f40"
   integrity sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ==
 
-"@types/minimist@^1.2.0":
-  version "1.2.2"
-  resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.2.tgz#ee771e2ba4b3dc5b372935d549fd9617bf345b8c"
-  integrity sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ==
-
 "@types/ms@*":
   version "0.7.31"
   resolved "https://registry.yarnpkg.com/@types/ms/-/ms-0.7.31.tgz#31b7ca6407128a3d2bbc27fe2d21b345397f6197"
@@ -7125,7 +7120,7 @@ minimatch@~3.0.4:
   dependencies:
     brace-expansion "^1.1.7"
 
-minimist@1.2.5, minimist@^1.1.3, minimist@^1.2.0, minimist@^1.2.5:
+minimist@^1.1.3, minimist@^1.2.0, minimist@^1.2.5:
   version "1.2.5"
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
   integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==