Release v0.2.1

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes will be documented in this file.
 
 Contributors: This document uses style guidelines from [Keep A Changelog](http://keepachangelog.com/).
 
+## [v0.2.1] - 2021-07-25
+
+### Changed
+
+- More consistent colorization.  Comments and variables are tokenized before generic alpha-numeric addresses.
+
 ## [v0.2.0] - 2021-05-09
 
 ### Added
@@ -12,7 +18,7 @@ Contributors: This document uses style guidelines from [Keep A Changelog](http:/
 
 ### Changed
 
-- The active document is now being scanned for inline comments on file save event in addition to the activation event that was used initially.  In the future listener for the document activation event may be removed, it remains in the codebase for now.
+- The active document is now being scanned for inline comments on file save event in addition to the activation event that was used initially.  In the future, the listener for the document activation event may be removed, but that remains unchanged for now.
 
 ## [v0.1.3] - 2021-02-06
 

README.md

@@ -64,7 +64,7 @@ Examples of inline definitions:
 
 When providing definitions, regardless of which method you use, don't use leading zeros. Provide a definition for `G1` not `G01`.  When you hover over a code like `G01` the extension ignores the leading zero and returns a definition for `G1`.
 
-##### Using the dictionary
+#### Using the dictionary
 
 **<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> `>G-Code: Show the dictionary`**
 

assets/gcode.tmLanguage.json

@@ -5,6 +5,12 @@
   "foldingStartMarker": "^O([A-Z0-9]{1,4})(?=\\s|$|\\()",
   "foldingStopMarker": "^RTS$",
   "patterns": [
+    {
+      "include": "#comments"
+    },
+    {
+      "include": "#variables"
+    },
     {
       "include": "#sub-programs"
     },
@@ -19,12 +25,6 @@
     },
     {
       "include": "#address-decimal"
-    },
-    {
-      "include": "#variables"
-    },
-    {
-      "include": "#comments"
     }
   ],
   "repository": {
@@ -323,13 +323,13 @@
     "comments": {
       "patterns": [
         {
-          "name": "comment.parens.gcode",
+          "name": "punctuation.definition.tag",
           "begin": "\\(",
           "end": "\\)",
           "contentName": "punctuation.definition.tag"
         },
         {
-          "name": "comment.semi-colon.gcode",
+          "name": "punctuation.definition.tag",
           "begin": "\\;",
           "end": "$",
           "contentName": "punctuation.definition.tag"

package.json

@@ -3,7 +3,7 @@
     "name": "gcode",
     "displayName": "G-Code",
     "description": "The premier Visual Studio Code extension for G-Code",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "preview": true,
     "author": {
         "name": "Scott M. Wyant",

src/hoverProvider/dictionary.ts → src/dictionaryService/dictionary.ts

@@ -1,10 +1,11 @@
+import { IDictionary } from './index'
 import { commands, ExtensionContext, ViewColumn, WebviewPanel, window, workspace } from 'vscode'
 
 interface Definitions {
     [key: string]: string
 }
 
-export class Dictionary {
+export class Dictionary implements IDictionary {
 
     private definitionsFromSettings: Definitions = {};
     private definitionsFromComments: Definitions = {};

src/dictionaryService/index.ts

@@ -0,0 +1,9 @@
+import { ExtensionContext } from 'vscode'
+import { Dictionary } from './dictionary'
+
+
+export interface IDictionary {
+    lookup: (word: string) => string
+}
+
+export const start = (context: ExtensionContext) => new Dictionary(context)

src/extension.ts

@@ -2,10 +2,12 @@ import { ExtensionContext } from 'vscode';
 import * as commands from './commands'
 import * as hoverProvider from './hoverProvider'
 import * as grammar from './grammar'
+import * as dictionaryService from './dictionaryService'
 
 export function activate(context: ExtensionContext) {
 
+    const dictionary = dictionaryService.start(context)
     commands.register(context);
-    hoverProvider.register(context);
+    hoverProvider.register(context, dictionary);
     grammar.register(context);
 }

src/grammar/gcode.tmLanguage.json

@@ -5,6 +5,12 @@
   "foldingStartMarker": "^O([A-Z0-9]{1,4})(?=\\s|$|\\()",
   "foldingStopMarker": "^RTS$",
   "patterns": [
+    {
+      "include": "#comments"
+    },
+    {
+      "include": "#variables"
+    },
     {
       "include": "#sub-programs"
     },
@@ -19,12 +25,6 @@
     },
     {
       "include": "#address-decimal"
-    },
-    {
-      "include": "#variables"
-    },
-    {
-      "include": "#comments"
     }
   ],
   "repository": {
@@ -323,13 +323,13 @@
     "comments": {
       "patterns": [
         {
-          "name": "comment.parens.gcode",
+          "name": "replace.comment",
           "begin": "\\(",
           "end": "\\)",
           "contentName": "replace.comment"
         },
         {
-          "name": "comment.semi-colon.gcode",
+          "name": "replace.comment",
           "begin": "\\;",
           "end": "$",
           "contentName": "replace.comment"

src/hoverProvider/gcodeHoverProvider.ts

@@ -1,11 +1,11 @@
 import { CancellationToken, Hover, HoverProvider, Position, ProviderResult, TextDocument} from 'vscode'
-import { Dictionary } from './dictionary'
+import { IDictionary } from '../dictionaryService'
 
 export class gcodeHoverProvider implements HoverProvider {
 
-    private dictionary: Dictionary
+    private dictionary: IDictionary
 
-    constructor(dictionary: Dictionary){
+    constructor(dictionary: IDictionary){
         this.dictionary = dictionary
     }
 

src/hoverProvider/index.ts

@@ -1,10 +1,8 @@
 import { ExtensionContext, languages } from 'vscode';
 import { gcodeHoverProvider } from './gcodeHoverProvider';
-import { Dictionary } from './dictionary'
+import { IDictionary } from '../dictionaryService'
 
-export function register(context: ExtensionContext) {
-
-    const dictionary = new Dictionary(context);
+export function register(context: ExtensionContext, dictionary: IDictionary) {
 
     context.subscriptions.push(
         languages.registerHoverProvider('gcode', new gcodeHoverProvider(dictionary))