feat: add shorthand conc (#358)

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
open-cli-tools · Aug 22, 2022 · e469c04 · e469c04
1 parent 71e1c56
commit e469c04
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,9 @@ npm install concurrently --save
 
 ## Usage
 
+> **Note**
+> The `concurrently` command is now also available under the shorthand alias `conc`.
+
 Remember to surround separate commands with quotes:
 
 ```bash
@@ -149,8 +152,8 @@ General
                                template.
                                Example names: "main,browser,server"     [string]
       --name-separator         The character to split <names> on. Example usage:
-                               concurrently -n "styles|scripts|server"
-                               --name-separator "|"               [default: ","]
+                               -n "styles|scripts|server" --name-separator "|"
+                                                                  [default: ","]
   -s, --success                Which command(s) must exit with code 0 in order
                                for concurrently exit with code 0 too. Options
                                are:

diff --git a/bin/concurrently.ts b/bin/concurrently.ts
@@ -43,7 +43,7 @@ const args = yargs(argsBeforeSep)
         'name-separator': {
             describe:
                 'The character to split <names> on. Example usage:\n' +
-                'concurrently -n "styles|scripts|server" --name-separator "|"',
+                '-n "styles|scripts|server" --name-separator "|"',
             default: defaults.nameSeparator,
         },
         success: {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6,7 +6,8 @@
   "types": "dist/src/index.d.ts",
   "type": "commonjs",
   "bin": {
-    "concurrently": "./dist/bin/concurrently.js"
+    "concurrently": "./dist/bin/concurrently.js",
+    "conc": "./dist/bin/concurrently.js"
   },
   "engines": {
     "node": "^12.20.0 || ^14.13.0 || >=16.0.0"