Merge pull request #156 from augustocdias/allow_empty

Add filterEmptyResults

Author: MarcelRobitaille

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [1.19.0] 2025-07-02
+
+- Allow not filtering empty results (#155)
+
 ## [1.18.3] 2025-05-28
 
 - Extracted the `taskId` criteria while searching the input. (#131)

README.md

@@ -107,6 +107,7 @@ VSCode renders it like this:
 * `multiselect`: If true, it's possible to select multiple values. They are joined by `multiselectSeparator`. Has no effect with `useFirstResult`.
 * `multiselectSeparator`: The string with which to join multiple options when `multiselect` is true (default `" "`). Has no effect without `multiselect`.
 * `warnOnStderr`: If true, a warning message is shown if the command outputs anything on stderr (default: true). Has no effect if `stdio` is not `stdout`.
+* `filterEmptyResults`: If true, empty lines output on `stdio` are filtered out (default: true).
 * `taskId`: Unique id to use for storing the last-used value.
 * `rememberAs`: Specify the `taskId` of another input to share history with that input.
 * `fieldSeparator`: the string that separates `value`, `label`, `description` and `detail` fields

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.3",
+  "version": "1.19.0",
   "publisher": "augustocdias",
   "repository": {
     "url": "https://github.com/augustocdias/vscode-shell-command"

package.json

@@ -448,8 +448,8 @@ describe("Errors", async () => {
             child_process,
         );
 
-        expect(() => handler.handle()).rejects.toThrowError(
-            "The command for input 'inputTest' returned empty result.");
+        await expect(() => handler.handle()).rejects.toThrowError(
+            "The command for input 'inputTest' didn't output any results.");
     });
 
     test("It should NOT trigger an error with defaultOptions", async () => {
@@ -468,8 +468,8 @@ describe("Errors", async () => {
             child_process,
         );
 
-        expect(() => handler.handle()).rejects.not.toThrowError(
-            "The command for input 'inputTest' returned empty result.");
+        await expect(() => handler.handle()).rejects.not.toThrowError(
+            "The command for input 'inputTest' didn't output any results.");
     });
 });
 
@@ -485,6 +485,7 @@ describe("Argument parsing", () => {
             useSingleResult: false,
             multiselect: false,
             warnOnStderr: true,
+            filterEmptyResults: true,
             multiselectSeparator: " ",
             stdio: "stdout",
             extraTestThing: 42,

src/lib/CommandHandler.test.ts

@@ -70,6 +70,7 @@ export class CommandHandler {
             warnOnStderr: parseBoolean(args.warnOnStderr, true),
             multiselect: parseBoolean(args.multiselect, false),
             stdinResolveVars: parseBoolean(args.stdinResolveVars, true),
+            filterEmptyResults: parseBoolean(args.filterEmptyResults, true),
             multiselectSeparator: args.multiselectSeparator ?? " ",
             stdio: ["stdout", "stderr", "both"].includes(args.stdio as string) ? args.stdio : "stdout",
         } as ShellCommandOptions;
@@ -206,8 +207,8 @@ export class CommandHandler {
 
     protected parseResult(commandOutput: { stdout: string, stderr: string }):
         QuickPickItem[] {
-        const stdout = commandOutput.stdout.trim();
-        const stderr = commandOutput.stderr.trim();
+        const stdout = commandOutput.stdout.replace(/\n$/, "");
+        const stderr = commandOutput.stderr.replace(/\n$/, "");
         let items: string[] = [];
 
         if (("stdout" == this.args.stdio) || ("both" == this.args.stdio)) {
@@ -218,10 +219,12 @@ export class CommandHandler {
             items.push(...stderr.split(this.EOL));
         }
 
-        items = items.filter(item => item !== "");
+        if (this.args.filterEmptyResults) {
+            items = items.filter(item => item !== "");
+        }
 
         if ((items.length == 0) && (undefined === this.args.defaultOptions)) {
-            let msg = `The command for input '${this.input.id}' returned empty result.`;
+            let msg = `The command for input '${this.input.id}' didn't output any results.`;
 
             if (stderr) {
                 msg += ` stderr: '${stderr}'`;
@@ -246,8 +249,7 @@ export class CommandHandler {
                     description: values[2],
                     detail: values[3],
                 };
-            })
-            .filter((item: QuickPickItem) => item.label && item.label.trim().length > 0);
+            });
     }
 
     protected getDefault() {

src/lib/CommandHandler.ts

@@ -12,6 +12,7 @@ export interface ShellCommandOptions
     allowCustomValues?: boolean;
     multiselect?: boolean;
     warnOnStderr?: boolean;
+    filterEmptyResults?: boolean;
     multiselectSeparator?: string;
     fieldSeparator?: string;
     description?: string;