feat: add simple filepath validation to all ini files

Add a new FileServer service.

It provides lists of all valid filepaths in open the workspace directories.
Populate this list on activation of the Language Server.
Register new change watcher and file sync for all valid file types.
Add `vscode-uri` as a dependency to resolve paths.

Author: traunts

package-lock.json

@@ -52,7 +52,7 @@
           "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"
         }
       }
     },
@@ -140,6 +140,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.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,
@@ -35,7 +35,11 @@ export function activate(context: ExtensionContext): void {
     documentSelector: [{ scheme: 'file', language: 'ccini' }],
     revealOutputChannelOn: RevealOutputChannelOn.Error,
     progressOnInitialization: true,
-    
+    synchronize: {
+      fileEvents: workspace.createFileSystemWatcher(
+        '**/*.{ini,txt,lua,cfg,bmp,png,jpg,jpeg,wav,ogg,mp3,flac}'
+      ),
+    },
   };
 
   let client: LanguageClient;

packages/client/src/extension.ts

@@ -12,6 +12,7 @@ import {
   Diagnostic,
   DiagnosticSeverity,
   DidChangeConfigurationNotification,
+  DidChangeWatchedFilesNotification,
   InitializeParams,
   InitializeResult,
   Position,
@@ -29,6 +30,7 @@ import {
   CortexCommandLanguageSupportConfiguration,
 } from './services/configuration.service';
 import { validateFilePaths } from './validations/validateFilePath';
+import { fileSystemService } from './services/fs.service';
 
 const connection = createConnection(ProposedFeatures.all);
 
@@ -66,6 +68,13 @@ connection.onInitialize((params: InitializeParams): InitializeResult => {
     },
   };
 
+  if (configService.hasWorkspaceFolderCapability && params.workspaceFolders) {
+    fileSystemService.registerWorkspaces(params.workspaceFolders);
+    fileSystemService.fileList.forEach((file) => {
+      connection.console.log(file);
+    });
+  }
+
   if (configService.hasWorkspaceFolderCapability) {
     result.capabilities.workspace = {
       workspaceFolders: {
@@ -85,6 +94,9 @@ connection.onInitialized(() => {
       undefined
     );
   }
+
+  connection.client.register(DidChangeWatchedFilesNotification.type);
+
   if (configService.hasWorkspaceFolderCapability) {
     connection.workspace.onDidChangeWorkspaceFolders((_event) => {
       connection.console.log('Workspace folder change event received.');
@@ -106,6 +118,12 @@ connection.onDidChangeConfiguration((change) => {
   documents.all().forEach(validate);
 });
 
+connection.onDidChangeWatchedFiles((change) => {
+  change.changes.forEach((change) => {
+    connection.console.log(change.type.toString() + change.uri);
+  });
+});
+
 function validate(document: TextDocument): void {
   const diagnostics = validateFilePaths(document);
 

packages/server/src/sampleServer.ts

@@ -0,0 +1,41 @@
+import { readdirSync, statSync } from 'fs';
+import { join, relative } from 'path';
+import { WorkspaceFolder } from 'vscode-languageserver';
+import { URI } from 'vscode-uri';
+
+class FileSystemService {
+  public fileList: string[] = [];
+
+  public registerWorkspaces(workspaces: WorkspaceFolder[]) {
+    workspaces.forEach((folder) => {
+      const workspacePath = URI.parse(folder.uri).fsPath;
+      const workspaceFileList = this.getAllFiles(workspacePath);
+
+      for (const file of workspaceFileList) {
+        this.fileList.push(relative(workspacePath, file));
+      }
+    });
+  }
+
+  //   public init(rootUri: URI): void {
+  //     this.fileList = this.getAllFiles(rootUri);
+  //   }
+
+  private getAllFiles(dirPath: string): string[] {
+    const files = readdirSync(dirPath);
+
+    const fileList: string[] = [];
+
+    files.forEach((file) => {
+      if (statSync(dirPath + '/' + file).isDirectory()) {
+        fileList.push(...this.getAllFiles(join(dirPath, file)));
+      } else {
+        fileList.push(join(dirPath, file));
+      }
+    });
+
+    return fileList;
+  }
+}
+
+export const fileSystemService: FileSystemService = new FileSystemService();

packages/server/src/services/fs.service.ts

@@ -1,6 +1,8 @@
+import { normalize } from 'path';
 import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { configService } from '../services/configuration.service';
+import { fileSystemService } from '../services/fs.service';
 
 export function validateFilePaths(textDocument: TextDocument): Diagnostic[] {
   // In this simple example we get the settings for every validate run.
@@ -18,29 +20,32 @@ export function validateFilePaths(textDocument: TextDocument): Diagnostic[] {
     (m = pattern.exec(text)) &&
     problems < configService.globalSettings.maxNumberOfProblems
   ) {
-    problems++;
-    const diagnostic: Diagnostic = {
-      severity: DiagnosticSeverity.Error,
-      range: {
-        start: textDocument.positionAt(m.index + m[1].length),
-        end: textDocument.positionAt(m.index + m[0].length),
-      },
-      message: `Cannot find the file ${m[2]}`,
-      source: 'CC Language Features',
-    };
-    if (configService.hasDiagnosticRelatedInformationCapability) {
-      diagnostic.relatedInformation = [
-        {
-          location: {
-            uri: textDocument.uri,
-            range: Object.assign({}, diagnostic.range),
-          },
-          message:
-            'This may be due to a bad file extension/path, or incorrect capitalization.',
+    const normalizedPath = normalize(m[2]);
+    if (!fileSystemService.fileList.includes(normalizedPath)) {
+      problems++;
+      const diagnostic: Diagnostic = {
+        severity: DiagnosticSeverity.Error,
+        range: {
+          start: textDocument.positionAt(m.index + m[1].length),
+          end: textDocument.positionAt(m.index + m[0].length),
         },
-      ];
+        message: `Cannot find the file ${m[2]}`,
+        source: 'CC Language Features',
+      };
+      if (configService.hasDiagnosticRelatedInformationCapability) {
+        diagnostic.relatedInformation = [
+          {
+            location: {
+              uri: textDocument.uri,
+              range: Object.assign({}, diagnostic.range),
+            },
+            message:
+              'This may be due to a bad file extension/path, or incorrect capitalization.',
+          },
+        ];
+      }
+      diagnostics.push(diagnostic);
     }
-    diagnostics.push(diagnostic);
   }
 
   // Send the computed diagnostics to VSCode.