feat: configure the path to the task binary

Author: pd93

CHANGELOG.md

@@ -10,7 +10,10 @@
 - Ability to initialize a Taskfile in the current workspace.
   - If no Taskfile is detected a button will appear in the sidebar.
 - Refresh on save.
-  - Configurable via `task.updateOn` setting (values: `save` (default) or `manual`).
+  - Configurable via `task.updateOn` setting (values: `"save"` (default) or `"manual"`).
 - Toggle tree nesting on/off
   - Configurable via `task.nesting` setting (values: `true` (default) or `false`).
+- Change the path to the Task binary.
+  - Can also be set to the name of a binary in your `$PATH`.
+  - Configurable via `task.path` setting (defaults to `"task"`).
 - Sidebar icon provided by @drite93.

README.md

@@ -32,7 +32,8 @@
 
 ## Configuration
 
-| Setting        | Type      | Allowed Values       | Default  | Description                                      |
-| -------------- | --------- | -------------------- | -------- | ------------------------------------------------ |
-| `updateOn`     | `string`  | `"manual"`, `"save"` | `"save"` | When should the task list be updated.            |
-| `tree.nesting` | `boolean` |                      | `true`   | Should the task list be nested or not by default |
+| Setting        | Type      | Allowed Values       | Default  | Description                                                             |
+| -------------- | --------- | -------------------- | -------- | ----------------------------------------------------------------------- |
+| `updateOn`     | `string`  | `"manual"`, `"save"` | `"save"` | When should the task list be updated.                                   |
+| `path`         | `string`  |                      | `task`   | Path to the Task binary. Can also the name of a binary in your `$PATH`. |
+| `tree.nesting` | `boolean` |                      | `true`   | Should the task list be nested or not by default.                       |

package.json

@@ -213,6 +213,11 @@
               "default": "save",
               "description": "When the list of tasks should be updated."
             },
+            "path": {
+              "type": "string",
+              "default": "task",
+              "description": "Path to the Task binary. If not set, the extension will try to find the binary in the PATH environment variable."
+            },
             "tree": {
               "type": "object",
               "description": "Tree view configuration options.",

src/services/taskfile.ts

@@ -4,14 +4,14 @@ import * as models from '../models';
 import * as path from 'path';
 import * as fs from 'fs';
 import * as semver from 'semver';
+import { settings } from '../settings';
 import { Octokit } from 'octokit';
 import { Endpoints } from "@octokit/types";
 
 const octokit = new Octokit();
 type ReleaseRequest = Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["parameters"];
 type ReleaseResponse = Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["response"];
 
-const taskCommand = 'task';
 const minimumRequiredVersion = '3.19.1';
 const minimumRecommendedVersion = '3.23.0';
 
@@ -29,9 +29,17 @@ class TaskfileService {
         return this._instance ?? (this._instance = new this());
     }
 
+    private command(command?: string): string {
+        if (command === undefined) {
+            return settings.path;
+        }
+        return `${settings.path} ${command}`;
+    }
+
     public async checkInstallation(): Promise<void> {
         return await new Promise((resolve) => {
-            cp.exec(`${taskCommand} --version`, (_, stdout: string, stderr: string) => {
+            let command = this.command('--version');
+            cp.exec(command, (_, stdout: string, stderr: string) => {
 
                 // If the version is a devel version, ignore all version checks
                 if (stdout.includes("devel")) {
@@ -109,7 +117,7 @@ class TaskfileService {
 
     public async init(dir: string): Promise<void> {
         return await new Promise((resolve) => {
-            let command = `${taskCommand} --init`;
+            let command = this.command('--init');
             cp.exec(command, { cwd: dir }, (_, stdout: string, stderr: string) => {
                 if (stderr) {
                     vscode.window.showErrorMessage(stderr);
@@ -134,7 +142,7 @@ class TaskfileService {
 
     public async read(dir: string): Promise<models.Taskfile> {
         return await new Promise((resolve) => {
-            let command = `${taskCommand} --list-all --json`;
+            let command = this.command('--list-all --json');
             cp.exec(command, { cwd: dir }, (_, stdout: string) => {
                 var taskfile: models.Taskfile = JSON.parse(stdout);
                 taskfile.workspace = dir;
@@ -154,7 +162,7 @@ class TaskfileService {
     public async runTask(taskName: string, dir?: string): Promise<void> {
         return await new Promise((resolve) => {
             // Spawn a child process
-            let child = cp.spawn(taskCommand, [taskName], { cwd: dir });
+            let child = cp.spawn(this.command(), [taskName], { cwd: dir });
 
             // Clear the output channel and show it
             TaskfileService.outputChannel.clear();

src/settings.ts

@@ -1,20 +1,29 @@
 import * as vscode from 'vscode';
 
-export class Settings {
+class Settings {
+    private static _instance: Settings;
     public updateOn!: string;
+    public path!: string;
     public treeNesting!: boolean;
 
     constructor() {
         this.update();
     }
 
+    public static get instance() {
+        return this._instance ?? (this._instance = new this());
+    }
+
     // Fetches all the settings from the workspace configuration file
     public update() {
         // Get the workspace config
         let config = vscode.workspace.getConfiguration("task");
 
         // Set the properties
         this.updateOn = config.get("updateOn") ?? "change";
+        this.path = config.get("path") ?? "task";
         this.treeNesting = config.get("tree.nesting") ?? true;
     }
 }
+
+export const settings = Settings.instance;

src/task.ts

@@ -2,20 +2,18 @@ import * as vscode from 'vscode';
 import * as elements from './elements';
 import * as services from './services';
 import * as models from './models';
-import { Settings } from './settings';
+import { settings } from './settings';
 
 export class TaskExtension {
     private _taskfiles: models.Taskfile[] = [];
-    private _settings: Settings;
     private _activityBar: elements.ActivityBar;
     private _watcher: vscode.FileSystemWatcher;
 
     constructor() {
-        this._settings = new Settings();
         this._activityBar = new elements.ActivityBar();
         this._watcher = vscode.workspace.createFileSystemWatcher("**/*.{yml,yaml}");
         services.taskfile.checkInstallation();
-        this.setTreeNesting(this._settings.treeNesting);
+        this.setTreeNesting(settings.treeNesting);
     }
 
     public async update(): Promise<void> {
@@ -162,14 +160,14 @@ export class TaskExtension {
 
     private async _onDidTaskfileChange() {
         // If manual updating is turned off (update on save)
-        if (this._settings.updateOn !== "manual") {
+        if (settings.updateOn !== "manual") {
             await this.updateAndRefresh();
         }
     }
 
     private _onDidChangeConfiguration(event: vscode.ConfigurationChangeEvent) {
         if (event.affectsConfiguration("task")) {
-            this._settings.update();
+            settings.update();
         }
     }
 }