feat(add): Add examples to --help output (#1612)

Fixes #1608
lerna · Aug 28, 2018 · 2ab62c1 · 2ab62c1
1 parent bd948cc
commit 2ab62c1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/commands/add/README.md b/commands/add/README.md
@@ -36,6 +36,9 @@ Add the new package with an exact version (e.g., `1.0.1`) rather than the defaul
 ## Examples
 
 ```sh
+# Adds the module-1 package to the packages in the 'prefix-' prefixed folders
+lerna add module-1 packages/prefix-*
+
 # Install module-1 to module-2
 lerna add module-1 --scope=module-2
 

diff --git a/commands/add/command.js b/commands/add/command.js
@@ -32,7 +32,15 @@ exports.builder = yargs => {
         alias: "E",
         describe: "Save version exactly",
       },
-    });
+    })
+    .example(
+      "$0 add module-1 packages/prefix-*",
+      "Adds the module-1 package to the packages in the 'prefix-' prefixed folders"
+    )
+    .example("$0 add module-1 --scope=module-2", "Install module-1 to module-2")
+    .example("$0 add module-1 --scope=module-2 --dev", "Install module-1 to module-2 in devDependencies")
+    .example("$0 add module-1", "Install module-1 in all modules except module-1")
+    .example("$0 add babel-core", "Install babel-core in all modules");
 
   return filterable(yargs);
 };