Local LSP server that improves functionality like item completion

.gitignore

@@ -2,4 +2,9 @@ out
 node_modules
 *.vsix
 *.todo
-*.zip
+*.zip
+**/out
+**/node_modules
+.vscode
+.vscode-test
+coverage

.vscode/launch.json

@@ -10,7 +10,7 @@
             "args": ["--extensionDevelopmentPath=${workspaceRoot}" ],
             "stopOnEntry": false,
             "sourceMaps": true,
-            "outFiles": [ "${workspaceRoot}/out/src/**/*.js" ],
+            "outFiles": [ "${workspaceRoot}/**/out/**/*.js" ],
             "preLaunchTask": "npm"
         },
         {
@@ -23,6 +23,19 @@
             "sourceMaps": true,
             "outFiles": [ "${workspaceRoot}/out/test/**/*.js" ],
             "preLaunchTask": "npm"
+        },
+        {
+            "type": "node",
+            "name": "lsp-server-jest-tests",
+            "request": "launch",
+            "program": "${workspaceFolder}/serverJS/node_modules/jest/bin/jest",
+            "args": [
+                "--runInBand",
+                "--detectOpenHandles"
+            ],
+            "cwd": "${workspaceFolder}/serverJS",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
         }
     ]
 }

CHANGELOG.md

@@ -1,5 +1,12 @@
 # openHAB VS Code Extension Change Log
 
