From dabd3e43502060ed66d86819e14698194aaf4cd1 Mon Sep 17 00:00:00 2001 From: Mark Monteiro Date: Mon, 27 May 2024 14:38:22 -0400 Subject: [PATCH 1/2] Improve examples for the `--passthrough-arguments` parameter --- README.md | 7 +++++-- bin/epilogue.ts | 11 +++++++---- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7f1ad32d..cb25fd73 100644 --- a/README.md +++ b/README.md @@ -297,14 +297,17 @@ Examples: - Passthrough some additional arguments via '{}' 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 index d8a598bb..3891a031 100644 --- a/bin/epilogue.ts +++ b/bin/epilogue.ts @@ -61,15 +61,18 @@ const examples = [ }, { description: "Passthrough some additional arguments via '{}' 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'), }, ]; From a0ffa7726f46466355b8fe9d750193aeff882e94 Mon Sep 17 00:00:00 2001 From: Gustavo Henke Date: Thu, 6 Jun 2024 00:44:46 +1000 Subject: [PATCH 2/2] lint fix --- bin/epilogue.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/bin/epilogue.ts b/bin/epilogue.ts index 3891a031..fc635211 100644 --- a/bin/epilogue.ts +++ b/bin/epilogue.ts @@ -71,7 +71,8 @@ const examples = [ ].join('\n'), }, { - description: "Passthrough all additional arguments combined into one argument via '{*}' placeholder", + description: + "Passthrough all additional arguments combined into one argument via '{*}' placeholder", example: ['$ $0 -P "echo {*}" -- foo bar', "# Results in: echo 'foo bar'"].join('\n'), }, ];