feat: new command RobotCode: Report Issue

with this command you can report an issue directly from vscode to RobotCode's issue tracker

Author: d-biehl

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,7 +10,7 @@ assignees: ''
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+**Steps To Reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
@@ -36,13 +36,13 @@ If applicable, add screenshots or videos to help explain your problem.
 **Logs**
 Copy the messages from VSCode "Output" view for RobotCode and RobotCode Language Server for the specific folder/workspace.
 
+**Additional context**
+Add any other context about the problem here.
+
 **Desktop (please complete the following information):**
 - VS Code Version [e.g. 1.60]
 - RobotCode Version [e.g. 0.3.2]
 - OS: [e.g. Windows, Linux]
 - Python Version [e.g. 3.9.7]
 - RobotFramework Version [e.g. 4.0.0]
 - Additional tools like robocop, robotidy
-  
-**Additional context**
-Add any other context about the problem here.

package-lock.json

@@ -1572,27 +1572,29 @@
   "dependencies": {
     "@vscode/python-extension": "^1.0.5",
     "ansi-colors": "^4.1.3",
+    "fs-extra": "^11.2.0",
     "robotcode": "file:",
     "vscode-languageclient": "^9.0.1"
   },
   "devDependencies": {
     "@eslint/compat": "^1.1.1",
     "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.10.0",
-    "@types/node": "^22.5.5",
+    "@eslint/js": "^9.11.1",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.7.2",
     "@types/vscode": "^1.86.0",
     "@vscode/test-electron": "^2.4.1",
     "@vscode/vsce": "^3.1.0",
-    "esbuild": "^0.23.1",
-    "eslint": "^9.10.0",
+    "esbuild": "^0.24.0",
+    "eslint": "^9.11.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "globals": "^15.9.0",
-    "ovsx": "^0.9.4",
+    "ovsx": "^0.9.5",
     "prettier": "^3.3.3",
     "ts-loader": "^9.5.1",
     "typescript": "^5.6.2",
-    "typescript-eslint": "^8.6.0"
+    "typescript-eslint": "^8.7.0"
   },
   "workspaces": [
     "docs"

package.json

@@ -0,0 +1,45 @@
+<!--
+Please fill in all XXX markers and remove the comments if possible
+**After** creating the issue on GitHub, you can add screenshots and videos of what is happening.
+You can also add logs from the "Output" view of VSCode for RobotCode and RobotCode Language Server.
+-->
+
+**Describe the bug**
+<!-- A clear and concise description of what the bug is. -->
+
+XXX
+
+
+**Steps To Reproduce**
+
+<!---
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+If needed and possible add some example source code like:
+```robotframework
+***Settings***
+Library  Collections
+
+***Test Cases***
+a simple test
+    do something    # this should shown something
+```
+-->
+
+XXX
+
+
+**Expected behavior**
+<!-- A clear and concise description of what you expected to happen. -->
+
+XXX
+
+
+**Screenshots/ Videos**
+<!-- If applicable, add screenshots or videos to help explain your problem. -->
+
+XXX

resources/report_issue_body_template.md

@@ -0,0 +1,3 @@
+Python Version: ${{ PYTHON_VERSION }}
+RobotFramework Version: ${{ ROBOTFRAMEWORK_VERSION }}
+Additional tools: ${{ ADDITIONAL_TOOLS }}

resources/report_issue_data_template.md

@@ -12,6 +12,9 @@ import { PythonManager } from "./pythonmanger";
 import { LanguageStatusSeverity } from "vscode";
 import { TestControllerManager } from "./testcontrollermanager";
 
+import * as path from "path";
+import * as fs from "fs-extra";
+
 const NOT_INSTALLED = "not installed";
 
 type QuickPickActionItem = {
@@ -168,6 +171,12 @@ export class LanguageToolsManager {
         }
       },
     },
+    {
+      label: "Report Issue",
+      action: async (folder?: vscode.WorkspaceFolder): Promise<void> => {
+        vscode.commands.executeCommand("robotcode.reportIssue", folder);
+      },
+    },
   ];
 
   constructor(
@@ -220,6 +229,87 @@ export class LanguageToolsManager {
         },
       ),
 
