Merge pull request #119 from augustocdias/user_input_context

Refactor UserInputContext

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [Unreleased] 2024-XX-XX
+
+- Fix default value not recorded for useFirstResult / useSingleResult (#117)
+- Add support for ${taskId:} input variables
+- Do not reset user input context (#95)
+
 ## [1.12.4] 2024-10-03
 
 - Work around VSCode bug with activeItems and selectedItems (#112)

README.md

@@ -107,7 +107,7 @@ As of today, the extension supports variable substitution for:
 * the remembered value (the default value when `rememberPrevious` is true), available as `${rememberedValue}`
 * all config variables, pattern: `${config:variable}`
 * all environment variables (`tasks.json` `options.env` with fallback to parent process), pattern: `${env:variable}`
-* input variables which have been defined with `shellCommand.execute`, pattern: `${input:variable}` (limited supported see below for usage)
+* input variables that have been defined with `shellCommand.execute`, pattern: `${input:variable}` (uses `input.id`) and `${taskId:task}` (uses `input.args.taskId`) (limited supported see below for usage)
 * Support for ${command:...} pattern, for example to extract CMake's build directory using `${command:cmake.buildDirectory}`.
 * multi-folder workspace support: `${workspaceFolder}` (the folder whose `.vscode/tasks.json` defined the given task), `${workspaceFolder[1]}` (a specific folder by index), and `${workspaceFolder:name}` (a specific folder by name)
 

src/extension.ts

@@ -24,8 +24,4 @@ export function activate(this: any, context: vscode.ExtensionContext) {
     };
 
     context.subscriptions.push(vscode.commands.registerCommand(command, callback, this));
-
-    // Triggers a reset of the userInput context
-    context.subscriptions.push(vscode.tasks.onDidStartTask(() => userInputContext.reset()));
-    context.subscriptions.push(vscode.debug.onDidStartDebugSession(() => userInputContext.reset()));
 }

src/lib/CommandHandler.ts

@@ -143,7 +143,9 @@ export class CommandHandler {
             : vscode.workspace.workspaceFolders?.[this.input.workspaceIndex].uri.fsPath;
     }
 
-    async handle() {
+    // Get the result, either by showing a dropdown or taking the first / only
+    // option
+    async getResult() {
         await this.resolveArgs();
 
         const result = await this.runCommand();
@@ -153,27 +155,31 @@ export class CommandHandler {
             (this.args.useSingleResult && nonEmptyInput.length === 1);
 
         if (useFirstResult) {
-            if (this.input.id && this.userInputContext) {
-                this.userInputContext.recordInput(this.input.id, nonEmptyInput[0].value);
-            }
-            return nonEmptyInput[0].value;
+            const result = nonEmptyInput[0].value;
+            return [result];
         } else {
             const selectedItems = await this.quickPick(nonEmptyInput);
+            return selectedItems;
+        }
+    }
 
-            if (!selectedItems) {
-                this.userInputContext.reset();
-                return;
-            }
-
-            const result = selectedItems.join(this.args.multiselectSeparator!);
-            this.userInputContext.recordInput(this.input.id, result);
+    async handle() {
+        const selectedItems = await this.getResult();
 
-            if (this.args.rememberPrevious && this.args.taskId) {
-                this.setDefault(this.args.taskId, selectedItems);
-            }
+        if (selectedItems === undefined) {
+            return;
+        }
 
-            return result;
+        if (this.args.rememberPrevious && this.args.taskId) {
+            this.setDefault(this.args.taskId, selectedItems);
         }
+
+        const result = selectedItems.join(this.args.multiselectSeparator!);
+
+        this.userInputContext.recordInputByInputId(this.input.id, result);
+        this.userInputContext.recordInputByTaskId(this.args.taskId, result);
+
+        return result;
     }
 
     protected async runCommand() {
@@ -292,7 +298,7 @@ export class CommandHandler {
 
                 picker.onDidHide(() => {
                     const didCancelQuickPickSession =
-                        picker?.selectedItems?.length === 0 ?? true;
+                        picker?.selectedItems?.length === 0;
                     const result = CommandHandler.transformSelection(picker);
 
                     if (didCancelQuickPickSession) {

src/lib/UserInputContext.ts

@@ -1,19 +1,25 @@
 export class UserInputContext
 {
-    protected recordedInputs: { [id: string] : string; } = {};
+    protected recordedInputsByInputId: { [id: string] : string | undefined; } = {};
+    protected recordedInputsByTaskId: { [id: string] : string | undefined; } = {};
 
-    reset(): void
-    {
-        this.recordedInputs = {};
+    recordInputByInputId(inputId: string | undefined, taskValue: string | undefined): void {
+        if (inputId !== undefined) {
+            this.recordedInputsByInputId[inputId] = taskValue;
+        }
     }
 
-    recordInput(inputId: string, taskValue: string): void
-    {
-        this.recordedInputs[inputId] = taskValue;
+    recordInputByTaskId(taskId: string | undefined, taskValue: string | undefined): void {
+        if (taskId !== undefined) {
+            this.recordedInputsByTaskId[taskId] = taskValue;
+        }
     }
 
-    lookupInputValue(inputId: string): string
-    {
-        return this.recordedInputs[inputId];
+    lookupInputValueByInputId(inputId: string): string | undefined {
+        return this.recordedInputsByInputId[inputId];
+    }
+
+    lookupInputValueByTaskId(taskId: string): string | undefined {
+        return this.recordedInputsByTaskId[taskId];
     }
 }

src/lib/VariableResolver.ts

@@ -24,12 +24,13 @@ export class VariableResolver {
     protected configVarRegex = /config:(.+)/m;
     protected envVarRegex = /env:(.+)/m;
     protected inputVarRegex = /input:(.+)/m;
+    protected taskIdVarRegex = /taskId:(.+)/m;
     protected commandVarRegex = /command:(.+)/m;
     protected rememberedValue?: string;
-    protected userInputContext?: UserInputContext;
+    protected userInputContext: UserInputContext;
     protected input: Input;
 
-    constructor(input: Input, userInputContext?: UserInputContext,
+    constructor(input: Input, userInputContext: UserInputContext,
                 rememberedValue?: string) {
        this.userInputContext = userInputContext;
        this.rememberedValue = rememberedValue;
@@ -55,9 +56,17 @@ export class VariableResolver {
                 if (this.envVarRegex.test(value)) {
                     return this.bindEnvVariable(value);
                 }
-                if (this.userInputContext && this.inputVarRegex.test(value)) {
-                    return this.bindInputVariable(value, this.userInputContext);
+
+                const inputVar = this.inputVarRegex.exec(value);
+                if (inputVar) {
+                    return this.userInputContext.lookupInputValueByInputId(inputVar[1]) ?? '';
+                }
+
+                const taskIdVar = this.taskIdVarRegex.exec(value);
+                if (taskIdVar) {
+                    return this.userInputContext.lookupInputValueByTaskId(taskIdVar[1]) ?? '';
                 }
+
                 if (this.commandVarRegex.test(value)) {
                     // We don't replace these yet, they have to be done asynchronously
                     promises.push(this.bindCommandVariable(value));
@@ -165,21 +174,14 @@ export class VariableResolver {
 
     protected bindEnvVariable(value: string): string {
         const result = this.envVarRegex.exec(value);
+
         if (!result) {
             return '';
         }
+
         const key = result[1];
         const configuredEnv = this.input.env;
 
         return configuredEnv[key] ?? process.env[key] ?? '';
     }
-
-    protected bindInputVariable(value: string, userInputContext: UserInputContext): string {
-        const result = this.inputVarRegex.exec(value);
-        if (!result) {
-            return '';
-        }
-
-        return userInputContext.lookupInputValue(result[1]) || '';
-    }
 }