Merge pull request #26 from PraneshASP/staging

✨ Release v1.2.0

Author: PraneshASP

README.md

@@ -22,6 +22,8 @@ TL;DR, this is my first VSCode extension, so feel free to provide feedback as I
 - Flatten current file (or) selected file(s).
 - Inline highlighting in code editor for unused imports.
 - Generate and view Foundry deployment report in a clean and concise table format. 
+- Syntax highlighting of for `.tree` files.
+- Generate foundry test stub using [bulloak](https://github.com/alexfertel/bulloak)'s `scaffold` command. 
 
 ---
 
@@ -34,6 +36,9 @@ The following will need to be installed in order to use this template. Please fo
   - You can test you've installed them right by running `forge --version` and get an output like: `forge 0.2.0 (f016135 2022-07-04T00:15:02.930499Z)`
   - To get the latest of each, just run `foundryup`
 
+- [Bulloak](https://github.com/alexfertel/bulloak)
+  - This is required to generate test stub from `.tree` spec files.
+
 ## Usage
 
 The usage of this extension is straightforward.
@@ -76,6 +81,19 @@ The usage of this extension is straightforward.
 https://github.com/PraneshASP/vscode-solidity-inspector/assets/42379522/e4906ad3-69e6-4cea-b986-7712ec342fca
 
 
+---
+
+#### Generate foundry deployment report:
+
+https://github.com/PraneshASP/vscode-solidity-inspector/assets/42379522/cfaf987e-ad91-4927-9042-7562bc8684dc
+
+---
+
+#### Support for `.tree` files and test stub generation: 
+
+https://github.com/PraneshASP/vscode-solidity-inspector/assets/42379522/2a3d591b-bc80-46cc-88c9-7e4faa0bb043
+
+
 ---
 
 <!-- CONTRIBUTING -->

package.json

@@ -2,7 +2,7 @@
   "name": "vscode-solidity-inspector",
   "displayName": "Solidity Inspector",
   "description": "A vscode extension used to inspect Solidity files",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "engines": {
     "vscode": "^1.72.0"
   },
@@ -28,7 +28,8 @@
   "main": "./src/extension.js",
   "activationEvents": [
     "onLanguage:solidity",
-    "onLanguage:json"
+    "onLanguage:json",
+    "onLanguage:tree"
   ],
   "contributes": {
     "commands": [
@@ -86,6 +87,16 @@
         "command": "vscode-solidity-inspector.contextMenu.generateDeploymentReport",
         "title": "SolidityInspector: generate deployment report",
         "category": "Solidity Inspector"
+      },
+      {
+        "command": "vscode-solidity-inspector.activeFile.scaffold",
+        "title": "Scaffold",
+        "category": "Solidity Inspector"
+      },
+      {
+        "command": "vscode-solidity-inspector.contextMenu.scaffold",
+        "title": "Solidity Inspector: scaffold",
+        "category": "Solidity Inspector"
       }
     ],
     "configuration": {
@@ -119,9 +130,29 @@
           "group": "solidity",
           "command": "vscode-solidity-inspector.contextMenu.generateDeploymentReport",
           "when": "resourceFilename =~ /\\.json/"
+        },
+        {
+          "group": "solidity",
+          "command": "vscode-solidity-inspector.contextMenu.scaffold",
+          "when": "resourceFilename =~ /\\.tree/"
         }
       ]
-    }
+    },
+    "grammars": [
+      {
+        "language": "tree",
+        "scopeName": "source.tree",
+        "path": "./src/syntaxes/tree-syntax.tmLanguage.json"
+      }
+    ],
+    "languages": [
+      {
+        "id": "tree",
+        "extensions": [
+          ".tree"
+        ]
+      }
+    ]
   },
   "scripts": {},
   "devDependencies": {

src/commands/bulloak-scaffold.js

@@ -0,0 +1,62 @@
+const vscode = require("vscode");
+const cp = require("child_process");
+const { newWindowBeside } = require("../helpers");
+
+async function scaffoldActiveFile(args) {
+    let activeDoc = vscode.window.activeTextEditor.document;
+    let activeFile = activeDoc.fileName;
+    if (activeFile.endsWith(".tree")) {
+        const filePathArray = activeFile.split("/");
+        let fileName = filePathArray[filePathArray.length - 1];
+        fileName = fileName.substring(0, fileName.length - 4);
+        filePathArray.pop();
+        let activeFileDirArray = activeFile.split('/');
+        activeFileDirArray.pop();
+        let activeFileDir = activeFileDirArray.join("/");
+        cp.exec(
+            `cd ${activeFileDir} && bulloak scaffold ${fileName}tree`,
+            (err, stdout, stderr) => {
+                if (err) {
+                    vscode.window.showErrorMessage(
+                        `[Operation failed] \n${err.message}\n\nNOTE: Please make sure to install 'bulloak' before using this command`
+                    );
+                    console.error(err);
+                }
+                newWindowBeside(stdout);
+            }
+        );
+    } else {
+        vscode.window.showErrorMessage(
+            `[Operation failed] ${activeFile}\n\nOnly .tree files are supported.`
+        );
+    }
+}
+
+async function scaffoldContextMenu(clickedFile, selectedFiles) {
+    for (let index = 0; index < selectedFiles.length; index++) {
+        const activeFile = selectedFiles[index].path;
+        if (!activeFile.endsWith(".tree")) continue;
+        const filePathArray = activeFile.split("/");
+        let fileName = filePathArray[filePathArray.length - 1];
+        fileName = fileName.substring(0, fileName.length - 4);
+
+        filePathArray.pop();
+
+        let activeFileDirArray = activeFile.split('/');
+        activeFileDirArray.pop();
+        let activeFileDir = activeFileDirArray.join("/");
+        cp.exec(
+            `cd ${activeFileDir} && bulloak scaffold ${fileName}tree`,
+            (err, stdout, stderr) => {
+                if (err) {
+                    vscode.window.showErrorMessage(
+                        `[Operation failed] \n${err.message}\n\nNOTE: Please make sure to install 'bulloak' before using this command`
+                    );
+                }
+                newWindowBeside(stdout);
+            }
+        );
+    }
+}
+
+module.exports = { scaffoldActiveFile, scaffoldContextMenu };

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,8 +32,12 @@ const {
 
 const {
   generateDeploymentReportActiveFile, generateDeploymentReportContextMenu
-} = require("./commands/deployment-report")
+} = require("./commands/deployment-report");
 
+const { treeFilesCodeActionProvider, treeFilesDiagnosticCollection } = require("./commands/parse-tree");
+
+
+const { scaffoldActiveFile, scaffoldContextMenu } = require("./commands/bulloak-scaffold");
 
 /** global vars */
 const EXTENSION_PREFIX = "vscode-solidity-inspector";
@@ -94,6 +98,16 @@ const generateDeploymentReportContextMenuSubscription = vscode.commands.register
   generateDeploymentReportContextMenu
 );
 
+const scaffoldActiveFileSubscription = vscode.commands.registerCommand(
+  EXTENSION_PREFIX + ".activeFile.scaffold",
+  scaffoldActiveFile
+);
+
+const scaffoldContextMenuSubscription = vscode.commands.registerCommand(
+  EXTENSION_PREFIX + ".contextMenu.scaffold",
+  scaffoldContextMenu
+);
+
 /** event funcs */
 function onActivate(context) {
   vscode.window.onDidChangeActiveTextEditor(editor => {
@@ -127,7 +141,12 @@ 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);
 
+  context.subscriptions.push(scaffoldActiveFileSubscription);
+  context.subscriptions.push(scaffoldContextMenuSubscription);
 
   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"
+                }
+            ]
+        }
+    }
+}