feat(CommandLineArgs): Support passing Args to Tasks (#89)

Author: MaxCheetham

package.json

@@ -67,12 +67,24 @@
         "category": "Task",
         "icon": "$(play)"
       },
+      {
+        "command": "vscode-task.runTaskWithArgs",
+        "title": "Run Task With Args",
+        "category": "Task",
+        "icon": "$(run-all)"
+      },
       {
         "command": "vscode-task.runTaskPicker",
         "title": "Run Task",
         "category": "Task",
         "icon": "$(play)"
       },
+      {
+        "command": "vscode-task.runTaskPickerWithArgs",
+        "title": "Run Task With Args",
+        "category": "Task",
+        "icon": "$(play)"
+      },
       {
         "command": "vscode-task.runLastTask",
         "title": "Run Last Task",
@@ -155,6 +167,10 @@
           "command": "vscode-task.runTask",
           "when": "false"
         },
+        {
+          "command": "vscode-task.runTaskWithArgs",
+          "when": "false"
+        },
         {
           "command": "vscode-task.goToDefinition",
           "when": "false"
@@ -183,15 +199,20 @@
         }
       ],
       "view/item/context": [
+        {
+          "command": "vscode-task.goToDefinition",
+          "when": "view == vscode-task.tasks && viewItem == taskTreeItem",
+          "group": "inline@1"
+        },
         {
           "command": "vscode-task.runTask",
           "when": "view == vscode-task.tasks && viewItem == taskTreeItem",
-          "group": "inline"
+          "group": "inline@2"
         },
         {
-          "command": "vscode-task.goToDefinition",
+          "command": "vscode-task.runTaskWithArgs",
           "when": "view == vscode-task.tasks && viewItem == taskTreeItem",
-          "group": "inline"
+          "group": "inline@3"
         }
       ]
     },

src/services/taskfile.ts

@@ -1,12 +1,12 @@
+import { Endpoints } from "@octokit/types";
 import * as cp from 'child_process';
-import * as vscode from 'vscode';
-import * as models from '../models';
-import * as path from 'path';
 import * as fs from 'fs';
+import { Octokit } from 'octokit';
+import * as path from 'path';
 import * as semver from 'semver';
+import * as vscode from 'vscode';
+import * as models from '../models';
 import { log, settings } from '../utils';
-import { Octokit } from 'octokit';
-import { Endpoints } from "@octokit/types";
 import stripAnsi = require('strip-ansi');
 
 const octokit = new Octokit();
@@ -48,11 +48,14 @@ class TaskfileService {
         return this._instance ?? (this._instance = new this());
     }
 
-    private command(command?: string): string {
+    private command(command?: string, cliArgs?: string): string {
         if (command === undefined) {
             return settings.path;
         }
-        return `${settings.path} ${command}`;
+        if (cliArgs === undefined) {
+            return `${settings.path} ${command}`;
+        }
+        return `${settings.path} ${command} -- ${cliArgs}`;
     }
 
     public async checkInstallation(checkForUpdates?: boolean): Promise<string> {
@@ -225,17 +228,17 @@ class TaskfileService {
         await this.runTask(this.lastTaskName, this.lastTaskDir);
     }
 
-    public async runTask(taskName: string, dir?: string): Promise<void> {
+    public async runTask(taskName: string, dir?: string, cliArgs?: string): Promise<void> {
         if (settings.outputTo === "terminal") {
-            log.info(`Running task: "${taskName}" in: "${dir}"`);
+            log.info(`Running task: "${taskName} ${cliArgs}" in: "${dir}"`);
             var terminal: vscode.Terminal;
             if (vscode.window.activeTerminal !== undefined) {
                 terminal = vscode.window.activeTerminal;
             } else {
                 terminal = vscode.window.createTerminal("Task");
             }
             terminal.show();
-            terminal.sendText(this.command(taskName));
+            terminal.sendText(this.command(taskName, cliArgs));
         } else {
             return await new Promise((resolve) => {
                 log.info(`Running task: "${taskName}" in: "${dir}"`);

src/task.ts

@@ -70,6 +70,9 @@ export class TaskExtension {
     }
 
     public registerCommands(context: vscode.ExtensionContext): void {
+        const RUNTASKWITHARGS_PROMPT = "Enter Command Line Arguments:";
+        const RUNTASKWITHARGS_PLACEHOLDER = "<arg1> <arg2> ...";
+
         // Initialise Taskfile
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.init', () => {
             log.info("Command: vscode-task.init");
@@ -117,6 +120,19 @@ export class TaskExtension {
             }
         }));
 
+        // Run task with args
+        context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runTaskWithArgs', (treeItem?: elements.TaskTreeItem) => {
+            log.info("vscode-task.runTaskWithArgs");
+            if (treeItem?.task) {
+                vscode.window.showInputBox({
+                    prompt: RUNTASKWITHARGS_PROMPT,
+                    placeHolder: RUNTASKWITHARGS_PLACEHOLDER
+                }).then((cliArgsInput) => {
+                    services.taskfile.runTask(treeItem.task.name, treeItem.workspace);
+                });
+            }
+        }));
+
         // Run task picker
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runTaskPicker', () => {
             log.info("Command: vscode-task.runTaskPicker");
@@ -134,6 +150,32 @@ export class TaskExtension {
             });
         }));
 
+        // Run task picker with args
+        context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runTaskPickerWithArgs', () => {
+            log.info("Command: vscode-task.runTaskPickerWithArgs");
+            let items: vscode.QuickPickItem[] = this._loadTasksFromTaskfile();
+
+            if (items.length === 0) {
+                vscode.window.showInformationMessage('No tasks found');
+                return;
+            }
+
+            vscode.window.showQuickPick(items).then((item) => {
+                vscode.window.showInputBox({
+                    prompt: RUNTASKWITHARGS_PROMPT,
+                    placeHolder: RUNTASKWITHARGS_PLACEHOLDER
+                }).then((cliArgsInput) => {
+                    if (cliArgsInput === undefined) {
+                        vscode.window.showInformationMessage('No Args Supplied');
+                        return;
+                    }
+                    if (item && item instanceof elements.QuickPickTaskItem) {
+                        services.taskfile.runTask(item.label, item.taskfile.workspace, cliArgsInput);
+                    }
+                });
+            });
+        }));
+
         // Run last task
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runLastTask', () => {
             log.info("Command: vscode-task.runLastTask");