Merge pull request #43 from SSlinky/dev

Add Formatting Capability

Author: SSlinky

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# Template from: https://github.com/DecimalTurn/VBA-on-GitHub
+
+# top-most EditorConfig file
+root = true
+
+# Properties for VBA, VB6 and twinBASIC file extensions
+[*.{bas,cls,frm,vba,doccls,ctl,dsr,twin,tbform}]
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+# Avoid line too long error (https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/line-too-long):
+max_line_length = 1023
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# The character set property isn't widely supported, but you can still add it. It just won't do anything if unsupported by your editor.
+# Reference: https://github.com/editorconfig/editorconfig/issues/209#issuecomment-445241830
+# Eg.:
+# charset = windows-1252
+# charset = us-ascii

.github/workflows/node.js.yml

@@ -30,8 +30,12 @@ jobs:
     # For some reason, antlr4ng writes to a different location on the VM
     # than it does locally, preventing compile. Command added to move the generated files.
     - run: npm run textMate
-    - name: npm run antlr4ng
-      run: npm run antlr4ng && npm run antlr4ngPre && mv ./server/src/antlr/out/server/src/antlr/* ./server/src/antlr/out
+    - name: npm run antlr
+      run: |
+        npm run antlr4ng
+        npm run antlr4ngPre
+        npm run antlr4ngFmt
+        mv ./server/src/antlr/out/server/src/antlr/* ./server/src/antlr/out
     - run: npm run compile
     - run: xvfb-run -a npm test
       if: runner.os == 'Linux'

.vscode/launch.json

@@ -57,6 +57,16 @@
 			"printParseTree": true,
 			"visualParseTree": true
 		},
+		{
+			"name": "Debug ANTLR4 Fmt grammar",
+			"type": "antlr-debug",
+			"request": "launch",
+			"input": "${file}",
+			"grammar": "server/src/antlr/vbafmt.g4",
+			"startRule": "startRule",
+			"printParseTree": true,
+			"visualParseTree": true
+		},
 		{
 			"name": "Extension Tests",
 			"type": "extensionHost",

README.md

@@ -10,6 +10,9 @@ Adds VBA language support to VSCode via LSP compliant Language Server.
 * Semantic highlighting
 * Folding ranges
 * Document symbols
+* Document formatting\*
+
+\*Currently full document `Shift+Alt+F` formatting only.
 
 ## Coming Soon
 
@@ -18,7 +21,7 @@ Adds VBA language support to VSCode via LSP compliant Language Server.
 
 ## Installation
 
-* Through the VBA Marketplace,
+* Through the VSCode Marketplace,
 * VSCode command palette `ext install notisdataanalytics.vba-lsp`, or;
 * Download the [visx](../../releases/latest).
 

client/src/extension.ts

@@ -12,6 +12,7 @@ import {
 	ServerOptions,
 	TransportKind
 } from 'vscode-languageclient/node';
+import { VscodeLogger } from './logger';
 
 let client: LanguageClient;
 
@@ -53,8 +54,14 @@ export function activate(context: ExtensionContext) {
 		clientOptions
 	);
 
+	// Add logging support for messages received from the server.
+	client.onNotification("window/logMessage", (params) => {
+		VscodeLogger.logMessage(params);
+	})
+
 	// Start the client. This will also launch the server
 	client.start();
+	VscodeLogger.info('VBAPro activated')
 }
 
 export function deactivate(): Thenable<void> | undefined {

client/src/logger.ts

@@ -0,0 +1,55 @@
+import * as vscode from 'vscode';
+
+enum LogLevel {
+	error = 1,
+	warning = 2,
+	info = 3,
+	log = 4,
+	debug = 5
+}
+
+export interface LogMessage {
+	type: number;
+	message: string;
+	level: number;
+}
+
+export class VscodeLogger {
+	private static _outputChannel: vscode.OutputChannel;
+	static get outputChannel(): vscode.OutputChannel {
+		if (!VscodeLogger._outputChannel) {
+			VscodeLogger._outputChannel = vscode.window.createOutputChannel('VBAPro Output');
+			VscodeLogger._outputChannel.show();
+		}
+		return VscodeLogger._outputChannel;
+	}
+
+	static info = (msg: string, lvl?: number) => this.log(LogLevel.info, msg, lvl)
+	static debug = (msg: string, lvl?: number) => this.log(LogLevel.debug, msg, lvl)
+
+	static logMessage(params: LogMessage): void {
+		this.log(params.type, params.message, params.level);
+	}
+
+	private static log(type: LogLevel, msg: string, lvl?: number): void {
+		const i = '> '.repeat(lvl ?? 0);
+		const t = `${this.getFormattedTimestamp()}`;
+		VscodeLogger.outputChannel.appendLine(`${t} [${LogLevel[type]}] ${i}${msg}`);
+	}
+
+	private static getFormattedTimestamp(): string {
+		const now = new Date();
+		
+		const year = now.getFullYear();
+		const month = (now.getMonth() + 1).toString().padStart(2, "0");
+		const day = now.getDate().toString().padStart(2, "0");
+		
+		const hours = now.getHours().toString().padStart(2, "0");
+		const minutes = now.getMinutes().toString().padStart(2, "0");
+		const seconds = now.getSeconds().toString().padStart(2, "0");
+		const milliseconds = now.getMilliseconds().toString().padStart(3, "0");
+	
+		return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}.${milliseconds}`;
+	}
+}
+