chore: added logging everywhere

pd93 · pd93 · commit c9f19d5e7ead · 2023-03-21T15:03:06.000Z
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,7 +1,9 @@
 import * as vscode from 'vscode';
+import { log } from './utils/log';
 import { TaskExtension } from './task';
 
 export function activate(context: vscode.ExtensionContext) {
+	log.info("Extension activated");
 
 	// Create a new instance of Tagger
 	let taskExtension: TaskExtension = new TaskExtension();
diff --git a/src/services/taskfile.ts b/src/services/taskfile.ts
@@ -4,7 +4,7 @@ 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 { log, settings } from '../utils';
 import { Octokit } from 'octokit';
 import { Endpoints } from "@octokit/types";
 
@@ -42,6 +42,7 @@ class TaskfileService {
 
                 // If the version is a devel version, ignore all version checks
                 if (stdout.includes("devel")) {
+                    log.info("Using development version of task");
                     return resolve("ready");
                 }
 
@@ -50,13 +51,15 @@ class TaskfileService {
 
                 // If there is an error fetching the version, assume task is not installed
                 if (stderr !== "" || version === undefined) {
+                    log.error(version ? stderr : "Version is undefined");
                     vscode.window.showErrorMessage("Task command not found.", "Install").then(this.buttonCallback);
                     return resolve("notInstalled");
                 }
 
                 // If the current version is older than the minimum required version, show an error
                 if (version && version.compare(minimumRequiredVersion) < 0) {
-                    vscode.window.showErrorMessage(`Task v${minimumRequiredVersion} is required to run this extension. Your current version is v${version}.`, "Update").then(this.buttonCallback);
+                    log.error(`Task v${minimumRequiredVersion} is required to run this extension. The current version is v${version}`);
+                    vscode.window.showErrorMessage(`Task v${minimumRequiredVersion} is required to run this extension. The current version is v${version}.`, "Update").then(this.buttonCallback);
                     return resolve("outOfDate");
                 }
 
@@ -65,11 +68,12 @@ class TaskfileService {
                 if (settings.checkForUpdates) {
                     this.getLatestVersion().then((latestVersion) => {
                         if (version && latestVersion && version.compare(latestVersion) < 0) {
+                            log.info(`A new version of Task is available. Current version: v${version}, Latest version: v${latestVersion}`);
                             vscode.window.showInformationMessage(`A new version of Task is available. Current version: v${version}, Latest version: v${latestVersion}`, "Update").then(this.buttonCallback);
                         }
                         return resolve("ready");
                     }).catch((err) => {
-                        console.error(err);
+                        log.error(err);
                         return resolve("notInstalled");
                     });
                 }
@@ -88,6 +92,7 @@ class TaskfileService {
     }
 
     async getLatestVersion(): Promise<semver.SemVer | null> {
+        log.info(`Calling GitHub to get the latest version`);
         let request: ReleaseRequest = {
             owner: 'go-task',
             repo: 'task'
@@ -111,6 +116,7 @@ class TaskfileService {
     }
 
     public async init(dir: string): Promise<void> {
+        log.info(`Initialising taskfile in: "${dir}"`);
         return await new Promise((resolve) => {
             let command = this.command('--init');
             cp.exec(command, { cwd: dir }, (_, stdout: string, stderr: string) => {
@@ -129,23 +135,28 @@ class TaskfileService {
         for (let i = 0; i < filenames.length; i++) {
             let filename = path.join(dir, filenames[i]);
             if (fs.existsSync(filename)) {
+                log.info(`Opening taskfile: "${filename}"`);
                 await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(filename), { preview: false });
                 return;
             }
         }
     }
 
     public async read(dir: string): Promise<models.Taskfile> {
+        log.info(`Searching for taskfile in: "${dir}"`);
         return await new Promise((resolve, reject) => {
             let command = this.command('--list-all --json');
             cp.exec(command, { cwd: dir }, (err: cp.ExecException | null, stdout: string) => {
                 if (err) {
+                    log.error(err);
                     return reject();
                 }
                 var taskfile: models.Taskfile = JSON.parse(stdout);
                 if (path.dirname(taskfile.location) !== dir) {
+                    log.info(`Ignoring taskfile: "${taskfile.location}" (outside of workspace)`);
                     return reject();
                 }
+                log.info(`Found taskfile: "${taskfile.location}"`);
                 taskfile.workspace = dir;
                 return resolve(taskfile);
             });
@@ -162,6 +173,8 @@ class TaskfileService {
 
     public async runTask(taskName: string, dir?: string): Promise<void> {
         return await new Promise((resolve) => {
+            log.info(`Running task: "${taskName}" in: "${dir}"`);
+
             // Spawn a child process
             let child = cp.spawn(this.command(), [taskName], { cwd: dir });
 
@@ -183,6 +196,7 @@ class TaskfileService {
 
             // When the task finishes, print the exit code and resolve the promise
             child.on('close', code => {
+                log.info(`Task completed with code ${code}`);
                 TaskfileService.outputChannel.append(`task: completed with code ${code}\n`);
                 this.lastTaskName = taskName;
                 this.lastTaskDir = dir;
@@ -192,6 +206,8 @@ class TaskfileService {
     }
 
     public async goToDefinition(task: models.Task, preview: boolean = false): Promise<void> {
+        log.info(`Navigating to "${task.name}" definition in: "${task.location.taskfile}"`);
+
         let position = new vscode.Position(task.location.line - 1, task.location.column - 1);
         let range = new vscode.Range(position, position);
 
@@ -208,7 +224,7 @@ class TaskfileService {
         try {
             await vscode.commands.executeCommand('vscode.open', file, options);
         } catch (err) {
-            console.error(err);
+            log.error(err);
         }
     }
 }
diff --git a/src/task.ts b/src/task.ts
@@ -2,7 +2,7 @@ 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 { log, settings } from './utils';
 
 export class TaskExtension {
     private _taskfiles: models.Taskfile[] = [];
@@ -51,7 +51,7 @@ export class TaskExtension {
         await this.update().then(() => {
             this.refresh();
         }).catch((err: string) => {
-            console.error(err);
+            log.error(err);
         });
     }
 
@@ -64,6 +64,7 @@ export class TaskExtension {
 
         // Initialise Taskfile
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.init', () => {
+            log.info("Command: vscode-task.init");
             if (vscode.workspace.workspaceFolders?.length === 1) {
                 services.taskfile.init(vscode.workspace.workspaceFolders[0].uri.fsPath);
                 return;
@@ -84,28 +85,33 @@ export class TaskExtension {
 
         // Refresh tasks
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.refresh', () => {
+            log.info("Command: vscode-task.refresh");
             this.updateAndRefresh();
         }));
 
         // View tasks as list
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.viewAsList', () => {
+            log.info("Command: vscode-task.viewAsList");
             this.setTreeNesting(false);
         }));
 
         // View tasks as tree
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.viewAsTree', () => {
+            log.info("Command: vscode-task.viewAsTree");
             this.setTreeNesting(true);
         }));
 
         // Run task
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runTask', (treeItem?: elements.TaskTreeItem) => {
+            log.info("Command: vscode-task.runTask");
             if (treeItem?.task) {
                 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");
             let items: vscode.QuickPickItem[] = [];
             this._taskfiles.forEach(taskfile => {
                 if (taskfile.tasks.length > 0) {
@@ -128,11 +134,13 @@ export class TaskExtension {
 
         // Run last task
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runLastTask', () => {
+            log.info("Command: vscode-task.runLastTask");
             services.taskfile.runLastTask();
         }));
 
         // Go to definition
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.goToDefinition', (task: elements.TaskTreeItem | models.Task, preview: boolean = false) => {
+            log.info("Command: vscode-task.goToDefinition");
             if (task instanceof elements.TaskTreeItem) {
                 if (task.task === undefined) {
                     return;
@@ -144,6 +152,7 @@ export class TaskExtension {
 
         // Go to definition picker
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.goToDefinitionPicker', () => {
+            log.info("Command: vscode-task.goToDefinitionPicker");
             let items: vscode.QuickPickItem[] = [];
             this._taskfiles.forEach(taskfile => {
                 if (taskfile.tasks.length > 0) {
@@ -166,11 +175,13 @@ export class TaskExtension {
 
         // Open installation
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.openInstallation', () => {
+            log.info("Command: vscode-task.openInstallation");
             vscode.env.openExternal(vscode.Uri.parse('https://taskfile.dev/installation'));
         }));
 
         // Open usage
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.openUsage', () => {
+            log.info("Command: vscode-task.openUsage");
             vscode.env.openExternal(vscode.Uri.parse('https://taskfile.dev/usage'));
         }));
     }
@@ -186,13 +197,15 @@ export class TaskExtension {
     }
 
     private async _onDidTaskfileChange() {
+        log.info("Detected changes to taskfile");
         // If manual updating is turned off (update on save)
         if (settings.updateOn !== "manual") {
             await this.updateAndRefresh();
         }
     }
 
     private _onDidChangeConfiguration(event: vscode.ConfigurationChangeEvent) {
+        log.info("Detected changes to configuration");
         if (event.affectsConfiguration("task")) {
             settings.update();
         }
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -0,0 +1,2 @@
+export * from './log';
+export * from './settings';
diff --git a/src/utils/log.ts b/src/utils/log.ts
@@ -0,0 +1,25 @@
+import * as vscode from 'vscode';
+
+class Log {
+    private static _instance: Log;
+
+    constructor(
+        private _channel: vscode.OutputChannel = vscode.window.createOutputChannel("Task (Debug)")
+    ) { }
+
+    public static get instance() {
+        return this._instance ?? (this._instance = new this());
+    }
+
+    info(v: any) {
+        console.log(v);
+        this._channel.appendLine(v);
+    }
+
+    error(err: any) {
+        console.error(err);
+        this._channel.appendLine(err);
+    }
+}
+
+export const log = Log.instance;
diff --git a/src/utils/settings.ts b/src/utils/settings.ts
@@ -1,4 +1,5 @@
 import * as vscode from 'vscode';
+import { log } from './';
 
 class Settings {
     private static _instance: Settings;
@@ -17,6 +18,8 @@ class Settings {
 
     // Fetches all the settings from the workspace configuration file
     public update() {
+        log.info("Updating settings");
+
         // Get the workspace config
         let config = vscode.workspace.getConfiguration("task");
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from './log';`
	`2`	`+export * from './settings';`