Merge lharri73:master -> bmwcd:master

.github/workflows/codeql-analysis.yml

@@ -32,7 +32,7 @@ jobs:
     - run: npm install
       name: install dependencies
 
-    - run: npm run compile
+    - run: npm run webpack
       name: Compile verification
 
     # Initializes the CodeQL tools for scanning.

.github/workflows/integration.yml

@@ -9,15 +9,6 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: configure
-      run: npm install
-    - name: make
-      run: make
-
   compile:
     runs-on: ubuntu-latest
     strategy:
@@ -32,20 +23,9 @@ jobs:
         with:
           node-version: ${{matrix.node-version}}
 
-      - run: npm install
-        name: install dependencies
+      - run: npm install --also=dev
+        name: Install Dependencies
 
-      - run: npm run compile
-        name: Compile verification
-
-      ## TODO: unit tests
-
-  # disabled because syntax not generated on master
-  # syntax_tests:
-  #   name: Run Syntax Tests
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - uses: SublimeText/syntax-test-action@v2
-  #       with:
-  #         build: latest
+      - run: make
+        name: Compile and Build
+

.gitignore

@@ -10,3 +10,6 @@ client/out/*
 !server/out/.keep
 !client/out/.keep
 .DS_Store
+*.tsbuildinfo
+dist
+server/dist

.vscode/launch.json

@@ -8,31 +8,15 @@
             "name": "Launch Client",
             "runtimeExecutable": "${execPath}",
             "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
-            "outFiles": ["${workspaceRoot}/client/out/**/*.js"],
-            "preLaunchTask": {
-                "type": "npm",
-                "script": "compile"
-            }
+            "outFiles": ["${workspaceRoot}/client/out/**/*.js"]
         },
         {
             "type": "node",
             "request": "attach",
             "name": "Attach to Server",
             "port": 6009,
             "restart": true,
-            "outFiles": ["${workspaceRoot}/server/out/**/*.js"]
-        },
-        {
-            "name": "Language Server E2E Test",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceRoot}",
-                "--extensionTestsPath=${workspaceRoot}/client/out/test/index",
-                "${workspaceRoot}/client/testFixture"
-            ],
-            "outFiles": ["${workspaceRoot}/client/out/test/**/*.js"]
+            "outFiles": ["${workspaceRoot}/server/dist/*.js"]
         }
     ],
     "compounds": [

.vscode/tasks.json

@@ -13,4 +13,4 @@
 			"isBackground": true
 		}
 	]
-}
+}

.vscodeignore

