Merge pull request #5 from cortex-command-community/development

Language Server Implementation and FilePath Validation

Author: traunts

README.md

@@ -17,6 +17,11 @@ These allow you to quicky create definitions for properties, and tab through the
 
 ![snippets](docs/snippets.gif)
 
+Filepath validation of all references to module files within the workspace.
+This currently requires the base game directory to be open as a VSCode workspace.
+
+![filepaths](docs/filepathValidation.gif)
+
 ## Extension Settings
 
 _NA (Not currently implemented)_

docs/extensions.txt

@@ -0,0 +1,8 @@
+
+".ini", ".txt", ".lua", ".cfg", ".bmp", ".png", ".jpg", ".jpeg", ".wav", ".ogg", ".mp3", ".flac" 
+
+*.{ini,txt,lua,cfg,bmp,png,jpg,jpeg,wav,ogg,mp3,flac}
+(ini|txt|lua|cfg|bmp|png|jpg|jpeg|wav|ogg|mp3|flac)
+
+
+(ScriptPath|IncludeFile|LogoFile|FilePath|SkinFile)

docs/filepathValidation.gif

@@ -3,6 +3,10 @@
 - trailing spaces are trimmed, need to allow
 - Docs updates don't trigger releases.
 
+      SkinFile = Browncoats.rte/BuyMenuSkin.ini
+      BackgroundColorIndex = 62
+      LogoFile = Browncoats.rte/GUIs/BuyMenuLogo.png
+
 ## TODO:
 
 - [ ] Unit tests for syntax highlighting

notes.md

@@ -19,6 +19,9 @@
     },
     "build": {
       "dependsOn": ["^build"]
+    },
+    "watch": {
+      "dependsOn": ["^watch"]
     }
   },
   "workspaceLayout": {
@@ -36,5 +39,6 @@
       "linter": "eslint",
       "unitTestRunner": "jest"
     }
-  }
+  },
+  "pluginsConfig": {}
 }

nx.json

@@ -30,13 +30,13 @@
       "type": "object",
       "title": "Cortex Command INI Language Options",
       "properties": {
-        "cortex-command-community-project-language-support.maxNumberOfProblems": {
+        "cortexCommandLanguageSupport.maxNumberOfProblems": {
           "scope": "resource",
           "type": "number",
           "default": 100,
           "description": "Controls the maximum number of problems produced by the server."
         },
-        "cortex-command-community-project-language-support.trace.server": {
+        "cortexCommandLanguageSupport.trace.server": {
           "scope": "window",
           "type": "string",
           "enum": [
@@ -47,12 +47,12 @@
           "default": "verbose",
           "description": "Traces the communication between VS Code and the language server."
         },
-        "cortex-command-community-project-language-support.gameDirectoryPath": {
+        "cortexCommandLanguageSupport.gameDirectoryPath": {
           "scope": "resource",
           "type": "string",
           "default": ".",
           "description": "The path to the Cortex Command game directory. Required if developing the mod outside the game directory.",
-          "format": "uri"
+          "format": "string"
         }
       }
     },
@@ -125,6 +125,7 @@
     "ts-jest": "28.0.5",
     "ts-loader": "^9.4.2",
     "ts-node": "10.9.1",
+    "tsconfig-paths-webpack-plugin": "^4.0.0",
     "typescript": "^4.9.4"
   },
   "scripts": {
@@ -140,6 +141,7 @@
     "vscode-languageclient": "^7.0.0",
     "vscode-languageserver": "^7.0.0",
     "vscode-languageserver-textdocument": "^1.0.8",
-    "vscode-test": "^1.6.1"
+    "vscode-test": "^1.6.1",
+    "vscode-uri": "^3.0.7"
   }
 }

package-lock.json

@@ -5,7 +5,7 @@
 'use strict';
 
 import * as path from 'path';
-import { ExtensionContext, window as Window } from 'vscode';
+import { ExtensionContext, window as Window, workspace } from 'vscode';
 import {
   LanguageClient,
   LanguageClientOptions,
@@ -33,14 +33,22 @@ export function activate(context: ExtensionContext): void {
 
   const clientOptions: LanguageClientOptions = {
     documentSelector: [{ scheme: 'file', language: 'ccini' }],
-    diagnosticCollectionName: 'sample',
-    revealOutputChannelOn: RevealOutputChannelOn.Never,
+    revealOutputChannelOn: RevealOutputChannelOn.Error,
     progressOnInitialization: true,
+    synchronize: {
+      fileEvents: workspace.createFileSystemWatcher(
+        '**/*.{ini,txt,lua,cfg,bmp,png,jpg,jpeg,wav,ogg,mp3,flac}'
+      ),
+    },
   };
 
   let client: LanguageClient;
   try {
-    client = new LanguageClient('UI Sample', serverOptions, clientOptions);
+    client = new LanguageClient(
+      'Cortex Command Client',
+      serverOptions,
+      clientOptions
+    );
   } catch (err) {
     Window.showErrorMessage(
       `The extension couldn't be started. See the output channel for details.`

package.json

@@ -1,6 +1,7 @@
 const { composePlugins, withNx, withWeb } = require('@nrwl/webpack');
 
 const path = require('path');
+const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');
 
 // Nx plugins for webpack.
 module.exports = composePlugins(withNx(), withWeb(), (config) => {
@@ -14,6 +15,11 @@ module.exports = composePlugins(withNx(), withWeb(), (config) => {
   };
 
   config.resolve = {
+    plugins: [
+      new TsconfigPathsPlugin({
+        configFile: path.join(__dirname, 'tsconfig.app.json'),
+      }),
+    ],
     mainFields: ['module', 'main'],
     extensions: ['.ts', '.js'], // support ts-files and js-files
   };