Refactored commands to use enum to load

Author: mikecentola

package.json

@@ -60,9 +60,14 @@
         "onLanguage:gcode",
         "onView:gcode.gcodeTree",
         "onView:gcode.gcodeStats",
+        "onCommand:gcode.addComment",
+        "onCommand:gcode.addLineNumbers",
+        "onCommand:gcode.removeComment",
+        "onCommand:gcode.removeLineNumbers",
+        "onCommand:gcode.showSettings",
+        "onCommand:gcode.supportGCode",
         "onCommand:gcode.views.navTree.refresh",
-        "onCommand:gcode.views.stats.refresh",
-        "onCommand:gcode.supportGCode"
+        "onCommand:gcode.views.stats.refresh"
     ],
     "capabilities": {
         "virtualWorkspaces": true
@@ -353,38 +358,63 @@
             ],
             "commandPalette": [
                 {
-                    "command": "gcode.views.navTree.refresh",
-                    "when": "true"
+                    "command": "gcode.addComment",
+                    "when": "editorLangId == gcode"
                 },
                 {
-                    "command": "gcode.views.stats.refresh",
+                    "command": "gcode.addLineNumbers",
+                    "when": "editorLangId == gcode"
+                },
+                {
+                    "command": "gcode.removeComment",
+                    "when": "editorLangId == gcode"
+                },
+                {
+                    "command": "gcode.removeLineNumbers",
+                    "when": "editorLangId == gcode"
+                },
+                {
+                    "command": "gcode.showSettings",
                     "when": "true"
                 },
                 {
                     "command": "gcode.supportGCode",
                     "when": "false"
+                },
+                {
+                    "command": "gcode.views.navTree.refresh",
+                    "when": "editorLangId == gcode"
+                },
+                {
+                    "command": "gcode.views.stats.refresh",
+                    "when": "editorLangId == gcode"
                 }
             ],
             "editor/context": [
                 {
-                    "when": "resourceLangId == gcode",
+                    "when": "editorLangId == gcode",
                     "command": "gcode.views.navTree.refresh",
                     "group": "gcode"
                 },
                 {
-                    "when": "resourceLangId == gcode",
+                    "when": "editorLangId == gcode",
                     "command": "gcode.views.stats.refresh",
                     "group": "gcode"
                 },
                 {
-                    "when": "resourceLangId == gcode",
+                    "when": "editorLangId == gcode",
                     "command": "gcode.addComment",
                     "group": "gcode"
                 },
                 {
-                    "when": "resourceLangId == gcode",
+                    "when": "editorLangId == gcode",
                     "command": "gcode.removeComment",
                     "group": "gcode"
+                },
+                {
+                    "when": "editorLangId == gcode",
+                    "command": "gcode.showSettings",
+                    "group": "gcode"
                 }
             ]
         },

src/control.ts

@@ -12,15 +12,15 @@ import { StatusBarControl } from './util/statusBar';
 import { NavTreeView } from './views/navTreeView';
 import { GCodeUnitsController } from './gcodeUnits';
 import { StatsView } from './views/statsView';
