Merge pull request #23 from PraneshASP/feat/bulloak-scaffold

♻️ Bulloak `scaffold` support for test stub generation

Author: PraneshASP

package.json

@@ -87,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": {
@@ -120,6 +130,11 @@
           "group": "solidity",
           "command": "vscode-solidity-inspector.contextMenu.generateDeploymentReport",
           "when": "resourceFilename =~ /\\.json/"
+        },
+        {
+          "group": "solidity",
+          "command": "vscode-solidity-inspector.contextMenu.scaffold",
+          "when": "resourceFilename =~ /\\.tree/"
         }
       ]
     },

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/extension.js

@@ -37,6 +37,8 @@ const {
 const { treeFilesCodeActionProvider, treeFilesDiagnosticCollection } = require("./commands/parse-tree");
 
 
+const { scaffoldActiveFile, scaffoldContextMenu } = require("./commands/bulloak-scaffold");
+
 /** global vars */
 const EXTENSION_PREFIX = "vscode-solidity-inspector";
 
@@ -96,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 => {
@@ -133,6 +145,9 @@ function onActivate(context) {
   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") {
       unusedImportsActiveFile(editor);