Merge pull request #48 from appliedengdesign/bugfix/linenumberer

Line Numberer Fix
appliedengdesign · Sep 23, 2022 · 91d9a26 · 91d9a26
2 parents dfe8a05 + 05af17b
commit 91d9a26
Show file tree

Hide file tree

Showing 17 changed files with 320 additions and 291 deletions.
diff --git a/README.md b/README.md
@@ -112,10 +112,15 @@ G-Code Syntax is customizable and provides many configuration settings to allow
 | `gcode.general.units`                     | Choose the units for the file. Options are Auto, Inch or Metric                        |
 | `gcode.general.outputLevel`               | Configure Output level for debugging purposes                                          |
 | `gcode.lineNumberer.addSpaceAfter`        | Add space after line number                                                            |
+| `gcode.lineNumberer.defaultIncrement`     | Default Line Numberer Increment                                                        |
+| `gcode.lineNumberer.defaultStart`         | Default Line Numberer Start                                                            |
+| `gcode.lineNumberer.enableQuickPick`      | Enable or Disable Input for the Line Numberer (Will use above defaults)                |
 | `gcode.lineNumberer.frequency`            | Frequency of line number additions (Every Line or at Tool Changes)                     |
 | `gcode.lineNumberer.ignoreBlank`          | Ignore Blank lines when numbering                                                      |
 | `gcode.lineNumberer.ignoreComments`       | Ignore Comments when numbering                                                         |
+| `gcode.lineNumberer.ignoreExtra`          | Additional characters to ignore (Beginning of Line, Default is %)                      |
 | `gcode.lineNumberer.ignoreProgramNumbers` | Ignore Program numbers, e.g. `O12345`                                                  |
+| `gcode.lineNumberer.matchLineNumber`      | When numbering, match the N number to file's line number. (Default is off)             |
 | `gcode.views.maxAutoRefresh`              | Value for limiting the autoRefresh maximum lines                                       |
 | `gcode.views.navTree.autoRefresh`         | Tree auto-refreshes as changes are made to the g-code. ( Disabled by default )         |
 | `gcode.views.stats.autoRefresh`           | Auto-refresh the stats view when changes are made to the g-code. (Disabled by default) |

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -239,6 +239,24 @@
                     "markdownDescription": "Add Space After Line Number",
                     "scope": "window"
                 },
+                "gcode.lineNumberer.defaultIncrement": {
+                    "type": "number",
+                    "default": 10,
+                    "markdownDescription": "Default Line Numberer Increment",
+                    "scope": "window"
+                },
+                "gcode.lineNumberer.defaultStart": {
+                    "type": "number",
+                    "default": 10,
+                    "markdownDescription": "Default Line Numberer Start",
+                    "scope": "window"
+                },
+                "gcode.lineNumbere.enableQuickPick": {
+                    "type": "boolean",
+                    "default": true,
+                    "markdownDescription": "Enable or Disable Input for Line Numberer (Will use above defaults).",
+                    "scope": "window"
+                },
                 "gcode.lineNumberer.frequency": {
                     "type": "string",
                     "default": "Every Line",
@@ -264,12 +282,29 @@
                     "markdownDescription": "Ignore Comments when Numbering",
                     "scope": "window"
                 },
+                "gcode.lineNumberer.ignoreExtra": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "default": [
+                        "%"
+                    ],
+                    "markdownDescription": "Additional characters to ignore (Beginning of Line)",
+                    "scope": "window"
+                },
                 "gcode.lineNumberer.ignoreProgramNumbers": {
                     "type": "boolean",
                     "default": true,
                     "markdownDescription": "Ignore program numbers, e.g. `O12345`",
                     "scope": "window"
                 },
