Develop (#19)

Author: Varagos

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to the "bitloops-language" extension will be documented in t
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+### 0.3.3
+
+Refactored state manager, added rebounce, updated transpiler & validator, added restart command
+
 ### 0.3.2
 
 Added new keywords of the Bitloops Language (DomainEvent, IntegrationEvent, DomainService)

README.md

@@ -33,9 +33,9 @@ No known issues.
 
 ## What's New
 
-### 0.3.2
+### 0.3.3
 
-Added new keywords of the Bitloops Language (DomainEvent, IntegrationEvent, DomainService)
+Refactored state manager, added rebounce, updated transpiler & validator, added restart command
 
 ---
 

client/src/extension.ts

@@ -4,7 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 
 import * as path from 'path';
-import { workspace, ExtensionContext } from 'vscode';
+import { workspace, ExtensionContext, commands } from 'vscode';
 
 import {
   LanguageClient,
@@ -40,14 +40,25 @@ export function activate(context: ExtensionContext) {
     documentSelector: [{ scheme: 'file', language: 'bitloops' }],
     synchronize: {
       // Notify the server about file changes to '.clientrc files contained in the workspace
-      fileEvents: workspace.createFileSystemWatcher('**/.clientrc'),
+      fileEvents: workspace.createFileSystemWatcher('**/*.{bl,clientrc}'),
     },
   };
 
   // Create the language client and start the client.
   client = new LanguageClient('Bitloops LSP', 'Bitloops LSP', serverOptions, clientOptions);
   // console.log(client);
 
+  // Register Restart command
+  let disposable = commands.registerCommand('bitloops.restartLSP', async () => {
+    if (client) {
+      if (client.needsStop()) {
+        await client.stop();
+      }
+      client.start();
+    }
+  });
+  context.subscriptions.push(disposable);
+
   // Start the client. This will also launch the server
   client.start();
 }

package.json

@@ -9,7 +9,7 @@
   },
   "icon": "assets/images/bitloops-language-logo-256x256.png",
   "license": "MIT",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "scripts": {
     "vs:package": "vsce package",
     "vs:publish": "vsce publish",
@@ -78,6 +78,12 @@
         "scopeName": "source.bitloops",
         "path": "./syntaxes/bitloops.tmLanguage.json"
       }
