feat(vscode): add shell integration to run RobotCode in a VSCode terminal without requiring Python package installation

Author: d-biehl

bundled/scripts/robotcode

@@ -0,0 +1,2 @@
+#! /bin/bash
+python3 $ROBOTCODE_BUNDLED_ROBOTCODE_MAIN $@

bundled/scripts/robotcode.bat

@@ -0,0 +1,3 @@
+@echo off
+:: Bat script to run the robot code
+python %ROBOTCODE_BUNDLED_ROBOTCODE_MAIN% %*

bundled/scripts/robotcode.fish

@@ -0,0 +1,2 @@
+# fish script to run the bundled robotcode
+python3 $ROBOTCODE_BUNDLED_ROBOTCODE_MAIN $argv

bundled/scripts/robotcode.ps1

@@ -0,0 +1,6 @@
+# PowerShell script to run the bundled RobotCode
+if ($PSVersionTable.OS -match "Windows") {
+    python $env:ROBOTCODE_BUNDLED_ROBOTCODE_MAIN $args
+} else {
+    python3 $env:ROBOTCODE_BUNDLED_ROBOTCODE_MAIN $args
+}

src/robotcode/cli/commands/profiles.py

@@ -128,35 +128,39 @@ def list(app: Application, paths: List[Path], show_hidden: bool = False, sort_by
                     lines = v[k].splitlines()
                     v[k] = " ".join(lines[:1]) + (" ..." if len(lines) > 1 else "")
 
-            header = ""
-            max_name = max(
-                0,
-                len("Name"),
-                *(len(profile["name"]) for profile in result["profiles"]),
-            )
-            max_description = max(
-                0,
-                len("Description"),
-                *(len(profile["description"]) for profile in result["profiles"]),
-            )
-            header += (
-                f'| Active | Selected | Enabled | Precedence | Name{(max_name - len("Name")) * " "} '
-                f'| Description{(max_description - len("Description")) * " "} |\n'
-            )
-            header += f"|:------:|:------:|:--------:|:-------:|:{max_name * '-'}-|:{max_description * '-'}-|\n"
-            for selected_profiles, enabled, name, description, precedence in (
-                (v["selected"], v["enabled"], v["name"], v["description"], v["precedence"]) for v in result["profiles"]
-            ):
-                header += (
-                    f'|   {"*" if selected_profiles and enabled else " "}    '
-                    f'|    {"*" if selected_profiles else " "}     '
-                    f'|    {"*" if enabled else " "}    '
-                    f'|    {precedence if precedence else " "}    '
-                    f'| {name}{(max_name - len(name)) * " "} '
-                    f'| {description if description else ""}{(max_description - len(description)) * " "} |\n'
+            output = ""
+            if result["profiles"]:
+                max_name = max(
+                    0,
+                    len("Name"),
+                    *(len(profile["name"]) for profile in result["profiles"]),
                 )
-
-            app.echo_as_markdown(header)
+                max_description = max(
+                    0,
+                    len("Description"),
+                    *(len(profile["description"]) for profile in result["profiles"]),
+                )
+                output += (
+                    f'| Active | Selected | Enabled | Precedence | Name{(max_name - len("Name")) * " "} '
+                    f'| Description{(max_description - len("Description")) * " "} |\n'
+                )
+                output += f"|:------:|:------:|:--------:|:-------:|:{max_name * '-'}-|:{max_description * '-'}-|\n"
+                for selected_profiles, enabled, name, description, precedence in (
+                    (v["selected"], v["enabled"], v["name"], v["description"], v["precedence"])
+                    for v in result["profiles"]
+                ):
+                    output += (
+                        f'|   {"*" if selected_profiles and enabled else " "}    '
+                        f'|    {"*" if selected_profiles else " "}     '
+                        f'|    {"*" if enabled else " "}    '
+                        f'|    {precedence if precedence else " "}    '
+                        f'| {name}{(max_name - len(name)) * " "} '
+                        f'| {description if description else ""}{(max_description - len(description)) * " "} |\n'
+                    )
+            else:
+                output += "No profiles defined.\n"
+
+            app.echo_as_markdown(output)
         else:
             app.print_data(result)
 

vscode-client/extension/index.ts

@@ -6,6 +6,7 @@ import { TestControllerManager } from "./testcontrollermanager";
 import { KeywordsTreeViewProvider } from "./keywordsTreeViewProvider";
 import { LanguageToolsManager } from "./languageToolsManager";
 import { NotebookManager } from "./notebook";
+import path from "path";
 
 class TerminalLink extends vscode.TerminalLink {
   constructor(
@@ -154,12 +155,20 @@ export async function activateAsync(context: vscode.ExtensionContext): Promise<v
     }),
   );
 
-  context.environmentVariableCollection.clear();
-  context.environmentVariableCollection.description = new vscode.MarkdownString(
-    "Disable ANSI links in `robot`'s terminal output.",
-  );
+  const collection = context.environmentVariableCollection;
+  collection.description = new vscode.MarkdownString("RobotCode specific variables.");
+
+  collection.clear();
+
+  const pathSeparator = process.platform === "win32" ? ";" : ":";
+  const scriptsDir = context.asAbsolutePath(path.join("bundled", "scripts"));
+
+  collection.append("PATH", `${pathSeparator}${scriptsDir}`, {
+    applyAtShellIntegration: true,
+  });
 
-  context.environmentVariableCollection.replace("ROBOTCODE_DISABLE_ANSI_LINKS", "1");
+  collection.replace("ROBOTCODE_DISABLE_ANSI_LINKS", "1");
+  collection.replace("ROBOTCODE_BUNDLED_ROBOTCODE_MAIN", pythonManager.robotCodeMain);
 
   languageClientManger.refresh();
 }