+      vscode.commands.registerCommand("robotcode.reportIssue", async (folder?: vscode.WorkspaceFolder) => {
+        if (folder === undefined) {
+          if (vscode.window.activeTextEditor !== undefined) {
+            folder = vscode.workspace.getWorkspaceFolder(vscode.window.activeTextEditor.document.uri);
+          }
+        }
+        if (folder === undefined) {
+          if (vscode.workspace.workspaceFolders !== undefined && vscode.workspace.workspaceFolders.length === 1) {
+            folder = vscode.workspace.workspaceFolders[0];
+          } else {
+            if (vscode.workspace.workspaceFolders !== undefined && vscode.workspace.workspaceFolders.length > 1) {
+              folder = await vscode.window.showWorkspaceFolderPick({
+                placeHolder: "Select a workspace folder to report an issue for",
+              });
+            }
+          }
+        }
+        const folders = folder !== undefined ? [folder] : (vscode.workspace.workspaceFolders ?? []);
+
+        const bodyTemplatePath = path.join(
+          extensionContext.extensionPath,
+          "resources",
+          "report_issue_body_template.md",
+        );
+        const issueBody = (await fs.readFile(bodyTemplatePath, { encoding: "utf8" })).replaceAll("\r", "").trim();
+
+        const dataTemplatePath = path.join(
+          extensionContext.extensionPath,
+          "resources",
+          "report_issue_data_template.md",
+        );
+        let data = (await fs.readFile(dataTemplatePath, { encoding: "utf8" })).replaceAll("\r", "").trim();
+
+        const pythonVersions: string[] = [];
+        const robotFrameworkVersions: string[] = [];
+        const robocopVersions: string[] = [];
+        const tidyVersions: string[] = [];
+
+        for (const folder of folders) {
+          const pythonInfo = await pythonManager.getPythonInfo(folder);
+
+          if (pythonInfo !== undefined) {
+            const n = `${pythonInfo.version}${pythonInfo.type !== undefined ? " " + pythonInfo.type : ""}`;
+            if (!pythonVersions.includes(n)) pythonVersions.push(n);
+          }
+
+          const info = await this.languageClientsManager.getProjectInfo(folder);
+          if (info !== undefined) {
+            if (info.robotVersionString && !robotFrameworkVersions.includes(info.robotVersionString))
+              robotFrameworkVersions.push(info.robotVersionString);
+
+            if (info.robocopVersionString && !robocopVersions.includes(info.robocopVersionString))
+              robocopVersions.push(info.robocopVersionString);
+
+            if (info.tidyVersionString && !tidyVersions.includes(info.tidyVersionString))
+              tidyVersions.push(info.tidyVersionString);
+          }
+        }
+
+        data = data.replace("${{ PYTHON_VERSION }}", pythonVersions.join(", "));
+        data = data.replace("${{ ROBOTFRAMEWORK_VERSION }}", robotFrameworkVersions.join(", "));
+        data = data.replace(
+          "${{ ADDITIONAL_TOOLS }}",
+          robocopVersions.length > 0 || tidyVersions.length > 0
+            ? [
+                robocopVersions.map((v) => "robotframework-robocop==" + v).join(", "),
+                tidyVersions.map((v) => "robotframework-tidy==" + v).join(", "),
+              ].join(", ")
+            : "",
+        );
+
+        const args = {
+          extensionId: "d-biehl.robotcode",
+          // issueTitle: "Issue with RobotCode",
+          issueBody,
+          data,
+        };
+
+        await vscode.commands.executeCommand("workbench.action.openIssueReporter", args);
+      }),
+
       vscode.commands.registerCommand("robotcode.showToolMenu", async (folder?: vscode.WorkspaceFolder) => {
         let f = folder;
 
@@ -285,14 +375,15 @@ export class LanguageToolsManager {
           case ClientState.Starting:
             this.removeFolder(folder);
             this.robotVersion.busy = true;
-            await this.updateItems();
+
             break;
           default:
             this.removeFolder(folder);
             this.robotVersion.busy = false;
-            await this.updateItems();
+
             break;
         }
+        await this.updateItems();
       }),
       pythonManager.onActivePythonEnvironmentChanged(async (event) => {
         if (event.resource !== undefined) {

vscode-client/languageToolsManager.ts

@@ -103,9 +103,9 @@ interface DiscoverInfoResult {
 }
 
 export interface ProjectInfo {
-  robotVersionString: string;
+  robotVersionString?: string;
   robocopVersionString?: string;
-  tidyVersionString: string;
+  tidyVersionString?: string;
 }
 
 interface RobotCodeContributions {

vscode-client/languageclientsmanger.ts

@@ -14,6 +14,7 @@ export interface ActivePythonEnvironmentChangedEvent {
 export class PythonInfo {
   constructor(
     public readonly name: string,
+    public readonly type: string | undefined,
     public readonly version: string,
     public readonly path?: string,
   ) {}
@@ -250,7 +251,8 @@ export class PythonManager {
   async getPythonInfo(folder: vscode.WorkspaceFolder): Promise<PythonInfo | undefined> {
     try {
       const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
-      let name;
+      let name: string | undefined;
+      let type: string | undefined;
       let path: string | undefined;
       let version: string | undefined;
 
@@ -271,13 +273,14 @@ export class PythonManager {
         version =
           env?.version !== undefined ? `${env.version.major}.${env.version.minor}.${env.version.micro}` : undefined;
         if (env?.environment !== undefined) {
-          name = `('${env?.environment?.name ?? UNKNOWN}': ${env?.tools?.[0] ?? UNKNOWN})`;
+          type = env?.tools?.[0];
+          name = `('${env?.environment?.name ?? UNKNOWN}': ${type ?? UNKNOWN})`;
         } else {
           name = env?.executable.bitness ?? UNKNOWN;
         }
       }
 
-      return new PythonInfo(name ?? CUSTOM, version ?? UNKNOWN, path);
+      return new PythonInfo(name ?? CUSTOM, type, version ?? UNKNOWN, path);
     } catch {
       return undefined;
     }