@@ -1,9 +1,29 @@
 .vscode/**
 .vscode-test/**
 .gitignore
+.github
 src
 res/image.xcf
-node_modules
-server/node_modules
-client/node_modules
 .DS_Store
+node_modules
+
+server/**
+!server/out
+!server/dist
+!server/dbc.*
+!server/package.json
+!server/package-lock.json
+
+client/**
+!client/dist
+!client/build
+!client/package.json
+!client/package-lock.json
+
+dbcLib/**
+!dbcLib/dist
+!dbcLib/build
+
+changelog.md
+Makefile
+syntaxSrc

Makefile

@@ -1,4 +1,4 @@
-# Copyright (C) 2021  Landon Harris
+# Copyright (C) 2022  Landon Harris
 
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -13,9 +13,50 @@
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-all: src/dbcLang.yml
-	npx js-yaml src/dbcLang.yml > syntaxes/dbc.tmLanguage.json
-	npx js-yaml src/snippets.yml > snippets/snippets.json
+SHELL := /bin/bash
 
+dbclib := dbcLib/dist/index.js
+client := client/build/ext-src/serverPack.js
+server := server/dist/serverPack.js
+
+all: syntaxes $(dbclib) $(client) $(server)
+client: $(client)
+server: $(server)
+dbclib: $(dbclib)
+
+$(dbclib): $(wildcard dbcLib/*.ts) $(wildcard dbcLib/dbc/*.ts)
+	cd dbcLib && tsc && webpack --mode production
+	rm -rf ./{client,server}/dbcLib
+	mkdir -p client/dbcLib server/dbcLib
+	# cp -r dbcLib/{dist,build,package.json,package-lock.json,node_modules} client/src/dbcLib/
+	# cp -r dbcLib/{dist,build,package.json,package-lock.json,node_modules} server/dbcLib/
+
+$(client): $(dbclib) $(wildcard client/ext-src/*.ts) $(wildcard client/public/*) $(wildcard client/scripts/*.js) $(wildcard client/src/*)
+	cd client && npm run build
+	# cp client/dist/* client/build/ext-src/
+
+$(server): $(dbclib) $(wildcard server/src/*.ts) server/dbc.jison server/dbc.lex
+	cd server && npm run build
+
+
+.PHONY: syntaxes
+syntaxes: syntaxes/dbc.tmLanguage.json snippets/snippets.json
+
+syntaxes/dbc.tmLanguage.json: syntaxSrc/dbcLang.yml
+	npx js-yaml syntaxSrc/dbcLang.yml > syntaxes/dbc.tmLanguage.json
+
+snippets/snippets.json: syntaxSrc/snippets.yml
+	npx js-yaml syntaxSrc/snippets.yml > snippets/snippets.json
+
+.PHONY: clean
 clean:
 	rm -f syntaxes/dbc.tmLanguage.json snippets/snippets.json
+	rm -rf client/build client/dist
+	rm -rf dbcLib/build dbcLib/dist
+	rm -rf server/dist server/out
+	rm *.vsix
+	# rm -rf {client,server}/dbcLib
+
+.PHONY: package
+package: $(dbclib) $(client) $(server) syntaxes
+	vsce package

README.md

@@ -3,8 +3,8 @@
 ![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/lharri73.dbc?style=flat-square)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/lharri73/DBC-Language-Syntax/DBC%20language%20CI?style=flat-square)
 
-This extension provides basic syntax highlighting, bracket completion, code snippets 
-and lexer/parser errors for the Vector DBC file format. 
+This extension provides basic syntax highlighting, bracket completion, code
+snippets, lexer/parser errors, and a preview window for the Vector DBC file format. 
 This is created to work with version 2 of the [Vector DBC file format](https://bitbucket.org/tobylorenz/vector_dbc/src/master/).
 
 Although DBC files are often programmatically generated, it can be useful to
@@ -13,47 +13,53 @@ Syntax highlighting is handled locally through VSCode's
 integrated TextMates language parsing engine, using PCRE regular 
 expressions to match syntax. 
 
+This extension also provides a sidebar to preview messages in the current, open
+DBC file. While this doesn't allow editing, it takes information from various
+parts of the DBC and makes it easily readable and searchable. 
+
+*The preview window is still a work in progress!*
+
 ## Syntax Highlighting
 <img src="res/syntax.png" width="500">
 
+## Message and Signal Preview
+<img src="res/sidebar.gif" width="800">
+
 ## Lexicographic and Parser Errors
 <img src="res/errors.gif" width="800">
 
 ## Commonly Used Snippets
 <img src="res/snippets.gif" width="800">
 
-## Supported keywords
-- BA
-- BA_DEF
-- BA_DEF_DEF
-- BA_DEF_DEF_REL
-- BA_DEF_REL
-- BA_REL
-- BO
-- BO_TX_BU
-- BS
-- BU
-- BU_SG_REL
-- CM
-- EV
-- NS
-- SG
-- SGTYPE
-- SIG_GROUP
-- VAL
-- VAL_TABLE
-- VERSION
 ## Known Issues
-
 1. Attribute definitions that wrap lines may not be highlighted on the following
    lines. 
 1. Signals that are multiplexed will not be recognized
 
 ## Todo items
-- Make lexer and parser errors more useful
-- Add checks that prevent crashing when signals don't exist
 - Include debugging (invalid offset, start bit, min, max, etc)
-- Hover box to show all related fields as a hint
+- Show more information about each signal (val tables, comments, etc.)
+- Show the byte structure of the message
+
+## Organization
+- `server`
+  - Contains the language server and parser for the dbc language sytax
+- `client`
+  - Contains the editor and viewer
+- `dbcLib`
+  - basic type descriptions of each element/class of the dbc language
+
+## 3rd Party Libraries
+- [Vector DBC file format](https://bitbucket.org/tobylorenz/vector_dbc/src/master/).
+  - Although no code from this repository is used in this extension, this served
+    as a reference for the DBC format and syntax. 
+- [jison](https://github.com/zaach/jison)
+  - The parser and lexer used on the server side to parse dbc files
+- [React.js](https://reactjs.org/)
+  - Used to display the parsed message/signal data in the vscode browser panel. 
+- [MessagePack](https://msgpack.org/)
+  - Serializes the parsed DBC file's intermediate representation into a packed
+    binary before sending to the browser panel.
 
 ## License
 GNU General Public License v2.0 only

changelog.md

@@ -32,3 +32,9 @@
 # 1.2.3
 - Fixed crashing issue that prevented parsing
 - Added option to silence warnings from undefined objects
+
+# 2.0.0
+- Restructure of entire extension
+- Added DBCLib to contain all components of dbc file
+- Separated client and server code
+- Added react-based side window that shows basic preview of messages & signals

client/.env

@@ -0,0 +1 @@
+PUBLIC_URL=./

client/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+build/

client/src/extension.ts → client/ext-src/extension.ts

@@ -15,16 +15,15 @@
 */
 
 import * as path from 'path';
