Merge pull request #149 from augustocdias/stdin_resolve_vars

Support stdin resolve vars

Author: MarcelRobitaille

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [1.18.0] 2025-05-13
+
+- Support stdinResolveVars (#145)
+
 ## [1.18.0] 2025-05-06
 
 - Support stdin (#145)

README.md

@@ -97,6 +97,7 @@ VSCode renders it like this:
 * `command`: the system command to be executed (must be in PATH). If given as an array, the elements are joined by spaces.
 * `commandArgs`: if provided, `command` is interpreted as the binary to run and `commandArgs` are the arguments. This is useful if the binary you want to run has spaces (like `C:\Program Files\*`). This translates to `child_process.execFileSync(command, commandArgs)`.
 * `stdin`: if provided, this string is sent to the standard input of the command
+* `stdinResolveVars`: whether to perform variable substitution (see below) for `stdin` (default true).
 * `cwd`: the directory from within it will be executed
 * `env`: key-value pairs to use as environment variables (it won't append the variables to the current existing ones. It will replace instead)
 * `useFirstResult`: skip 'Quick Pick' dialog and use first result returned from the command

package-lock.json

@@ -3,7 +3,7 @@
   "displayName": "Tasks Shell Input",
   "description": "Use shell commands as input for your tasks",
   "icon": "icon.png",
-  "version": "1.18.0",
+  "version": "1.18.1",
   "publisher": "augustocdias",
   "repository": {
     "url": "https://github.com/augustocdias/vscode-shell-command"

package.json

@@ -453,6 +453,7 @@ describe("Argument parsing", () => {
                 multiselectSeparator: " ",
                 stdio: "stdout",
                 extraTestThing: 42,
+                stdinResolveVars: true,
             });
     });
 

src/lib/CommandHandler.test.ts

@@ -68,13 +68,14 @@ export class CommandHandler {
             allowCustomValues: parseBoolean(args.allowCustomValues, false),
             warnOnStderr: parseBoolean(args.warnOnStderr, true),
             multiselect: parseBoolean(args.multiselect, false),
+            stdinResolveVars: parseBoolean(args.multiselect, true),
             multiselectSeparator: args.multiselectSeparator ?? " ",
             stdio: ["stdout", "stderr", "both"].includes(args.stdio as string) ? args.stdio : "stdout",
             ...args,
         } as ShellCommandOptions;
     }
 
-    protected async resolveArgs() {
+    protected async resolveVariables() {
         const resolver = new VariableResolver(
             this.input,
             this.userInputContext,
@@ -90,6 +91,17 @@ export class CommandHandler {
             this.command = command;
         }
 
+        if (this.stdin !== undefined && this.args.stdinResolveVars === true) {
+            const resolvedStdin = await resolver.resolve(this.stdin);
+            if (resolvedStdin === undefined) {
+                throw new ShellCommandException(
+                    "Your stdin is badly formatted and variables could not be resolved. Set stdinResolveVars=false to prevent stdin vars resolving",
+                );
+            } else {
+                this.stdin = resolvedStdin;
+            }
+        }
+
         if (this.commandArgs !== undefined) {
             for (const i in this.commandArgs) {
                 const item = await resolver.resolve(this.commandArgs[i]);
@@ -125,7 +137,7 @@ export class CommandHandler {
     // Get the result, either by showing a dropdown or taking the first / only
     // option
     async getResult() {
-        await this.resolveArgs();
+        await this.resolveVariables();
 
         const result = await this.runCommand();
         const nonEmptyInput = this.parseResult(result);

src/lib/CommandHandler.ts

@@ -4,6 +4,7 @@ export interface ShellCommandOptions
     command: unknown;
     commandArgs?: unknown;
     stdin?: string;
+    stdinResolveVars?: boolean;
     env?: { [s: string]: string };
     useFirstResult?: boolean;
     useSingleResult?: boolean;