Merge pull request #21 from PraneshASP/feat/syntax-highlight-tree-files

♻️ Add Basic syntax highlight support for `.tree` files

Author: PraneshASP

package.json

@@ -28,7 +28,8 @@
   "main": "./src/extension.js",
   "activationEvents": [
     "onLanguage:solidity",
-    "onLanguage:json"
+    "onLanguage:json",
+    "onLanguage:tree"
   ],
   "contributes": {
     "commands": [
@@ -121,7 +122,22 @@
           "when": "resourceFilename =~ /\\.json/"
         }
       ]
-    }
+    },
+    "grammars": [
+      {
+        "language": "tree",
+        "scopeName": "source.tree",
+        "path": "./src/syntaxes/tree-syntax.tmLanguage.json"
+      }
+    ],
+    "languages": [
+      {
+        "id": "tree",
+        "extensions": [
+          ".tree"
+        ]
+      }
+    ]
   },
   "scripts": {},
   "devDependencies": {

src/commands/parse-tree.js

@@ -0,0 +1,46 @@
+const vscode = require("vscode");
+
+// Create a diagnostic collection
+const treeFilesDiagnosticCollection = vscode.languages.createDiagnosticCollection('treeNodes');
+
+// Register a Code Action provider
+const treeFilesCodeActionProvider = vscode.languages.registerCodeActionsProvider('tree', {
+    provideCodeActions(document) {
+        const diagnostics = [];
+
+        document.getText().split('\n').forEach((lineText, lineNumber) => {
+            lineText = lineText.trim();
+            if (lineNumber == 0 && !lineText.endsWith('.t.sol')) {
+                const diagnostic = new vscode.Diagnostic(
+                    new vscode.Range(0, 0, 0, lineText.length),
+                    `Should be a valid test name (ending with .t.sol)`,
+                    vscode.DiagnosticSeverity.Error
+                );
+
+                diagnostics.push(diagnostic);
+            }
+            if (/^(├──|└──|│)/.test(lineText)) {
+                const allowedPrefixes = ['it', 'when', 'given'];
+                lineText = lineText.replace(/^[^a-zA-Z0-9]+/, '');
+
+                // Check if the line starts with an allowed prefix
+                const prefix = lineText.split(' ')[0];
+                if (!allowedPrefixes.includes(prefix)) {
+                    // Create a diagnostic for the violation
+                    const diagnostic = new vscode.Diagnostic(
+                        new vscode.Range(lineNumber, 0, lineNumber, lineText.length),
+                        `Tree node should start with "it", "when", or "given"`,
+                        vscode.DiagnosticSeverity.Error
+                    );
+                    diagnostics.push(diagnostic);
+                }
+            }
+
+        });
+
+        treeFilesDiagnosticCollection.set(document.uri, diagnostics);
+
+    },
+});
+
+module.exports = { treeFilesDiagnosticCollection, treeFilesCodeActionProvider };

src/extension.js

@@ -32,7 +32,9 @@ const {
 
 const {
   generateDeploymentReportActiveFile, generateDeploymentReportContextMenu
-} = require("./commands/deployment-report")
+} = require("./commands/deployment-report");
+
+const { treeFilesCodeActionProvider, treeFilesDiagnosticCollection } = require("./commands/parse-tree");
 
 
 /** global vars */
@@ -127,7 +129,9 @@ function onActivate(context) {
   context.subscriptions.push(generateDeploymentReportActiveFileSubscription);
   context.subscriptions.push(generateDeploymentReportContextMenuSubscription);
 
-
+  // Register the Code Action provider and diagnostic collection to the subscriptions
+  context.subscriptions.push(treeFilesCodeActionProvider);
+  context.subscriptions.push(treeFilesDiagnosticCollection);
 
   vscode.window.visibleTextEditors.map(editor => {
     if (editor && editor.document && editor.document.languageId == "solidity") {

src/syntaxes/tree-syntax.tmLanguage.json

@@ -0,0 +1,35 @@
+{
+    "name": "Tree File",
+    "scopeName": "source.tree",
+    "fileTypes": [
+        ".tree"
+    ],
+    "patterns": [
+        {
+            "include": "#tree-characters"
+        },
+        {
+            "match": "\\b[a-zA-Z0-9_.-]+\\.t\\.sol\\b",
+            "name": "constant.filename"
+        },
+        {
+            "match": "\\b(when|it|given)\\b",
+            "name": "keyword.when-it-given"
+        },
+        {
+            "begin": "//",
+            "end": "$",
+            "name": "comment"
+        }
+    ],
+    "repository": {
+        "tree-characters": {
+            "patterns": [
+                {
+                    "match": "(├──|└──|│)",
+                    "name": "string.tree-characters"
+                }
+            ]
+        }
+    }
+}