-import { workspace, ExtensionContext } from 'vscode'
-import { LanguageClient, LanguageClientOptions, ServerOptions, TransportKind } from 'vscode-languageclient';
+import * as vscode from 'vscode';
+import { DidChangeWorkspaceFoldersNotification, LanguageClient, LanguageClientOptions, ServerOptions, TransportKind } from 'vscode-languageclient/node';
+import DBCPanel from './panel';
 
 let client: LanguageClient;
 
-export function activate(context: ExtensionContext){
-    let serverModule = context.asAbsolutePath(path.join('server', 'out', 'index.js'));
-
+export function activate(context: vscode.ExtensionContext){
+    let serverModule = context.asAbsolutePath(path.join('server', 'dist', 'serverPack.js'));
     let debugOptions = {execArgv: ['--nolazy', '--inspect=6009']}; //runs in node's inspector mode so vscode can attach for debugging
-
     let serverOptions: ServerOptions = {
         run: {
             module: serverModule,
@@ -39,6 +38,10 @@ export function activate(context: ExtensionContext){
 
     let clientOptions: LanguageClientOptions = {
         documentSelector: [{scheme: 'file', language: 'dbc'}],
+        synchronize: {
+            // Notify the server about file changes to '.dbc files contained in the vscode.workspace
+            fileEvents: vscode.workspace.createFileSystemWatcher('**/.dbc')
+        }
     };
 
     client = new LanguageClient(
@@ -47,13 +50,31 @@ export function activate(context: ExtensionContext){
         serverOptions,
         clientOptions
     );
-
+    // bind the callback function
+    // client.onReady().then(()=> {
+    // });
+
     client.start();
+    vscode.commands.executeCommand('setContext', 'dbcLangSyntax.clientActive', true);
+
+    var {a: registration, b: panel} = DBCPanel.register(context,client);
+    context.subscriptions.push(registration);
+    // register showPreview command for button
+    context.subscriptions.push(
+        vscode.commands.registerCommand('dbc.showPreview', ()=>{
+            if(!vscode.window.activeTextEditor) return;
+            if(!panel.panel){
+                vscode.workspace.openTextDocument(vscode.window.activeTextEditor.document.uri).then(doc => {
+                    const viewPanel = vscode.window.createWebviewPanel("dbc", "DBC Preview", {preserveFocus: true, viewColumn: vscode.ViewColumn.Beside});
+                    panel.resolveCustomTextEditor(doc, viewPanel, <vscode.CancellationToken><unknown>null);
+                });              
+            }
+        })
+    );
 }
-
+    
 export function deactivate(): Thenable<void> | undefined {
-    if (!client){
+    if(!client)
         return undefined;
-    }
     return client.stop();
 }