Merge pull request #3 from zapta/main

Assorted cleanups

Author: zapta

README.md

@@ -1,9 +1,9 @@
-# Apio FPGA for VS Code
+# Apio FPGA for VSCode
 
 > **Note (November 2025):** This extension is not yet available on the Visual Studio Code Marketplace.
-> To install it, download the latest `.vsix` package from the [Releases page](https://github.com/FPGAwars/apio-vscode/releases) and use **Extensions → … → Install from VSIX…** in VS Code.
+> To install it, download the latest `.vsix` package from the [Releases page](https://github.com/FPGAwars/apio-vscode/releases) and use **Extensions → … → Install from VSIX…** in VSCode.
 
-This official extension by the Apio team brings Apio’s power directly into VS Code with **one-click buttons** and a **dedicated sidebar panel**. Common commands (`lint`, `build`, `upload`) appear on the status bar, while the full command set is organized in a collapsible tree under the **Apio** tab.
+This official extension by the Apio team brings Apio’s power directly into VSCode with **one-click buttons** and a **dedicated sidebar panel**. Common commands (`lint`, `build`, `upload`) appear on the status bar, while the full command set is organized in a collapsible tree under the **Apio** tab.
 
 ![VSCode screenshot](media/screenshot1.png)
 
@@ -35,7 +35,7 @@ Apio is a lightweight, open-source, command-line FPGA toolchain for Verilog and
    Follow the official guide:
    [https://fpgawars.github.io/apio/docs/quick-start/](https://fpgawars.github.io/apio/docs/quick-start/)
 
-2. **Open the project in VS Code**  
+2. **Open the project in VSCode**  
    `File → Open Folder…` → select the folder containing `apio.ini`.
 
 3. **Run commands**  

defs.js

@@ -11,21 +11,21 @@ const COMMANDS_TREE = [
         tooltip: "Build the apio project",
         id: "apio.build",
         action: { cmds: ["apio build {env-flag}"] },
-        btn: { icon: "$(chip)", priority: 98 },
+        btn: { icon: "$(check)", position: 1 },
       },
       {
         title: "Upload",
         tooltip: "Build and upload to the FPGA board",
         id: "apio.upload",
         action: { cmds: ["apio upload {env-flag}"] },
-        btn: { icon: "$(play)", priority: 96 },
+        btn: { icon: "$(play)", position: 3 },
       },
       {
         title: "Clean",
         tooltip: "Clean the build artifacts",
         id: "apio.clean",
         action: { cmds: ["apio clean"] },
-        btn: { icon: "$(trash)", priority: 95 },
+        btn: { icon: "$(trash)", position: 7 },
       },
     ],
   },
@@ -37,7 +37,7 @@ const COMMANDS_TREE = [
         tooltip: "Lint the source code",
         id: "apio.lint",
         action: { cmds: ["apio lint {env-flag}"] },
-        btn: { icon: "$(check-all)", priority: 99 },
+        btn: { icon: "$(check-all)", position: 2 },
       },
       {
         title: "Format",
@@ -47,22 +47,24 @@ const COMMANDS_TREE = [
       },
       {
         title: "Sim",
-        tooltip: "Run simulator on the default testbench",
+        tooltip: "Run the testbench simulator",
         id: "apio.sim",
         action: { cmds: ["apio sim {env-flag}"] },
+        btn: { icon: "$(debug-alt)", position: 5 },
       },
       {
         title: "Test",
-        tooltip: "Run the testbenchs",
+        tooltip: "Run automatic tests",
         id: "apio.test",
         action: { cmds: ["apio test"] },
+        btn: { icon: "$(beaker)", position: 4 },
       },
       {
         title: "Report",
         tooltip: "Report design utilization and speed",
         id: "apio.report",
         action: { cmds: ["apio report {env-flag}"] },
-        btn: { icon: "$(report)", priority: 97 },
+        btn: { icon: "$(report)", position: 6 },
       },
       {
         title: "Graph",
@@ -200,7 +202,6 @@ const COMMANDS_TREE = [
   },
 ];
 
-
 const TOOLS_TREE = [
   {
     title: "Terminal",
@@ -210,7 +211,6 @@ const TOOLS_TREE = [
   },
 ];
 
-
 const HELP_TREE = [
   {
     title: "System info",
@@ -225,16 +225,22 @@ const HELP_TREE = [
     action: { cmds: ["apio raw --verbose"] },
   },
   {
-    title: "Documentation",
-    tooltip: "Open Apio documentation",
+    title: "Overview",
+    tooltip: "Show Apio documentation",
     id: "apio.docs",
     action: { url: "https://fpgawars.github.io/apio/docs" },
   },
   {
-    title: "Apio commands",
-    tooltip: "Open Apio commands documentation",
-    id: "apio.commands.docs",
+    title: "Commands",
+    tooltip: "Show Apio commands documentation",
+    id: "apio.docs.commands",
     action: { url: "https://fpgawars.github.io/apio/docs/cmd-apio-build" },
+  },
+    {
+    title: "Project file apio.ini",
+    tooltip: "Show Apio project file documentation",
+    id: "apio.docs.project.file",
+    action: { url: "https://fpgawars.github.io/apio/docs/project-file" },
   },
   {
     title: "Ask questions",

extension.js

@@ -1,4 +1,4 @@
-// List of VSC icons at:
+// List of VSC text icons at:
 // https://code.visualstudio.com/api/references/icons-in-labels
 
 // Online Javascript linter at: https://eslint.org/play/
@@ -49,13 +49,14 @@ class ApioTreeGroup {
   }
 }
 
-// Tree is a list of nodes.
-function traverseHierarchy(nodes) {
+// Recursively traverse the definition tree and return it using
+// datatypes that are expected by vscode. Nodes is a list of nodes.
+function traverseAndConvertTree(nodes) {
   const result = [];
   for (const node of nodes) {
     if ("children" in node) {
       // Handle a group
-      const children = traverseHierarchy(node.children);
+      const children = traverseAndConvertTree(node.children);
       const item = new ApioTreeGroup(node.title, node.tooltip, children);
       result.push(item);
     } else {
@@ -77,12 +78,12 @@ function traverseHierarchy(nodes) {
 }
 
 // Tree is a list of nodes.
-function traverseCommands(context, pre_cmds, nodes) {
+function traverseAndRegisterCommands(context, pre_cmds, nodes) {
   // const result = [];
   for (const node of nodes) {
     if ("children" in node) {
       // Handle a group
-      traverseCommands(context, pre_cmds, node.children);
+      traverseAndRegisterCommands(context, pre_cmds, node.children);
     } else {
       // Handle a leaf, it must have an action. If there are commands,
       // we prefix the pre_cmds, e.g. to cd to the project dir.
@@ -97,29 +98,28 @@ function traverseCommands(context, pre_cmds, nodes) {
 
       // Register the callback to execute the action once selected.
       context.subscriptions.push(
-        vscode.commands.registerCommand(
-          node.id,
-          execAction(commands, url)
-        )
+        vscode.commands.registerCommand(node.id, execAction(commands, url))
       );
     }
   }
 }
 
-function registerTreeButtons(context, nodes_list) {
+function traverseAndRegisterTreeButtons(context, nodes_list) {
   for (const node of nodes_list) {
     if ("children" in node) {
       // Handle a group
-      registerTreeButtons(context, node.children);
+      traverseAndRegisterTreeButtons(context, node.children);
     } else {
       // Handle a leaf (command). It may or may not have a button
       // definitions.
       if ("btn" in node) {
-        log(`Registering button ${node.id}, priority ${node.btn.priority}`);
-
+        const priority = 100 - node.btn.position;
+        log(
+          `Registering button ${node.id}, position ${node.btn.position}, priority ${priority}`
+        );
         const btn = vscode.window.createStatusBarItem(
           vscode.StatusBarAlignment.Left,
-          node.btn.priority
+          priority
         );
 
         btn.command = node.id;
@@ -152,7 +152,7 @@ class ApioTreeProvider {
 
   getChildren(element) {
     if (!element) {
-      return traverseHierarchy(this.tree);
+      return traverseAndConvertTree(this.tree);
     }
 
     // Inside a group: return children
@@ -229,31 +229,6 @@ function execAction(commands, url) {
   };
 }
 
-function registerTreeCommands(context, apio_folder, tree) {
-  // Determine platform dependent command to change to the apio project dir.
-  const cd_cmd = isWindows
-    ? `chdir /d "${apio_folder}"`
-    : `cd "${apio_folder}"`;
-  log(`cd_cmd: ${cd_cmd}`);
-
-  // Determine platform dependent command to clear the terminal.
-  const clear_cmd = isWindows ? "cls" : "clear";
-  log(`clear_cmd: ${clear_cmd}`);
-
-  const pre_cmds = [clear_cmd, cd_cmd];
-
-  // Register all commands from all trees
-  traverseCommands(context, pre_cmds, tree);
-}
-
-function registerTreeView(context, container_id, tree) {
-  // Side view Apio command tree.
-  const viewContainer = vscode.window.registerTreeDataProvider(
-    container_id,
-    new ApioTreeProvider(tree)
-  );
-  context.subscriptions.push(viewContainer);
-}
 
 // Scans apio.ini and return list of env names.
 function extractApioIniEnvs(filePath) {
@@ -285,8 +260,12 @@ function extractApioIniEnvs(filePath) {
   }
 }
 
+// Update the displaed of the env selector.
 function updateEnvSelector() {
-  statusBarEnv.text = `$(selection) Env: ${currentEnv || ENV_DEFAULT}`;
+  statusBarEnv.text =
+    currentEnv && currentEnv != ENV_DEFAULT
+      ? `[env:${currentEnv}]`
+      : ENV_DEFAULT;
   statusBarEnv.tooltip = "APIO: Select apio.ini env";
 }
 
@@ -328,14 +307,31 @@ function activate(context) {
   isWindows = platform == "win32";
   log(`is windows: ${isWindows}`);
 
+  // Determines the commands that we prefix each apio command.
+  const cd_cmd = isWindows
+    ? `chdir /d "${apio_folder}"`
+    : `cd "${apio_folder}"`;
+  log(`cd_cmd: ${cd_cmd}`);
+
+  // Determine platform dependent command to clear the terminal.
+  const clear_cmd = isWindows ? "cls" : "clear";
+  log(`clear_cmd: ${clear_cmd}`);
+
+  const pre_cmds = [clear_cmd, cd_cmd];
+
   // Traverse the definition trees and register the commands.
   for (const tree of Object.values(defs.TREE_VIEWS)) {
-    registerTreeCommands(context, apio_folder, tree);
+    traverseAndRegisterCommands(context, pre_cmds, tree);
   }
 
-  // Traverse the definition trees and register the sidebar view entries.
+  // Register the trees with their respective views.
   for (const [view_id, tree] of Object.entries(defs.TREE_VIEWS)) {
-    registerTreeView(context, view_id, tree);
+    // registerTreeView(context, view_id, tree);
+    const viewContainer = vscode.window.registerTreeDataProvider(
+      view_id,
+      new ApioTreeProvider(tree)
+    );
+    context.subscriptions.push(viewContainer);
   }
 
   // Construct the status bar 'Apio:' label
@@ -350,7 +346,7 @@ function activate(context) {
 
   // Traverse the definition trees and register the status bar buttons.
   for (const tree of Object.values(defs.TREE_VIEWS)) {
-    registerTreeButtons(context, tree);
+    traverseAndRegisterTreeButtons(context, tree);
   }
 
   // Load saved env or use default ""

media/screenshot1.png

@@ -1,6 +1,6 @@
 #!/bin/bash -x
 
-# Apio VS Code Extension: Uninstall + Full Cache Clear (macOS)
+# Apio VSCode Extension: Uninstall + Full Cache Clear (macOS)
 # For local debugging only. 
 
 # Exit on first error
@@ -20,5 +20,5 @@ rm -rf ~/Library/Application\ Support/Code/CachedExtensions
 rm -rf ~/Library/Application\ Support/Code/CachedExtensionVSIXs
 rm -rf ~/Library/Application\ Support/Code/Code\ Cache
 
-echo "Done. Restart VS Code, then reinstall your new .vsix:"
+echo "Done. Restart VSCode, then reinstall your new .vsix:"
 echo "code --install-extension apio-*.vsix"

scripts/clear-apio-extension.sh

@@ -10,7 +10,7 @@ npm install -g @vscode/vsce@latest
 #!/bin/bash
 #set -e
 
-#echo "=== VS Code Marketplace Readiness Check ==="
+#echo "=== VSCode Marketplace Readiness Check ==="
 
 # 1. Package with dry-run (validates everything the Marketplace checks)
 # vsce package --dry-run