feat: implement first-pass tree-sitter parsing when validating ccini filepaths

Author: traunts

packages/server/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "server",
+  "name": "language-server",
   "version": "1.0.0",
   "private": true,
   "license": "GPL-3.0-only",
@@ -13,6 +13,8 @@
   "dependencies": {
     "vscode-uri": "^3.0.2",
     "vscode-languageserver": "^7.0.0",
-    "vscode-languageserver-textdocument": "^1.0.1"
+    "vscode-languageserver-textdocument": "^1.0.1",
+    "path": "^0.12.7",
+    "@keqingmoe/tree-sitter": "^0.26.2"
   }
 }

packages/server/src/validations/validateFilePath.ts

@@ -1,11 +1,11 @@
-import { extname, normalize } from 'path';
-import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver';
+import { extname } from 'path';
+import { Diagnostic } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { configService } from '../services/configuration.service';
 import { fileSystemService } from '../services/fs.service';
 import { imageFileExtensions } from 'shared';
-import Parser, { Language } from 'tree-sitter';
-import ccini from 'tree-sitter-ccini';
+import Parser, { Language, Query } from '@keqingmoe/tree-sitter';
+import language from 'tree-sitter-ccini';
 
 export function validateFilePaths(textDocument: TextDocument): Diagnostic[] {
   // In this simple example we get the settings for every validate run.
@@ -15,44 +15,59 @@ export function validateFilePaths(textDocument: TextDocument): Diagnostic[] {
   const text = textDocument.getText();
 
   const parser = new Parser();
-  parser.setLanguage(ccini as Language);
+  parser.setLanguage(language as Language);
+
+  const queryString = `\
+(assignment
+  key: (property) @key
+  value: (modulePath
+    extension: (fileExtension) @extension
+  ) @modulePathValue
+) @assignment`;
+
+  const filepathQuery = new Query(language as Language, queryString);
 
   const tree = parser.parse(text);
 
-  let m: RegExpExecArray | null;
+  const captures = filepathQuery.captures(tree.rootNode);
 
-  let problems = 0;
+  const problems = 0;
   const diagnostics: Diagnostic[] = [];
 
-  while (
-    (m = pattern.exec(text)) &&
-    problems < configService.globalSettings.maxNumberOfProblems
-  ) {
-    if (!checkIfPathExists(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);
+  for (const capture of captures) {
+    if (problems >= configService.globalSettings.maxNumberOfProblems) {
+      break;
     }
+
+    console.log(capture.name);
+    console.log(capture.node.text);
+    const normalizedPath = capture.name;
+
+    // if (!checkIfPathExists(normalizedPath)) {
+    //   problems++;
+    //   const diagnostic: Diagnostic = {
+    //     severity: DiagnosticSeverity.Error,
+    //     range: {
+    //       start: textDocument.positionAt(captures.index + captures[1].length),
+    //       end: textDocument.positionAt(captures.index + captures[0].length),
+    //     },
+    //     message: `Cannot find the file ${captures[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.

packages/server/webpack.config.js

@@ -1,12 +1,15 @@
+//@ts-check
+
 const { composePlugins, withNx, withWeb } = require('@nrwl/webpack');
 
 const path = require('path');
-const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');
+const { TsconfigPathsPlugin } = require('tsconfig-paths-webpack-plugin');
 
 // Nx plugins for webpack.
 module.exports = composePlugins(withNx(), withWeb(), (config) => {
   // Update the webpack config as needed here.
   // e.g. `config.plugins.push(new MyPlugin())`
+
   config.mode = 'none'; // this leaves the source code as close as possible to the original (when packaging we set this to 'production')
   config.target = 'node'; // extensions run in a node context
   config.node = {
@@ -17,10 +20,11 @@ module.exports = composePlugins(withNx(), withWeb(), (config) => {
     plugins: [
       new TsconfigPathsPlugin({
         configFile: path.join(__dirname, 'tsconfig.app.json'),
+        logLevel: 'INFO',
       }),
     ],
     mainFields: ['module', 'main'],
-    extensions: ['.ts', '.js'], // support ts-files and js-files
+    extensions: ['.ts', '.js', '.node'], // support ts-files and js-files
   };
 
   config.module = {
@@ -41,12 +45,21 @@ module.exports = composePlugins(withNx(), withWeb(), (config) => {
           },
         ],
       },
+      {
+        test: /\.node$/,
+        loader: 'node-loader',
+      },
     ],
   };
   config.externals = {
     vscode: 'commonjs vscode', // ignored because it doesn't exist
+    'tree-sitter': 'commonjs tree-sitter',
+    '@keqingmoe/tree-sitter': 'commonjs @keqingmoe/tree-sitter',
+    'tree-sitter-ccini': 'commonjs ../../tree-sitter-ccini',
   };
 
+  config.output = config.output || {};
+
   config.output.libraryTarget = 'commonjs2';
   // config.output.filename = 'extension.js';
 
@@ -66,7 +79,9 @@ module.exports = composePlugins(withNx(), withWeb(), (config) => {
     extension: './src/extension.ts',
   };
 
-  config.output.devtoolModuleFilenameTemplate = function (info) {
+  config.output.devtoolModuleFilenameTemplate = function (
+    /** @type {{ absoluteResourcePath: string; }} */ info
+  ) {
     const rel = path.relative(process.cwd(), info.absoluteResourcePath);
     return `webpack:///./${rel}`;
   };