Merge pull request #111 from augustocdias/fix_110

Fix #110

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [1.12.2] 2024-10-02
+
+- Fix backwards compatibility of default values (#110)
+
 ## [1.12.1] 2024-10-02
 
 - Fix errors with default values (#107)

package.json

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

src/lib/CommandHandler.test.ts

@@ -66,9 +66,14 @@ describe("Simple cases", async () => {
 
     test("Command as array of strings", async () => {
         mockVscode.setMockData(mockData);
+        const args = {
+            command: ["cat", "${file}"],
+            useFirstResult: true,
+            taskId: "inputTest",
+        };
 
         const handler = new CommandHandler(
-            {command: ["cat", "${file}"], useFirstResult: true},
+            args,
             new UserInputContext(),
             mockExtensionContext as unknown as vscode.ExtensionContext,
             child_process,
@@ -250,6 +255,42 @@ test("stdio", async () => {
     }
 });
 
+describe("Workspace state", () => {
+    test("It should return an array even if the saved value is a string", async () => {
+        const testDataPath = path.join(__dirname, "../test/testData/simple");
+
+        const tasksJson = await import(path.join(testDataPath, ".vscode/tasks.json"));
+        const mockData = (await import(path.join(testDataPath, "mockData.ts"))).default;
+        mockVscode.setMockData(mockData);
+        const input = tasksJson.inputs[0].args;
+
+        class CommandHandlerTestHelper extends CommandHandler {
+            public getDefault() {
+                return super.getDefault();
+            }
+        }
+
+        for (const workspaceStateGet of [
+            () => "test",
+            () => ["test"],
+        ]) {
+            const handler = new CommandHandlerTestHelper(
+                {...input, rememberPrevious: true},
+                new UserInputContext(),
+                {
+                    ...mockExtensionContext,
+                    workspaceState: {
+                        get: workspaceStateGet,
+                    },
+                } as unknown as vscode.ExtensionContext,
+                child_process,
+            );
+
+            expect(handler.getDefault()).toStrictEqual(["test"]);
+        }
+    });
+});
+
 describe("Errors", async () => {
     test("It should trigger an error for an empty result", async () => {
         const testDataPath = path.join(__dirname, "../test/testData/errors");

src/lib/CommandHandler.ts

@@ -225,7 +225,12 @@ export class CommandHandler {
 
     protected getDefault() {
         if (this.args.rememberPrevious && this.args.taskId) {
-            return this.context.workspaceState.get<string[]>(this.args.taskId, []);
+            const result = this.context.workspaceState
+                .get<string | string[]>(this.args.taskId, []);
+
+            // Backwards compatibilty for before multiselect when default was
+            // saved as string not array.
+            return (typeof result === "string") ? [result] : result;
         }
 
         return [];

src/test/testData/simple/.vscode/tasks.json

@@ -14,6 +14,7 @@
       "type": "command",
       "command": "shellCommand.execute",
       "args": {
+        "taskId": "inputTest",
         "command": "cat ${file}",
         "multiselect": true,
         "cwd": "${workspaceFolder}",

src/test/testData/simple/mockData.ts

@@ -9,6 +9,7 @@ export default {
             "type": "command",
             "command": "shellCommand.execute",
             "args": {
+              "taskId": "inputTest",
               "command": "cat ${file}",
               "cwd": "${workspaceFolder}",
               "env": {