feat: add ability to initialize a taskfile

Author: pd93

README.md

@@ -8,6 +8,8 @@ This extension integrates your Taskfile into Visual Studio Code.
 - Run tasks from the activity bar and command palette
 - Go to definition
 - Multi-root workspace support
+- Ability to initialize a Taskfile in the current workspace
+  - If no Taskfile is detected a button will appear in the activity bar
 
 ## Roadmap
 
@@ -20,4 +22,3 @@ This extension integrates your Taskfile into Visual Studio Code.
 - Support global tasks
 - Install Task via command palette
   - Prompt if a Taskfile is detected and Task is not installed
-- If no Taskfile is detected, add a button to initialise one

package.json

@@ -36,6 +36,12 @@
   "main": "./out/extension.js",
   "contributes": {
     "commands": [
+      {
+        "command": "vscode-task.init",
+        "title": "Initialize Taskfile",
+        "category": "Task",
+        "icon": "$(plus)"
+      },
       {
         "command": "vscode-task.refresh",
         "title": "Refresh Tasks",
@@ -84,6 +90,12 @@
         }
       ]
     },
+    "viewsWelcome": [
+      {
+        "view": "vscode-task.tasks",
+        "contents": "No Taskfile found in this workspace. Click the button below to get started and initialize a new Taskfile.\n[Initialize Taskfile](command:vscode-task.init)\nTo learn more about how to use Task [read our docs](https://taskfile.dev)."
+      }
+    ],
     "menus": {
       "commandPalette": [
         {

src/services/taskfile.ts

@@ -1,6 +1,8 @@
 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';
 
 class TaskfileService {
     private static _instance: TaskfileService;
@@ -14,13 +16,39 @@ class TaskfileService {
         return this._instance ?? (this._instance = new this());
     }
 
+    public async init(dir: string): Promise<void> {
+        return await new Promise((resolve) => {
+            let command = 'task --init';
+            cp.exec(command, { cwd: dir }, (_, stdout: string, stderr: string) => {
+                if (stderr) {
+                    vscode.window.showErrorMessage(stderr);
+                }
+                this.open(dir).then(() => {
+                    return resolve();
+                });
+            });
+        });
+    }
+
+    public async open(dir: string): Promise<void> {
+        let filenames = ['Taskfile.yml', 'Taskfile.yaml', 'taskfile.yml', 'taskfile.yaml'];
+        for (let i = 0; i < filenames.length; i++) {
+            let filename = path.join(dir, filenames[i]);
+            if (fs.existsSync(filename)) {
+                console.log(filename);
+                await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(filename), { preview: false });
+                return;
+            }
+        }
+    }
+
     public async read(dir: string): Promise<models.Taskfile> {
         return await new Promise((resolve) => {
             let command = 'task --list-all --json';
             cp.exec(command, { cwd: dir }, (_, stdout: string) => {
                 var taskfile: models.Taskfile = JSON.parse(stdout);
                 taskfile.workspace = dir;
-                resolve(taskfile);
+                return resolve(taskfile);
             });
         });
     }
@@ -33,12 +61,12 @@ class TaskfileService {
                 TaskfileService.outputChannel.append(stdout);
                 TaskfileService.outputChannel.append("-----\n");
                 TaskfileService.outputChannel.show();
-                resolve();
+                return resolve();
             });
         });
     }
 
-    public goToDefinition(task: models.Task, preview: boolean = false): void {
+    public async goToDefinition(task: models.Task, preview: boolean = false): Promise<void> {
         if (task.location === undefined) {
             vscode.window.showErrorMessage(`Go to definition requires Task v3.23.0 or higher.`);
             return;
@@ -58,7 +86,7 @@ class TaskfileService {
 
         // Run the vscode open command with the range options
         try {
-            vscode.commands.executeCommand('vscode.open', file, options);
+            await vscode.commands.executeCommand('vscode.open', file, options);
         } catch (err) {
             console.error(err);
         }

src/task.ts

@@ -40,6 +40,26 @@ export class TaskExtension {
 
     public registerCommands(context: vscode.ExtensionContext): void {
 
+        // Initialise Taskfile
+        context.subscriptions.push(vscode.commands.registerCommand('vscode-task.init', () => {
+            if (vscode.workspace.workspaceFolders?.length === 1) {
+                services.taskfile.init(vscode.workspace.workspaceFolders[0].uri.fsPath);
+                return;
+            }
+            let items: vscode.QuickPickItem[] = [];
+            vscode.workspace.workspaceFolders?.forEach((folder) => {
+                items = items.concat({
+                    label: folder.name,
+                    description: folder.uri.fsPath
+                });
+            });
+            vscode.window.showQuickPick(items).then((item) => {
+                if (item) {
+                    services.taskfile.init(item.description || "");
+                }
+            });
+        }));
+
         // Refresh tasks
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.refresh', () => {
             this.updateAndRefresh();