+    ],
+    "commands": [
+      {
+        "command": "bitloops.restartLSP",
+        "title": "Bitloops: Restart LSP Server"
+      }
     ]
   },
   "devDependencies": {

server/README.md

@@ -0,0 +1,30 @@
+### File structure
+
+File structure that incorporates the idea of having separate files for different request handlers and better organization:
+
+```
+server/
+  src/
+    index.ts                        # Entry point for the server
+    lsp/
+      bitloopsServer.ts             # Bitloops language server implementation
+      handlers/
+        completionHandler.ts        # Completion request handler
+        hoverHandler.ts             # Hover request handler
+        // Other request handlers...
+      models/
+        // Language-specific models, interfaces, or types
+    utils/
+      // Utility functions or helper modules
+  package.json                       # Package dependencies and scripts
+  tsconfig.json                      # TypeScript compiler configuration for server
+```
+
+Explanation of the structure:
+
+- src/index.ts: The entry point for the server application.
+- src/lsp/server.ts: This file contains the implementation of the Bitloops language server. It can handle various LSP features and delegate specific request handling to separate handler modules.
+- src/lsp/client.ts: This file contains the implementation of the LSP Client, used to push results generated by the server, to the user's interface.
+- src/lsp/handlers/: This directory now contains individual files for different request handlers. For example, completionHandler.ts handles completion requests, hoverHandler.ts handles hover requests, and so on. You can create additional files for other request handlers as needed.
+- src/lsp/models/: This directory still holds language-specific models, interfaces, or types that are used by the LSP server and request handlers.
+- src/utils/: This directory remains for utility functions or helper modules.

server/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bitloops-lsp-server",
   "description": "BitLoops Language Server",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "publisher": "Bitloops",
   "license": "MIT",
   "engines": {
@@ -10,13 +10,15 @@
   "type": "module",
   "scripts": {},
   "dependencies": {
-    "@bitloops/bl-transpiler": "^0.2.0",
+    "@bitloops/bl-transpiler": "^0.6.0",
+    "debounce": "^1.2.1",
     "fs": "^0.0.1-security",
     "path": "^0.12.7",
     "vscode-languageserver": "^7.0.0",
     "vscode-languageserver-textdocument": "^1.0.4"
   },
   "devDependencies": {
+    "@types/debounce": "^1.2.1",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "typescript": "^4.8.4"

server/src/analyzer.ts

@@ -1,3 +1,3 @@
-import { LspConnection } from './lsp-connection.js';
+import { LspConnection } from './lsp/connection.js';
 
 new LspConnection().registerLspEvents().listen();

server/src/index.ts

@@ -0,0 +1,36 @@
+import * as lsp from 'vscode-languageserver';
+
+export interface ILspClient {
+  publishDiagnostics(args: lsp.PublishDiagnosticsParams): void;
+  emptyFileDiagnostics(fileUri: string): void;
+  showLoadingProgress(message: string): void;
+  hideLoadingProgress(): void;
+
+  showErrorMessage(message: string): void;
+  showWarningMessage(message: string): void;
+}
+
+export class LspClientImpl implements ILspClient {
+  constructor(protected connection: lsp.Connection) {}
+  showLoadingProgress(message: string): void {
+    throw new Error('Method not implemented.');
+  }
+  hideLoadingProgress(): void {
+    throw new Error('Method not implemented.');
+  }
+
+  publishDiagnostics(params: lsp.PublishDiagnosticsParams): void {
+    this.connection.sendDiagnostics(params);
+  }
+
+  emptyFileDiagnostics(fileUri: string): void {
+    this.connection.sendDiagnostics({ uri: fileUri, diagnostics: [] });
+  }
+  showErrorMessage(message: string): void {
+    this.connection.window.showErrorMessage(message);
+  }
+
+  showWarningMessage(message: string): void {
+    this.connection.window.showWarningMessage(message);
+  }
+}

server/src/lsp-client.ts

@@ -6,9 +6,12 @@ import {
 } from 'vscode-languageserver/node.js';
 
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import { LspClientImpl } from './lsp-client.js';
+import debounce from 'debounce';
+import { LspClientImpl } from './client.js';
 import { BitloopsServer } from './server.js';
 
+const DEBOUNCE_INTERVAL = 500;
+
 export class LspConnection {
   private connection: _Connection;
   private server: BitloopsServer;
@@ -28,9 +31,14 @@ export class LspConnection {
     this.connection.onInitialized(server.onInitialized.bind(server));
 
     this.documents.onDidClose(server.onDidClose.bind(server));
-    this.documents.onDidChangeContent(server.onDidChangeContent.bind(server));
+    this.documents.onDidChangeContent(
+      debounce(server.onDidChangeContent.bind(server), DEBOUNCE_INTERVAL),
+    );
     this.connection.onCompletion(server.completion.bind(server, this.documents));
     this.connection.onCompletionResolve(server.completionResolve.bind(server));
+
+    this.connection.onDidChangeWatchedFiles(server.onDidChangeWatchedFiles.bind(server));
+
     return this;
   }
 

server/src/lsp/client.ts

@@ -6,9 +6,9 @@ import {
   TextDocumentPositionParams,
   TextDocuments,
 } from 'vscode-languageserver/node.js';
-import { documentation } from './information/documentation.js';
-import { details } from './information/details.js';
-import { allKeywords, components, keywords } from './types/keywords.js';
+import { documentation } from '../../../information/documentation.js';
+import { details } from '../../../information/details.js';
+import { allKeywords } from '../../models/keywords.js';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 
 //this would come from package