feat(cli): Upgrade to Yargs 12

It is no longer necessary to specify `default: undefined` for boolean options, as those keys are no longer automatically assigned to the parsed argv regardless of presence in process.argv.
lerna · Jul 16, 2018 · 7899ab8 · 7899ab8
1 parent 2d2ab8d
commit 7899ab8
Show file tree

Hide file tree

Showing 16 changed files with 262 additions and 87 deletions.
diff --git a/commands/bootstrap/command.js b/commands/bootstrap/command.js
@@ -35,7 +35,6 @@ exports.builder = yargs => {
         group: "Command Options:",
         describe: "Don't run lifecycle scripts in bootstrapped packages",
         type: "boolean",
-        default: undefined,
       },
       "npm-client": {
         group: "Command Options:",

diff --git a/commands/changed/command.js b/commands/changed/command.js
@@ -17,7 +17,6 @@ exports.builder = yargs =>
       describe: "Show information in JSON format",
       group: "Command Options:",
       type: "boolean",
-      default: undefined,
     },
   });
 

diff --git a/commands/clean/command.js b/commands/clean/command.js
@@ -14,6 +14,7 @@ exports.builder = yargs => {
     yes: {
       group: "Command Options:",
       describe: "Skip all confirmation prompts",
+      type: "boolean",
     },
   });
 

diff --git a/commands/create/command.js b/commands/create/command.js
@@ -42,7 +42,7 @@ exports.builder = yargs => {
       "es-module": {
         group: "Command Options:",
         describe: "Initialize a transpiled ES Module",
-        // type: "boolean",
+        type: "boolean",
       },
       homepage: {
         group: "Command Options:",
@@ -63,7 +63,7 @@ exports.builder = yargs => {
       private: {
         group: "Command Options:",
         describe: "Make the new package private, never published to any external registry",
-        // type: "boolean",
+        type: "boolean",
       },
       registry: {
         group: "Command Options:",
@@ -78,7 +78,7 @@ exports.builder = yargs => {
       yes: {
         group: "Command Options:",
         describe: "Skip all prompts, accepting default values",
-        // type: "boolean",
+        type: "boolean",
       },
     });
 

diff --git a/commands/exec/command.js b/commands/exec/command.js
@@ -25,30 +25,26 @@ exports.builder = yargs => {
       bail: {
         group: "Command Options:",
         describe: "Stop when the command fails in a package.\nPass --no-bail to continue despite failure.",
-        defaultDescription: "true",
+        default: true,
         type: "boolean",
-        default: undefined,
       },
       stream: {
         group: "Command Options:",
         describe: "Stream output with lines prefixed by package.",
         type: "boolean",
-        default: undefined,
       },
       parallel: {
         group: "Command Options:",
         describe: "Run command in all packages with unlimited concurrency, streaming prefixed output",
         type: "boolean",
-        default: undefined,
       },
       // This option controls prefix for stream output so that it can be disabled to be friendly
       // to tools like Visual Studio Code to highlight the raw results
       prefix: {
         group: "Command Options:",
         describe: "Pass --no-prefix to disable prefixing of streamed output.",
-        defaultDescription: "true",
+        default: true,
         type: "boolean",
-        default: undefined,
       },
     });
 

diff --git a/commands/import/command.js b/commands/import/command.js
@@ -14,10 +14,12 @@ exports.builder = yargs =>
       flatten: {
         group: "Command Options:",
         describe: "Import each merge commit as a single change the merge introduced",
+        type: "boolean",
       },
       yes: {
         group: "Command Options:",
         describe: "Skip all confirmation prompts",
+        type: "boolean",
       },
     });
 

diff --git a/commands/init/command.js b/commands/init/command.js
@@ -11,13 +11,11 @@ exports.builder = {
   exact: {
     describe: "Specify lerna dependency version in package.json without a caret (^)",
     type: "boolean",
-    default: undefined,
   },
   independent: {
     describe: "Version packages independently",
     alias: "i",
     type: "boolean",
-    default: undefined,
   },
 };
 

diff --git a/commands/link/command.js b/commands/link/command.js
@@ -13,7 +13,6 @@ exports.builder = yargs => {
       group: "Command Options:",
       describe: "Force local sibling links regardless of version range match",
       type: "boolean",
-      default: undefined,
     },
   });
 

diff --git a/commands/list/command.js b/commands/list/command.js
@@ -17,7 +17,6 @@ exports.builder = yargs => {
       group: "Command Options:",
       describe: "Show information in JSON format",
       type: "boolean",
-      default: undefined,
     },
   });
 

