From 43e31091eec94c151f77333467503d4b6e0e9864 Mon Sep 17 00:00:00 2001 From: Takumasa Ochi Date: Thu, 23 Mar 2023 19:26:05 +0900 Subject: [PATCH] Mention single quote limitation on documentation of exec.exec and exec.getExecOutput --- packages/exec/src/exec.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/exec/src/exec.ts b/packages/exec/src/exec.ts index 2a67a912..c395bf50 100644 --- a/packages/exec/src/exec.ts +++ b/packages/exec/src/exec.ts @@ -9,7 +9,7 @@ export {ExecOptions, ExecOutput, ExecListeners} * Output will be streamed to the live console. * Returns promise with return code * - * @param commandLine command to execute (can include additional args). Must be correctly escaped. + * @param commandLine command to execute (can include additional args). Must be correctly escaped. Currently, only double quotes are supported for splitting args. * @param args optional arguments for tool. Escaping is handled by the lib. * @param options optional exec options. See ExecOptions * @returns Promise exit code @@ -35,7 +35,7 @@ export async function exec( * Output will be streamed to the live console. * Returns promise with the exit code and collected stdout and stderr * - * @param commandLine command to execute (can include additional args). Must be correctly escaped. + * @param commandLine command to execute (can include additional args). Must be correctly escaped. Currently, only double quotes are supported for splitting args. * @param args optional arguments for tool. Escaping is handled by the lib. * @param options optional exec options. See ExecOptions * @returns Promise exit code, stdout, and stderr