Improve examples for the --passthrough-arguments parameter (#480)

open-cli-tools · Jun 5, 2024 · 3dc909a · 3dc909a
1 parent 04b7d4a
commit 3dc909a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -296,14 +296,17 @@ Examples:
  - Passthrough some additional arguments via '{<number>}' placeholder
 
      $ concurrently -P "echo {1}" -- foo
+     # Results in: echo foo
 
  - Passthrough all additional arguments via '{@}' placeholder
 
      $ concurrently -P "npm:dev-* -- {@}" -- --watch --noEmit
+     # Results in something like: npm run dev-example -- --watch --noEmit
 
- - Passthrough all additional arguments combined via '{*}' placeholder
+ - Passthrough all additional arguments combined into one argument via '{*}' placeholder
 
-     $ concurrently -P "npm:dev-* -- {*}" -- --watch --noEmit
+     $ concurrently -P "echo {*}" -- foo bar
+     # Results in: echo 'foo bar'
 
 For more details, visit https://github.com/open-cli-tools/concurrently
 ```

diff --git a/bin/epilogue.ts b/bin/epilogue.ts
@@ -61,15 +61,19 @@ const examples = [
     },
     {
         description: "Passthrough some additional arguments via '{<number>}' placeholder",
-        example: '$ $0 -P "echo {1}" -- foo',
+        example: ['$ $0 -P "echo {1}" -- foo bar', '# Results in: echo foo'].join('\n'),
     },
     {
         description: "Passthrough all additional arguments via '{@}' placeholder",
-        example: '$ $0 -P "npm:dev-* -- {@}" -- --watch --noEmit',
+        example: [
+            '$ $0 -P "npm:dev-* -- {@}" -- --watch --noEmit',
+            '# Results in something like: npm run dev-example -- --watch --noEmit',
+        ].join('\n'),
     },
     {
-        description: "Passthrough all additional arguments combined via '{*}' placeholder",
-        example: '$ $0 -P "npm:dev-* -- {*}" -- --watch --noEmit',
+        description:
+            "Passthrough all additional arguments combined into one argument via '{*}' placeholder",
+        example: ['$ $0 -P "echo {*}" -- foo bar', "# Results in: echo 'foo bar'"].join('\n'),
     },
 ];