diff --git a/commands/publish/command.js b/commands/publish/command.js
@@ -40,17 +40,14 @@ exports.builder = yargs => {
     "conventional-commits": {
       describe: "Use angular conventional-commit format to determine version bump and generate CHANGELOG.",
       type: "boolean",
-      default: undefined,
     },
     "changelog-preset": {
       describe: "Use another conventional-changelog preset rather than angular.",
       type: "string",
-      default: undefined,
     },
     exact: {
       describe: "Specify cross-dependency version numbers exactly rather than with a caret (^).",
       type: "boolean",
-      default: undefined,
     },
     "git-remote": {
       defaultDescription: "origin",
@@ -71,7 +68,6 @@ exports.builder = yargs => {
     amend: {
       describe: "Amend the existing commit, instead of generating a new one.",
       type: "boolean",
-      default: false,
     },
     "npm-tag": {
       describe: "Publish packages with the specified npm dist-tag",
@@ -101,22 +97,18 @@ exports.builder = yargs => {
     "skip-git": {
       describe: "Skip commiting, tagging, and pushing git changes.",
       type: "boolean",
-      default: undefined,
     },
     "skip-npm": {
       describe: "Stop before actually publishing change to npm.",
       type: "boolean",
-      default: undefined,
     },
     "temp-tag": {
       describe: "Create a temporary tag while publishing.",
       type: "boolean",
-      default: undefined,
     },
     yes: {
       describe: "Skip all confirmation prompts.",
       type: "boolean",
-      default: undefined,
     },
   };
 

diff --git a/commands/run/command.js b/commands/run/command.js
@@ -20,30 +20,26 @@ exports.builder = yargs => {
       bail: {
         group: "Command Options:",
         describe: "Stop when the script fails in a package.\nPass --no-bail to continue despite failure.",
-        defaultDescription: "true",
+        default: true,
         type: "boolean",
-        default: undefined,
       },
       stream: {
         group: "Command Options:",
         describe: "Stream output with lines prefixed by package.",
         type: "boolean",
-        default: undefined,
       },
       parallel: {
         group: "Command Options:",
         describe: "Run script in all packages with unlimited concurrency, streaming prefixed output.",
         type: "boolean",
-        default: undefined,
       },
       // This option controls prefix for stream output so that it can be disabled to be friendly
       // to tools like Visual Studio Code to highlight the raw results
       prefix: {
         group: "Command Options:",
         describe: "Pass --no-prefix to disable prefixing of streamed output.",
-        defaultDescription: "true",
+        default: true,
         type: "boolean",
-        default: undefined,
       },
       "npm-client": {
         group: "Command Options:",

diff --git a/core/cli/package.json b/core/cli/package.json
@@ -50,6 +50,6 @@
     "dedent": "^0.7.0",
     "is-ci": "^1.0.10",
     "npmlog": "^4.1.2",
-    "yargs": "^11.0.0"
+    "yargs": "^12.0.1"
   }
 }
diff --git a/core/filter-options/index.js b/core/filter-options/index.js
@@ -32,14 +32,14 @@ function filterOptions(yargs) {
         Include all transitive dependents when running a command
         regardless of --scope, --ignore, or --since.
       `,
-      boolean: true,
+      type: "boolean",
     },
     "include-filtered-dependencies": {
       describe: dedent`
         Include all transitive dependencies when running a command
         regardless of --scope, --ignore, or --since.
       `,
-      boolean: true,
+      type: "boolean",
     },
   };
 

diff --git a/core/global-options/index.js b/core/global-options/index.js
@@ -18,22 +18,19 @@ function globalOptions(yargs) {
     "reject-cycles": {
       describe: "Fail if a cycle is detected among dependencies.",
       type: "boolean",
-      default: undefined,
     },
     progress: {
       defaultDescription: "true",
       describe: "Enable progress bars. Pass --no-progress to disable. (Always off in CI)",
       type: "boolean",
-      default: undefined,
     },
     sort: {
       defaultDescription: "true",
       describe: "Sort packages topologically (all dependencies before dependents).",
       type: "boolean",
-      default: undefined,
     },
     "max-buffer": {
-      describe: "Set max-buffer(bytes) for Command execution",
+      describe: "Set max-buffer (in bytes) for subcommand execution",
       type: "number",
       requiresArg: true,
     },

diff --git a/helpers/command-runner/package.json b/helpers/command-runner/package.json
@@ -7,6 +7,6 @@
   "license": "MIT",
   "dependencies": {
     "@lerna/global-options": "file:../../core/global-options",
-    "yargs": "^11.0.0"
+    "yargs": "^12.0.1"
   }
 }