0.1.6: Add Logging

Author: meronz

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
 
+## 0.1.6
+- Added logging to help debug some issues.
 
 ## 0.1.5
 - Made the shortcut position in the editor context menu configurable by setting `manpages.editorMenuShortcutPosition`.

package.json

@@ -3,7 +3,7 @@
     "displayName": "Manpages",
     "publisher": "meronz",
     "description": "Quickly open man pages and navigate through them.",
-    "version": "0.1.5",
+    "version": "0.1.6",
     "icon": "media/logo.png",
     "author": {
         "name": "Salvatore Merone"

src/logging.ts

@@ -0,0 +1,47 @@
+// Copyright (C) 2023 Salvatore Merone
+//
+// This file is part of vscode.manpages.
+//
+// vscode.manpages is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// vscode.manpages is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with vscode.manpages.  If not, see <http://www.gnu.org/licenses/>.
+
+import {ExtensionContext, window, OutputChannel, Range, Selection, Position} from 'vscode';
+
+const LoggingChannelName = 'Manpages';
+
+export class Logging {
+    private static _channel: OutputChannel;
+
+    constructor(context: ExtensionContext) {
+        if(!Logging._channel) {
+            Logging._channel = window.createOutputChannel(LoggingChannelName);
+            context.subscriptions.push(Logging._channel);
+        }
+    }
+
+    public log(message: string): void {
+        Logging._channel.appendLine(message);
+    }
+
+    public printRange(range: Range): string {
+        return `${this.printPosition(range.start)}-${this.printPosition(range.end)}`;
+    }
+
+    public printSelection(selection: Selection): string {
+        return `${this.printPosition(selection.start)}-${this.printPosition(selection.end)}`;
+    }
+
+    public printPosition(position: Position): string {
+        return `${position.line}:${position.character}`;
+    }
+}

src/manpageContentProvider.ts

@@ -19,11 +19,12 @@ import * as vscode from 'vscode';
 import { MAN_COMMAND_REGEX } from './consts';
 import ManpageDocument from './manpageDocument';
 import child_process = require('child_process');
+import { Logging } from './logging';
 
 export class ManpageContentView {
     constructor(context: vscode.ExtensionContext) {
-
-        const provider = new ManpageContentProvider();
+        const logger = new Logging(context);
+        const provider = new ManpageContentProvider(context);
 
         // register content provider
         const providerRegistrations = vscode.Disposable.from(
@@ -35,16 +36,20 @@ export class ManpageContentView {
 
 
         const openFromSelection = vscode.commands.registerTextEditorCommand('manpages.openFromSelection', (editor) => {
+            logger.log(`openFromSelection called with selection: ${editor.selection.isEmpty ? 'empty' : 'not empty'}`);
             if (editor.selection.isEmpty) return;
             let text = editor.document.getText(editor.selection);
+            logger.log(`openFromSelection selection: ${logger.printSelection(editor.selection)}, text: ${text}`);
             return openManPage(text, openInActiveColumn);
         });
 
         const openFromCursor = vscode.commands.registerTextEditorCommand('manpages.openFromCursor', (editor) => {
+            logger.log(`openFromCursor called with selection: ${editor.selection.isEmpty ? 'empty' : 'not empty'}`);
             if (!editor.selection.isEmpty) return;
             const wordRange = editor.document.getWordRangeAtPosition(editor.selection.active, MAN_COMMAND_REGEX);
             if (!wordRange) { return; }
             let text = editor.document.getText(wordRange);
+            logger.log(`openFromCursor wordRange: ${logger.printRange(wordRange)}, text: ${text}`);
             return openManPage(text, openInActiveColumn);
         });
 
@@ -57,6 +62,7 @@ export class ManpageContentView {
                 }
             });
 
+            logger.log(`openFromInput called with text: ${result}`);
             if (result) {
                 return openManPage(result, openInActiveColumn);
             }
@@ -78,12 +84,13 @@ export class ManpageContentProvider implements vscode.TextDocumentContentProvide
     private _documents = new Map<string, ManpageDocument>();
     private _editorDecoration = vscode.window.createTextEditorDecorationType({ textDecoration: 'underline' });
     private _subscriptions: vscode.Disposable;
+    private _logger: Logging;
 
-    constructor() {
-
+    constructor(context: vscode.ExtensionContext) {
         // Listen to the `closeTextDocument`-event which means we must
         // clear the corresponding model object - `ReferencesDocument`
         this._subscriptions = vscode.workspace.onDidCloseTextDocument(doc => this._documents.delete(doc.uri.toString()));
+        this._logger = new Logging(context);
     }
 
     dispose(): void {
@@ -118,6 +125,7 @@ export class ManpageContentProvider implements vscode.TextDocumentContentProvide
         let section = m[2];
 
         let cmd = this.buildCmdline(section, word);
+        this._logger.log(`Executing command: ${cmd}`);
 
         return new Promise((resolve) => {
             child_process.exec(cmd, (err, stdout, stderr) => {