feat: add crude filepath detection to flag errors

Update the extension client to specify it's Name and reveal output channels.
Update language server, reenable text document sync and basic validation methods.
Create a simple config service to share server props across imports.
Implement a simple filepath validator that currently marks all filepaths as invalid (and unresolved)

Author: traunts

packages/client/src/extension.ts

@@ -33,14 +33,17 @@ export function activate(context: ExtensionContext): void {
 
   const clientOptions: LanguageClientOptions = {
     documentSelector: [{ scheme: 'file', language: 'ccini' }],
-    diagnosticCollectionName: 'sample',
-    revealOutputChannelOn: RevealOutputChannelOn.Never,
+    revealOutputChannelOn: RevealOutputChannelOn.Error,
     progressOnInitialization: true,
   };
 
   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.`

packages/server/src/sampleServer.ts

@@ -11,29 +11,49 @@ import {
   createConnection,
   Diagnostic,
   DiagnosticSeverity,
+  InitializeParams,
   Position,
+  ProposedFeatures,
   Range,
   TextDocumentEdit,
   TextDocuments,
   TextDocumentSyncKind,
   TextEdit,
 } from 'vscode-languageserver/node';
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import { configService } from './services/configuration.service';
+import { validateFilePaths } from './validations/validate';
 
-const connection = createConnection();
-connection.console.info(`Sample server running in node ${process.version}`);
+const connection = createConnection(ProposedFeatures.all);
+
+connection.console.info(
+  `CC Language server running in node ${process.version}`
+);
 
 const documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);
 documents.listen(connection);
 
-connection.onInitialize(() => {
+connection.onInitialize((params: InitializeParams) => {
+  const capabilities = params.capabilities;
+
+  // Does the client support the `workspace/configuration` request?
+  // If not, we fall back using global settings.
+  configService.hasConfigurationCapability = !!(
+    capabilities.workspace && !!capabilities.workspace.configuration
+  );
+  configService.hasWorkspaceFolderCapability = !!(
+    capabilities.workspace && !!capabilities.workspace.workspaceFolders
+  );
+  configService.hasDiagnosticRelatedInformationCapability =
+    !!capabilities.textDocument?.publishDiagnostics?.relatedInformation;
+
   return {
     capabilities: {
       // codeActionProvider: true,
-      // textDocumentSync: {
-      //   openClose: true,
-      //   change: TextDocumentSyncKind.Incremental,
-      // },
+      textDocumentSync: {
+        openClose: true,
+        change: TextDocumentSyncKind.Incremental,
+      },
       // executeCommandProvider: {
       //   commands: ['sample.fixMe'],
       // },
@@ -42,53 +62,52 @@ connection.onInitialize(() => {
 });
 
 function validate(document: TextDocument): void {
+  const diagnostics = validateFilePaths(document);
+
   connection.sendDiagnostics({
     uri: document.uri,
     version: document.version,
-    diagnostics: [
-      Diagnostic.create(
-        Range.create(0, 0, 0, 10),
-        'Something is wrong here',
-        DiagnosticSeverity.Warning
-      ),
-    ],
+    diagnostics,
   });
 }
 
-// documents.onDidOpen((event) => {
-//   validate(event.document);
-// });
-
-// documents.onDidChangeContent((event) => {
-//   validate(event.document);
-// });
+documents.onDidOpen((event) => {
+  validate(event.document);
+});
 
-// connection.onCodeAction((params) => {
-// 	const textDocument = documents.get(params.textDocument.uri);
-// 	if (textDocument === undefined) {
-// 		return undefined;
-// 	}
-// 	const title = 'With User Input';
-// 	return [CodeAction.create(title, Command.create(title, 'sample.fixMe', textDocument.uri), CodeActionKind.QuickFix)];
-// });
+documents.onDidChangeContent((event) => {
+  validate(event.document);
+});
 
-// connection.onExecuteCommand(async (params) => {
-// 	if (params.command !== 'sample.fixMe' || params.arguments ===  undefined) {
-// 		return;
-// 	}
+/* 
+connection.onCodeAction((params) => {
+	const textDocument = documents.get(params.textDocument.uri);
+	if (textDocument === undefined) {
+		return undefined;
+	}
+	const title = 'With User Input';
+	return [CodeAction.create(title, Command.create(title, 'sample.fixMe', textDocument.uri), CodeActionKind.QuickFix)];
+});
+ */
 
-// 	const textDocument = documents.get(params.arguments[0]);
-// 	if (textDocument === undefined) {
-// 		return;
-// 	}
-// 	const newText = typeof params.arguments[1] === 'string' ? params.arguments[1] : 'Eclipse';
-// 	connection.workspace.applyEdit({
-// 		documentChanges: [
-// 			TextDocumentEdit.create({ uri: textDocument.uri, version: textDocument.version }, [
-// 				TextEdit.insert(Position.create(0, 0), newText)
-// 			])
-// 		]
-// 	});
-// });
+/* 
+connection.onExecuteCommand(async (params) => {
+	if (params.command !== 'sample.fixMe' || params.arguments ===  undefined) {
+		return;
+	}
 
+	const textDocument = documents.get(params.arguments[0]);
+	if (textDocument === undefined) {
+		return;
+	}
+	const newText = typeof params.arguments[1] === 'string' ? params.arguments[1] : 'Eclipse';
+	connection.workspace.applyEdit({
+		documentChanges: [
+			TextDocumentEdit.create({ uri: textDocument.uri, version: textDocument.version }, [
+				TextEdit.insert(Position.create(0, 0), newText)
+			])
+		]
+	});
+});
+ */
 connection.listen();

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

@@ -0,0 +1,7 @@
+class ConfigurationService {
+  public hasConfigurationCapability = false;
+  public hasWorkspaceFolderCapability = false;
+  public hasDiagnosticRelatedInformationCapability = false;
+}
+
+export const configService = new ConfigurationService();

packages/server/src/validations/validate.ts

@@ -0,0 +1,49 @@
+import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+import { configService } from '../services/configuration.service';
+
+const settings = {
+  maxNumberOfProblems: 100,
+};
+
+export function validateFilePaths(textDocument: TextDocument): Diagnostic[] {
+  // In this simple example we get the settings for every validate run.
+  //   const settings = await getDocumentSettings(textDocument.uri);
+
+  // The validator creates diagnostics for all uppercase words length 2 and more
+  const text = textDocument.getText();
+  const pattern = /(\t*(?:FilePath|IncludeFile)\s*=\s*)(.*)/dg;
+  let m: RegExpExecArray | null;
+
+  let problems = 0;
+  const diagnostics: Diagnostic[] = [];
+
+  while ((m = pattern.exec(text)) && problems < settings.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.',
+        },
+      ];
+    }
+    diagnostics.push(diagnostic);
+  }
+
+  // Send the computed diagnostics to VSCode.
+  return diagnostics;
+}