+                "gcode.lineNumberer.matchLineNumber": {
+                    "type": "boolean",
+                    "default": false,
+                    "markdownDescription": "When numbering, match N number to file's line number.",
+                    "scope": "window"
+                },
                 "gcode.views.maxAutoRefresh": {
                     "type": "integer",
                     "default": "10000",

diff --git a/src/control.ts b/src/control.ts
@@ -20,7 +20,7 @@ import { CodesWebview } from './webviews/codesWebview';
 import { MachineTypeControl } from './util/machineType';
 import { GCodeHoverControl } from './hovers/gcodeHoverControl';
 import { defaults } from './util/configuration/defaults';
-import { registerCommands } from './util/commands/functions';
+import { registerCommands } from './util/commands';
 
 const cfgUnits = 'general.units';
 const cfgAutoRef = {
@@ -48,28 +48,26 @@ export class Control {
     // Webviews
     private static _codesWebview: CodesWebview | undefined;
 
-    private static async checkVersion() {
-        const gcodeVersion = new Version(constants.extension.version);
-
+    private static async _checkVersion() {
         const prevVer = this._stateController.getVersion();
 
-        const newVer = gcodeVersion.compareWith(prevVer.getVersion()) === 1 ? true : false;
+        const newVer = this._version.compareWith(prevVer.getVersion()) === 1 ? true : false;
 
         if (newVer) {
             // Extension has been updated
 
             // Update globalState version
             Logger.log('Updating...');
-            void this._stateController.updateVer(gcodeVersion);
+            await this._stateController.updateVer(this._version);
 
-            Logger.log(`G-Code upgraded from ${prevVer.getVersionAsString()} to ${gcodeVersion.getVersionAsString()}`);
-            await this.showWhatsNew(gcodeVersion);
+            Logger.log(`G-Code upgraded from ${prevVer.getVersionAsString()} to ${this._version.getVersionAsString()}`);
+            await this._showWhatsNew(this._version);
         } else {
             return;
         }
     }
 
-    private static async showWhatsNew(ver: Version) {
+    private static async _showWhatsNew(ver: Version) {
         // Show Whats New Message
         await Messages.showWhatsNewMessage(ver);
     }
@@ -79,23 +77,33 @@ export class Control {
         // Initialize G-Code Extension
         this._context = context;
         this._config = config;
+        this._version = new Version(constants.extension.version);
 
         // Initialze Configuration
+        Logger.log('Loading Configuration...');
         Config.initialize(this._context, this._config);
 
+        // Load State Controller
+        Logger.log('Loading State Controller...');
+        this._stateController = new StateControl(context);
+
+        // Check Version
+        Logger.log('Checking Version...');
+        void this._checkVersion();
+
         // Register Commands
+        Logger.log('Registering Commands...');
         context.subscriptions.push(...registerCommands());
 
         // Load StatusBars
         context.subscriptions.push((this._statusBarControl = new StatusBarControl()));
 
         // Load Machine Type
+        Logger.log('Loading Machine Type Controller...');
         context.subscriptions.push((this._machineTypeControl = new MachineTypeControl()));
 
-        // Load State Controller
-        this._stateController = new StateControl(context);
-
         // Load Hover Controller
+        Logger.log('Loading Hover Controller...');
         context.subscriptions.push((this._hoverController = new GCodeHoverControl()));
 
         // Units
@@ -125,7 +133,6 @@ export class Control {
 
         // Load Nav Tree
         Logger.log('Loading Nav Tree...');
-
         context.subscriptions.push((this._navTree = new NavTreeView()));
 
         Logger.log(
@@ -147,11 +154,10 @@ export class Control {
             GCommands.ShowSupportGCode,
         );
 
-        // Check Version
-        void this.checkVersion();
-
         // Set Up Webviews
         context.subscriptions.push((this._codesWebview = new CodesWebview()));
+
+        Logger.log('Done Initializing.');
     }
 
     static terminate() {
@@ -186,6 +192,10 @@ export class Control {
         return this._config;
     }
 
+    static get version() {
+        return this._version;
+    }
+
     static get machineType() {
         return this._machineTypeControl;
     }

diff --git a/src/extension.ts b/src/extension.ts
@@ -16,6 +16,8 @@ export function activate(context: ExtensionContext) {
     Logger.initialize(context);
     Logger.enable();
 
+    Logger.log('Initializing G-Code...');
+
     // Initialize Controller
     Control.initialize(context, configuration);
 

diff --git a/src/hovers/gcodeHoverControl.ts b/src/hovers/gcodeHoverControl.ts
@@ -22,7 +22,7 @@ export class GCodeHoverControl implements Disposable {
         this._enabled = <boolean>configuration.getParam('general.hovers.enabled');
 
         if (this._enabled) {
-            Logger.log('Loading Hover Controller...');
+            Logger.log('Hovers: Enabled');
             this.register(window.activeTextEditor);
         }
     }
@@ -36,11 +36,11 @@ export class GCodeHoverControl implements Disposable {
         if (configuration.changed(e, 'general.hovers.enabled')) {
             if (this._enabled) {
                 // Disable and Dispose
-                Logger.log('Disabling Hover Controller...');
+                Logger.log('Hovers: Disabled');
                 this.unregister();
             } else {
                 // Enable
-                Logger.log('Enabling Hover Controller...');
+                Logger.log('Hovers: Enabled');
                 this.register(window.activeTextEditor);
             }
         }

diff --git a/src/util/commands/addComment.ts b/src/util/commands/addComment.ts
@@ -7,14 +7,15 @@
 
 import { Range, window } from 'vscode';
 import { constants, GCommands } from '../constants';
+import { Messages } from '../messages';
 import { GCommand } from './base';
 
 export class AddComment extends GCommand {
     constructor() {
         super(GCommands.AddComment);
     }
 
-    execute() {
+    async execute() {
         const editor = window.activeTextEditor;
         let replace = '';
 
@@ -34,9 +35,11 @@ export class AddComment extends GCommand {
                 replace += `(${lines[i]})${i + 1 === lines.length ? '' : '\n'}`;
             }
 
-            void editor.edit(editBuilder => {
+            await editor.edit(editBuilder => {
                 editBuilder.replace(select, replace);
             });
+        } else {
+            await Messages.showErrorMessage('Editor does not contain G-Code');
         }
     }
 }
diff --git a/src/util/commands/addLineNumbers.ts b/src/util/commands/addLineNumbers.ts
@@ -7,7 +7,7 @@
 
 import { configuration } from '../configuration/config';
 import { GCommands } from '../constants';
-import { LineNumberer, LineNumbererOptions } from '../lineNumberer';
+import { LineNumberer } from '../lineNumberer';
 import { LineNumbersInput } from '../quickpicks/lineNumbers';
 import { GCommand } from './base';
 
@@ -17,18 +17,15 @@ export class AddLineNumbers extends GCommand {
     }
 
     async execute() {
-        const lnInputs = new LineNumbersInput();
-        const state = await lnInputs.collect();
-
-        const opts: LineNumbererOptions = {};
+        const ln = new LineNumberer();
 
-        opts.addSpaceAfter = configuration.getParam('lineNumberer.addSpaceAfter');
-        opts.frequency = configuration.getParam('lineNumberer.frequency');
-        opts.ignoreBlank = configuration.getParam('lineNumberer.ignoreBlank');
-        opts.ignoreComments = configuration.getParam('lineNumberer.ignoreComments');
-        opts.ignoreProgramNumbers = configuration.getParam('lineNumberer.ignoreProgramNumbers');
+        if (configuration.getParam('lineNumberer.enableQuickPick')) {
+            const lnInputs = new LineNumbersInput();
+            const state = await lnInputs.collect();
 
-        const ln = new LineNumberer();
-        await ln.addNumbers(state.start, state.increment, true, opts);
+            await ln.addNumbers(state.start, state.increment);
+        } else {
+            await ln.addNumbers();
+        }
     }
 }
diff --git a/src/util/commands/functions.ts b/src/util/commands/functions.ts
diff --git a/src/util/commands/cmds.ts → src/util/commands/index.ts b/src/util/commands/cmds.ts → src/util/commands/index.ts
@@ -5,9 +5,28 @@
 
 'use strict';
 
+import { Disposable } from 'vscode';
+import { AddComment } from './addComment';
+import { AddLineNumbers } from './addLineNumbers';
+import { RemoveComment } from './removeComment';
+import { RemoveLineNumbers } from './removeLineNumbers';
+import { ShowGCodeSettings } from './showGCodeSettings';
+import { ShowSupportGCode } from './showSupportGCode';
+
 export { AddComment } from './addComment';
 export { AddLineNumbers } from './addLineNumbers';
 export { RemoveComment } from './removeComment';
 export { RemoveLineNumbers } from './removeLineNumbers';
 export { ShowGCodeSettings } from './showGCodeSettings';
 export { ShowSupportGCode } from './showSupportGCode';
+
+export function registerCommands(): Disposable[] {
+    return [
+        new AddComment(),
+        new AddLineNumbers(),
+        new RemoveComment(),
+        new RemoveLineNumbers(),
+        new ShowGCodeSettings(),
+        new ShowSupportGCode(),
+    ];
+}
diff --git a/src/util/commands/removeLineNumbers.ts b/src/util/commands/removeLineNumbers.ts
@@ -16,6 +16,6 @@ export class RemoveLineNumbers extends GCommand {
 
     async execute() {
         const ln = new LineNumberer();
-        await ln.removeNumbers(true);
+        await ln.removeNumbers();
     }
 }
diff --git a/src/util/configuration/defaults.ts b/src/util/configuration/defaults.ts
@@ -7,7 +7,7 @@
 
 import { StatusBarAlignment } from 'vscode';
 import { GCodeUnits } from '../../gcodeUnits';
-import { LineNumberFrequency } from '../lineNumberer';
+import { LineNumbererOptions, LineNumberFrequency } from '../lineNumberer';
 
 export enum TraceLevel {
     Silent = 'silent',
@@ -35,12 +35,7 @@ export interface GCodeConfiguration {
         outputLevel: TraceLevel;
     };
 
-    lineNumberer: {
-        addSpaceAfter: boolean;
-        frequency: LineNumberFrequency;
-        ignoreBlank: boolean;
-        ignoreProgramNumbers: boolean;
-    };
+    lineNumberer: LineNumbererOptions;
 
     views: {
         maxAutoRefresh: number;
@@ -74,9 +69,16 @@ export const defaults: GCodeConfiguration = {
     },
     lineNumberer: {
         addSpaceAfter: true,
+        defaultIncrement: 10,
+        defaultStart: 10,
+        enableQuickPick: true,
         frequency: LineNumberFrequency.EveryLine,
         ignoreBlank: true,
+        ignoreComments: true,
+        ignoreExtra: [],
         ignoreProgramNumbers: true,
+        matchLineNumber: false,
+        showProgress: true,
     },
     views: {
         maxAutoRefresh: 10000,