+## 0.5.0 - TBD
+- Added local LSP server (#122)
+- Fixed sorting order in items explorer (#125)
+- removed settings param 'restCompletions'
+- renamed settings param 'lspEnabled' to 'remoteLspEnabled'
+- renamed settings param 'lspPort' to 'remoteLspPort'
+
 ## 0.4.1 - 2018-12-09
 - Fixed Basic UI Preview (#117)
 - Fixed Show in Paper UI command (#117)

README.md

@@ -85,14 +85,14 @@ In the unlikely case that your language server is running on a port other than t
 
 ```json
 {
-	"openhab.lspPort": 5007
+	"openhab.remoteLspPort": 5007
 }
 ```
 
 If you don't want to have your openHAB files validated by Language Server, simply disable it in the extension:
 ```json
 {
-	"openhab.lspEnabled": false
+	"openhab.remoteLspEnabled": false
 }
 ```
 
@@ -107,7 +107,7 @@ The following configuration will allow you to access REST API remotely:
 ```
     "openhab.host": "https://home.myopenhab.org",
     "openhab.port": 80,
-    "openhab.lspEnabled": false,
+    "openhab.remoteLspEnabled": false,
     "openhab.username": "your_myopenhab_email",
     "openhab.password": "your_myopenhab_password",
 ```

client/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "openhab-vscode-extension",
+    "displayName": "openHAB Visual Studio Code Extension",
+    "description": "Robust tool for openHAB textual configurations. Includes code snippets, syntax highlighting, language server integration and more.",
+    "version": "0.4.1",
+    "publisher": "openhab",
+    "icon": "../openhab.png",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/openhab/openhab-vscode.git"
+    },
+    "license": "SEE LICENSE IN LICENSE",
+    "engines": {
+        "vscode": "^1.30.0"
+    },
+    "scripts": {
+        "postinstall": "vscode-install",
+        "test": "echo \"No tests in client yet!\""
+    },
+    "dependencies": {
+        "ascii-table": "0.0.9",
+        "copy-paste": "^1.3.0",
+        "lodash": "^4.17.4",
+        "request": "^2.83.0",
+        "request-promise-native": "^1.0.5",
+        "underscore.string": "^3.3.5",
+        "vscode": "^1.1.26",
+        "vscode-languageclient": "^5.2.1"
+    }
+}

client/src/LanguageClient/LocalLanguageClientProvider.ts

@@ -0,0 +1,55 @@
+import {
+    Disposable,
+    workspace
+} from 'vscode'
+
+import {
+    LanguageClient,
+    LanguageClientOptions,
+    TransportKind,
+    ServerOptions
+} from 'vscode-languageclient'
+
+import * as path from 'path';
+
+/**
+ * @author Samuel Brucksch
+ */
+export class LocalLanguageClientProvider {
+    constructor() { }
+
+    public connect(context): Disposable {
+        // The debug options for the server
+        // --inspect=6009: runs the server in Node's Inspector mode so VS Code can attach to the server for debugging
+        const debugOptions = { execArgv: ["--nolazy", "--inspect=6009"] };
+
+        const serverModule = context.asAbsolutePath(path.join("serverJS", "src", "LSPServer.js"));
+
+        // If the extension is launched in debug mode then the debug server options are used
+        // Otherwise the run options are used
+        const serverOptions: ServerOptions = {
+            run: {
+                module: serverModule,
+                transport: TransportKind.ipc,
+            },
+            debug: {
+                module: serverModule,
+                transport: TransportKind.ipc,
+                options: debugOptions,
+            },
+        };
+
+        const extensions = ["things", "items", "rules", "script", "sitemap", "persist"];
+        const clientOptions: LanguageClientOptions = {
+            documentSelector: [{ scheme: "file", language: "openhab", pattern: `**/*.{${extensions.join(",")}}` }],
+            synchronize: {
+                configurationSection: "openhab",
+                fileEvents: workspace.createFileSystemWatcher("**/.clientrc"),
+            },
+        };
+
+        // Create the language client and start the client.
+        const lc = new LanguageClient("openhabLanguageServer", "Openhab Language Server", serverOptions, clientOptions);
+        return lc.start();
+    }
+}

src/LanguageClient/LanguageClientProvider.ts → client/src/LanguageClient/RemoteLanguageClientProvider.ts

@@ -11,15 +11,15 @@ import {
     LanguageClientOptions
 } from 'vscode-languageclient'
 
-export class LanguageClientProvider {
+export class RemoteLanguageClientProvider {
     constructor() {
     }
 
     public connect(): Disposable {
         let config = workspace.getConfiguration('openhab')
         let connectionInfo = {
             host: config.host,
-            port: config.lspPort
+            port: config.remoteLspPort
         }
 
         let extensions = [
@@ -44,16 +44,15 @@ export class LanguageClientProvider {
         }
 
         let clientOptions: LanguageClientOptions = {
-            documentSelector: ['openhab'],
+            documentSelector: [{ scheme: "file", language: "openhab", pattern: `**/*.{${extensions.join(",")}}` }],
             synchronize: {
-                configurationSection: 'openhabLSP',
-                fileEvents: workspace.createFileSystemWatcher('**/*.{' + extensions.join(',') + '}')
+                configurationSection: "openhab",
+                fileEvents: workspace.createFileSystemWatcher("**/.clientrc"),
             }
         }
 
-        if (config.useRestApi) {
-            let lc = new LanguageClient('openHABlsp', 'openHAB Server', serverOptions, clientOptions)
-            return lc.start()
-        }
+        // Create the language client and start the client.
+        let lc = new LanguageClient('openHABlsp', 'openHAB Server', serverOptions, clientOptions)
+        return lc.start()
     }
 }

src/extension.ts → client/src/extension.ts

@@ -22,7 +22,8 @@ import { ItemsProvider } from './ThingsExplorer/ItemsProvider'
 import { ItemsCompletion } from './ItemsExplorer/ItemsCompletion'
 import { RuleProvider } from './ItemsExplorer/RuleProvider'
 import { SitemapPartialProvider } from './ItemsExplorer/SitemapPartialProvider'
-import { LanguageClientProvider } from './LanguageClient/LanguageClientProvider'
+import { LocalLanguageClientProvider } from './LanguageClient/LocalLanguageClientProvider'
+import { RemoteLanguageClientProvider } from './LanguageClient/RemoteLanguageClientProvider'
 import { Item } from './ItemsExplorer/Item'
 import { Thing } from './ThingsExplorer/Thing'
 import { Channel } from './ThingsExplorer/Channel'
@@ -33,7 +34,7 @@ import * as path from 'path'
 
 let _extensionPath: string;
 
-async function init(disposables: Disposable[], config): Promise<void> {
+async function init(disposables: Disposable[], config, context): Promise<void> {
 
     disposables.push(commands.registerCommand('openhab.basicUI', () => {
         let editor = window.activeTextEditor
@@ -162,16 +163,15 @@ async function init(disposables: Disposable[], config): Promise<void> {
 
         disposables.push(commands.registerCommand('openhab.command.things.copyUID', (query) =>
             ncp.copy(query.UID || query.uid)))
-
-        if (config.restCompletions) {
-            disposables.push(languages.registerCompletionItemProvider('openhab', itemsCompletion))
-        }
     }
 
-    if (config.lspEnabled) {
-        const languageClientProvider = new LanguageClientProvider()
-        disposables.push(languageClientProvider.connect())
+    if (config.remoteLspEnabled) {
+        const remoteLanguageClientProvider = new RemoteLanguageClientProvider()
+        disposables.push(remoteLanguageClientProvider.connect())
     }
+
+    const localLanguageClientProvider = new LocalLanguageClientProvider()
+    disposables.push(localLanguageClientProvider.connect(context))
 }
 
 export function activate(context: ExtensionContext) {
@@ -180,7 +180,7 @@ export function activate(context: ExtensionContext) {
     let config = workspace.getConfiguration('openhab')
     context.subscriptions.push(new Disposable(() => Disposable.from(...disposables).dispose()))
 
-    init(disposables, config)
+    init(disposables, config, context)
         .catch(err => console.error(err));
 }
 

client/tsconfig.json

@@ -0,0 +1,14 @@
+{
+	"compilerOptions": {
+		"target": "es6",
+		"module": "commonjs",
+		"moduleResolution": "node",
+		"sourceMap": true,
+		"outDir": "out",
+		"rootDir": "src",
+		"lib": ["es6"],
+		"types":["node"]
+	},
+	"include": ["src"],
+	"exclude": ["node_modules", ".vscode-test"]
+}

client/tslint.json

@@ -0,0 +1,10 @@
+{
+	"rules": {
+		"no-unused-expression": true,
+		"no-duplicate-variable": true,
+		"curly": true,
+		"class-name": true,
+		"semicolon": ["never"],
+		"triple-equals": true
+	}
+}