Merge branch 'develop'

Author: iSorp

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1  (July 14, 2020)
+- node module languageserver/client update
+- Multiline keyword description
+
 ## 0.2.0  (July 12, 2020)
 - Multi-Root Workspace
 - Custom Keywords (symbol, semantic scope, description)

README.md

@@ -12,7 +12,7 @@ Fanuc Macro Executor syntax highlighting, validating and project building
 
 ## News
 - [Multi-Root Workspaces](#multi-root-workspaces)
-- [Custom Keywords](#Customization)
+- [Custom Keywords](#custom-Keywords)
 
 ***
        
@@ -89,7 +89,7 @@ The global / local search behavior is equal to the reference search.
 
 Semantic highlighting is used to highlight the represented type of a symbol. Following types are supported:
 * M-Code and G-Code
-* PMC Address
+* Address
 * Macro variable
 * Constant
 * Label
@@ -109,7 +109,7 @@ For some color themes, the semantic highlighting must be enabled in the settings
 
 *The color theme used in screenshot →* **[Noctis](https://marketplace.visualstudio.com/items?itemName=liviuschera.noctis#review-details)**
 
-## Customization
+## Custom Keywords
 
 * Symbol highlighting
 * Symbol description for hover and completion
@@ -123,10 +123,10 @@ Such a customization can be achieved by adding custom keyword items to the confi
 | symbol      | Symbol text                |
 | scope       | [Scopes](#Scopes)           |
 | nodeType    | Label, Code (M/G), Variable (all @ symbols)   |
-| description | Markdown string            |
+| description | Markdown `string` \| `string[]`   |
 
 
-The field `nodeType` defines the related type in the macro program. If the field is empty, a keyword item affects all symbol occurrences regardless of the symbols type. E.g. if you want to add a hower text to a particular P-Code variable, an item could be structed as follows:
+The field `nodeType` defines the related type in the macro program. If the field is empty, a keyword item affects all symbol occurrences regardless of the symbols type. E.g. if you want to add a hover text to a particular P-Code variable, an item could be structed as follows:
 
 ```json
 {
@@ -149,7 +149,7 @@ The field `nodeType` defines the related type in the macro program. If the field
 | address   | Address                                      |
 
 
- These scopes are used internally and are responsible for the colorization which depends on the chosen color theme like **[Noctis](https://marketplace.visualstudio.com/items?itemName=liviuschera.noctis#review-details)**. To override the colorization just add **[rules](https://github.com/microsoft/vscode/wiki/Semantic-Highlighting-Overview#as-a-theme-author-do-i-need-to-change-my-theme-to-make-it-work-with-semantic-highlighting)** to the `editor.semanticTokenColorCustomizations` configuration property.
+ These scopes are used internally and are responsible for the symbol style which depends on the chosen color theme like **[Noctis](https://marketplace.visualstudio.com/items?itemName=liviuschera.noctis#review-details)**. To override the style just add **[rules](https://github.com/microsoft/vscode/wiki/Semantic-Highlighting-Overview#as-a-theme-author-do-i-need-to-change-my-theme-to-make-it-work-with-semantic-highlighting)** to the `editor.semanticTokenColorCustomizations` configuration property.
 
 In case the default scopes should be unchanged, the additional custom scopes `custom_1` - `custom_5` could be used:
 
@@ -163,7 +163,7 @@ The following example changes the symbol `M08`, which has a default scope `code`
        {
               "symbol": "M08",
               "scope": "custom_1",
-              "description": "*Coolant*"
+              "description": ["*Coolant*", "ON"]
        }
 ],
 
@@ -228,6 +228,7 @@ Three levels are supported: `error`, `warning` and `ignore`.
 
 This extension contributes the following settings:
 
+* `macro.keywords` : [Custom Keywords](#custom-Keywords)
 * `macro.lint`: Lint settings and rule configuration
 * `macro.sequence.base`: Sequences start number for refactoring
 * `macro.sequence.increment`: Sequences increment for refactoring

client/package-lock.json

@@ -13,7 +13,7 @@
 		"vscode": "^1.45.1"
 	},
 	"dependencies": {
-		"vscode-languageclient": "7.0.0-next.1",
+		"vscode-languageclient": "7.0.0-next.5",
 		"rxjs": "^6.5.5",
 		"vscode-nls": "^4.1.2"
 	},

client/package.json

@@ -7,11 +7,12 @@ import {
 	LanguageClient, LanguageClientOptions, 
 	ServerOptions, TransportKind, RevealOutputChannelOn,
 	ExecuteCommandSignature, WorkspaceFolder
-} from 'vscode-languageclient';
+} from 'vscode-languageclient/node';
+
 
 import * as ls from 'vscode-languageserver-protocol';
 
-import { SemanticTokensFeature, DocumentSemanticsTokensSignature } from 'vscode-languageclient/lib/semanticTokens.proposed';
+import { SemanticTokensFeature, DocumentSemanticsTokensSignature } from 'vscode-languageclient/lib/common/semanticTokens.proposed';
 import registerCommands from './common/commands';
 
 import CompositeDisposable from './common/compositeDisposable';

client/src/extension.ts

@@ -9,7 +9,17 @@
 
 	"macro.keywords": [
 
-		{"symbol": "10000", "scope":"number", "nodeType": "Variable", "description": "Base address"},
+		{
+			"symbol": "10000", 
+			"scope":"number", 
+			"nodeType": "Variable", 
+			"description": [
+				"# some",
+				"*markdown*",
+				"text",
+				"lines"
+			]
+		},
 
 		{"symbol": "ret_arg", "scope":"symbol", "nodeType": "Variable"},
 		{"symbol": "error_1", "scope":"custom_2", "nodeType": "Variable"},

doc/settings.example.json

@@ -2,7 +2,7 @@
 	"name": "macro-executor",
 	"displayName": "Macro Executor Language",
 	"description": "Fanuc Macro-Executor Programming Language",
-	"version": "0.2.0",
+	"version": "0.2.1",
 	"author": "iSorp",
 	"publisher": "iSorp",
 	"license": "MIT",
@@ -142,26 +142,25 @@
 			"properties": {
 				"macro.keywords": {
 					"scope": "resource",
-					"type" : "array",
+					"type": "array",
 					"description": "custom keywords",
 					"items": {
-						"type" :"object",
-						"default" : {
+						"type": "object",
+						"default": {
 							"symbol": "special symbol",
-							"scope": "variable",
+							"scope": "macrovar",
 							"description": "this text will be shown on hover and completion"
 						},
-						"properties" : { 
-							"type" : "object",
+						"properties": {
+							"type": "object",
 							"symbol": {
-								"type" : "string"
+								"type": "string"
 							},
 							"scope": {
-								"type" : "string",
-								"enum": [		
+								"type": "string",
+								"enum": [
 									"number",
 									"macrovar",
-									"symbol",
 									"constant",
 									"language",
 									"label",
@@ -175,12 +174,10 @@
 									"custom_5"
 								]
 							},
-							"description": {
-								"type" : "string"
-							},
-							"nodeType" : {
-								"type" : "string",
-								"enum": [		
+							"description": {},
+							"nodeType": {
+								"type": "string",
+								"enum": [
 									"",
 									"Label",
 									"Variable",

package-lock.json

@@ -13,7 +13,7 @@
 		"url": "https://github.com/iSorp/macro-executor.git"
 	},
 	"dependencies": {
-		"vscode-languageserver": "7.0.0-next.1",
+		"vscode-languageserver": "7.0.0-next.3",
 		"vscode-languageserver-textdocument": "^1.0.1",
 		"vscode-nls": "^4.1.2",
 		"vscode-uri": "^2.1.2",