-import { constants, Contexts, PIcon, VSBuiltInCommands } from './util/constants';
-import { UtilCommands } from './util/commands/common';
+import { constants, Contexts, GCommands, PIcon, VSBuiltInCommands } from './util/constants';
 import { Version } from './util/version';
 import { Messages } from './util/messages';
 import { StateControl } from './util/stateControl';
 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';
 
 const cfgUnits = 'general.units';
 const cfgAutoRef = {
@@ -32,6 +32,7 @@ export class Control {
     private static _config: Config | undefined;
     private static _context: ExtensionContext;
     private static _units: string | undefined;
+    private static _version: Version;
 
     // Controllers
     private static _machineTypeControl: MachineTypeControl | undefined;
@@ -75,9 +76,16 @@ export class Control {
 
     // Static Methods
     static initialize(context: ExtensionContext, config: Config) {
+        // Initialize G-Code Extension
         this._context = context;
         this._config = config;
 
+        // Initialze Configuration
+        Config.initialize(this._context, this._config);
+
+        // Register Commands
+        context.subscriptions.push(...registerCommands());
+
         // Load StatusBars
         context.subscriptions.push((this._statusBarControl = new StatusBarControl()));
 
@@ -136,7 +144,7 @@ export class Control {
             'support',
             'Support G-Code Syntax ❤',
             undefined,
-            UtilCommands.ShowSupportGCode,
+            GCommands.ShowSupportGCode,
         );
 
         // Check Version

src/extension.ts

@@ -4,10 +4,9 @@
  * -------------------------------------------------------------------------------------------- */
 'use strict';
 import { ExtensionContext } from 'vscode';
-import { Config, configuration } from './util/configuration/config';
+import { configuration } from './util/configuration/config';
 import { constants } from './util/constants';
 import { Logger } from './util/logger';
-import { registerCommands } from './util/commands';
 import { Control } from './control';
 
 export function activate(context: ExtensionContext) {
@@ -17,13 +16,6 @@ export function activate(context: ExtensionContext) {
     Logger.initialize(context);
     Logger.enable();
 
-    // Initialize Config
-    const cfg = configuration;
-    Config.initialize(context, cfg);
-
-    // Register Commands
-    void registerCommands(context);
-
     // Initialize Controller
     Control.initialize(context, configuration);
 

src/gcodeUnits.ts

@@ -6,9 +6,9 @@
 
 import { ConfigurationChangeEvent, Disposable, TextDocumentChangeEvent, TextEditor, window, workspace } from 'vscode';
 import { Control } from './control';
-import { UtilCommands } from './util/commands/common';
 import { configuration } from './util/configuration/config';
 import { defaults } from './util/configuration/defaults';
+import { GCommands } from './util/constants';
 import { Logger } from './util/logger';
 import { StatusBar, StatusBarControl } from './util/statusBar';
 
@@ -39,7 +39,7 @@ export class GCodeUnitsController implements Disposable {
             this.unitsStatusBar,
             undefined,
             undefined,
-            UtilCommands.ShowGCodeSettings,
+            GCommands.ShowGCodeSettings,
         );
 
         Control.context.subscriptions.push(configuration.onDidChange(this.onConfigurationChanged, this));
@@ -61,7 +61,7 @@ export class GCodeUnitsController implements Disposable {
                     this.unitsStatusBar,
                     undefined,
                     undefined,
-                    UtilCommands.ShowGCodeSettings,
+                    GCommands.ShowGCodeSettings,
                 );
             } else {
                 Logger.log(`Units: ${this._units}`);
@@ -71,7 +71,7 @@ export class GCodeUnitsController implements Disposable {
                     this.unitsStatusBar,
                     undefined,
                     undefined,
-                    UtilCommands.ShowGCodeSettings,
+                    GCommands.ShowGCodeSettings,
                 );
             }
         }
@@ -91,7 +91,7 @@ export class GCodeUnitsController implements Disposable {
                     this.unitsStatusBar,
                     undefined,
                     undefined,
-                    UtilCommands.ShowGCodeSettings,
+                    GCommands.ShowGCodeSettings,
                 );
             } else {
                 return;
@@ -112,7 +112,7 @@ export class GCodeUnitsController implements Disposable {
                     this.unitsStatusBar,
                     undefined,
                     undefined,
-                    UtilCommands.ShowGCodeSettings,
+                    GCommands.ShowGCodeSettings,
                 );
             } else {
                 return;

src/util/commands.ts

@@ -6,12 +6,12 @@
 'use strict';
 
 import { Range, window } from 'vscode';
-import { constants } from '../constants';
-import { GCommand, UtilCommands } from './common';
+import { constants, GCommands } from '../constants';
+import { GCommand } from './base';
 
 export class AddComment extends GCommand {
     constructor() {
-        super(UtilCommands.AddComment);
+        super(GCommands.AddComment);
     }
 
     execute() {

src/util/commands/addComment.ts

@@ -6,13 +6,14 @@
 'use strict';
 
 import { configuration } from '../configuration/config';
+import { GCommands } from '../constants';
 import { LineNumberer, LineNumbererOptions } from '../lineNumberer';
 import { LineNumbersInput } from '../quickpicks/lineNumbers';
-import { GCommand, UtilCommands } from './common';
+import { GCommand } from './base';
 
 export class AddLineNumbers extends GCommand {
     constructor() {
-        super(UtilCommands.AddLineNumbers);
+        super(GCommands.AddLineNumbers);
     }
 
     async execute() {

src/util/commands/addLineNumbers.ts

@@ -6,23 +6,22 @@
 'use strict';
 
 import { commands, Disposable } from 'vscode';
-
-export const enum UtilCommands {
-    ShowGCodeSettings = 'gcode.showSettings',
-    ShowSupportGCode = 'gcode.supportGCode',
-    AddComment = 'gcode.addComment',
-    RemoveComment = 'gcode.removeComment',
-    AddLineNumbers = 'gcode.addLineNumbers',
-    RemoveLineNumbers = 'gcode.removeLineNumbers',
-}
+import { GCommands } from '../constants';
 
 export abstract class GCommand implements Disposable {
-    private _disposable: Disposable;
+    private readonly _disposable: Disposable;
+
+    constructor(cmd: GCommands | GCommands[]) {
+        if (typeof cmd === 'string') {
+            this._disposable = commands.registerCommand(cmd, (...args: any[]) => this._execute(cmd, ...args), this);
 
-    constructor(cmd: UtilCommands) {
-        this._disposable = commands.registerCommand(cmd, (...args: any[]) => this._execute(cmd, ...args), this);
+            return;
+        }
 
-        return;
+        const subscriptions = cmd.map(cmd =>
+            commands.registerCommand(cmd, (...args: any[]) => this._execute(cmd, ...args), this),
+        );
+        this._disposable = Disposable.from(...subscriptions);
     }
 
     dispose() {

src/util/commands/common.ts src/util/commands/base.tssrc/util/commands/common.ts renamed to src/util/commands/base.ts

@@ -1,14 +1,13 @@
-/* eslint-disable max-classes-per-file */
 /* ---------------------------------------------------------------------------------------------
  *  Copyright (c) Applied Eng & Design All rights reserved.
  *  Licensed under the MIT License. See License.md in the project root for license information.
  * -------------------------------------------------------------------------------------------- */
 
 'use strict';
 
-export * from './addComment';
-export * from './removeComment';
-export * from './showGCodeSettings';
-export * from './showSupportGCode';
-export * from './addLineNumbers';
-export * from './removeLineNumbers';
+export { AddComment } from './addComment';
+export { AddLineNumbers } from './addLineNumbers';
+export { RemoveComment } from './removeComment';
+export { RemoveLineNumbers } from './removeLineNumbers';
+export { ShowGCodeSettings } from './showGCodeSettings';
+export { ShowSupportGCode } from './showSupportGCode';

src/util/commands/cmds.ts

@@ -0,0 +1,23 @@
+/* ---------------------------------------------------------------------------------------------
+ *  Copyright (c) Applied Eng & Design All rights reserved.
+ *  Licensed under the MIT License. See License.md in the project root for license information.
+ * -------------------------------------------------------------------------------------------- */
+
+'use strict';
+
+import { Disposable } from 'vscode';
+import { GCommands } from '../constants';
+import { GCommand } from './base';
+import * as Cmds from './cmds';
+
+export function registerCommands(): Disposable[] {
+    const gcmds: GCommand[] = [];
+
+    Object.values(Cmds).forEach(c => {
+        if (Object.keys(GCommands).includes(c.name)) {
+            gcmds.push(new c());
+        }
+    });
+
+    return gcmds;
+}