feat(vscode): introduce robotcode contribution point for vscode extensions plugins

Author: d-biehl

package.json

@@ -106,7 +106,7 @@
     ],
     "configurationDefaults": {
       "[robotframework]": {
-        "editor.wordBasedSuggestions": false,
+        "editor.wordBasedSuggestions": "off",
         "editor.semanticHighlighting.enabled": true,
         "editor.inlayHints.enabled": "offUnlessPressed",
         "editor.quickSuggestionsDelay": 100,

packages/runner/src/robotcode/runner/cli/discover/discover.py

@@ -59,7 +59,8 @@ def __init__(self, *args: Any, error_message: str, **kwargs: Any) -> None:
 __patched = False
 
 
-_stdin_data: Optional[Dict[str, str]] = None
+_stdin_data: Optional[Dict[Uri, str]] = None
+_app: Optional[Application] = None
 
 
 def _patch() -> None:
@@ -187,8 +188,9 @@ def _validate_execution_mode(self: SuiteStructureParser, suite: TestSuite) -> No
 
     def get_file(self: FileReader, source: Union[str, Path, IOBase], accept_text: bool) -> Any:
         path = self._get_path(source, accept_text)
+
         if path:
-            if _stdin_data is not None and (data := _stdin_data.get(str(path))) is not None:
+            if _stdin_data is not None and (data := _stdin_data.get(Uri.from_path(path))) is not None:
                 if data is not None:
                     return old_get_file(self, data, True)
 
@@ -380,10 +382,14 @@ def discover(app: Application, show_diagnostics: bool, read_from_stdin: bool) ->
     robotcode --profile regression discover tests
     ```
     """
+    global _app
+    _app = app
     app.show_diagnostics = show_diagnostics or app.config.log_enabled
     if read_from_stdin:
         global _stdin_data
-        _stdin_data = from_json(sys.stdin.buffer.read(), Dict[str, str], strict=True)
+        _stdin_data = {
+            Uri(k).normalized(): v for k, v in from_json(sys.stdin.buffer.read(), Dict[str, str], strict=True).items()
+        }
         app.verbose(f"Read data from stdin: {_stdin_data!r}")
 
 

vscode-client/debugmanager.ts

@@ -64,7 +64,7 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
       if (
         editor &&
         SUPPORTED_LANGUAGES.includes(editor.document.languageId) &&
-        (editor.document.fileName.endsWith(".robot") || editor.document.fileName.endsWith(".feature"))
+        editor.document.fileName.endsWith(".robot")
       ) {
         const result = await vscode.window.showQuickPick(
           DEBUG_CONFIGURATIONS.map((v) => v),

vscode-client/languageclientsmanger.ts

@@ -36,7 +36,6 @@ export function toVsCodeRange(range: Range): vscode.Range {
 }
 
 export const SUPPORTED_LANGUAGES = ["robotframework"];
-export const SUPPORTED_SUITE_FILE_EXTENSIONS = [".robot"];
 
 export interface Keyword {
   name: string;
@@ -102,6 +101,15 @@ interface DiscoverInfoResult {
   [key: string]: string | undefined;
 }
 
+interface RobotCodeContributions {
+  contributes?: {
+    robotCode?: {
+      fileExtensions?: string[];
+      languageIds?: string[];
+    };
+  };
+}
+
 export class LanguageClientsManager {
   private clientsMutex = new Mutex();
   private _pythonValidPythonAndRobotEnvMutex = new Mutex();
@@ -120,9 +128,43 @@ export class LanguageClientsManager {
     return this._onClientStateChangedEmitter.event;
   }
 
+  private _supportedLanguages?: string[];
+
+  public get supportedLanguages(): string[] {
+    if (this._supportedLanguages === undefined) {
+      this._supportedLanguages = ["robotframework"];
+
+      vscode.extensions.all.forEach((extension) => {
+        if (this._supportedLanguages !== undefined && extension.packageJSON !== undefined) {
+          const ext = (extension.packageJSON as RobotCodeContributions)?.contributes?.robotCode?.languageIds;
+
+          if (ext !== undefined) {
+            this._supportedLanguages.push(...ext);
+          }
+        }
+      });
+    }
+    return this._supportedLanguages;
+  }
+
+  private _fileExtensions?: string[];
+
   // eslint-disable-next-line class-methods-use-this
   public get fileExtensions(): string[] {
-    return ["robot", "resource"];
+    if (this._fileExtensions === undefined) {
+      this._fileExtensions = ["robot", "resource"];
+
+      vscode.extensions.all.forEach((extension) => {
+        if (this._fileExtensions !== undefined && extension.packageJSON !== undefined) {
+          const ext = (extension.packageJSON as RobotCodeContributions)?.contributes?.robotCode?.fileExtensions;
+
+          if (ext !== undefined) {
+            this._fileExtensions.push(...ext);
+          }
+        }
+      });
+    }
+    return this._fileExtensions;
   }
 
   constructor(
@@ -375,7 +417,7 @@ export class LanguageClientsManager {
   }
 
   public async getLanguageClientForDocument(document: vscode.TextDocument): Promise<LanguageClient | undefined> {
-    if (!SUPPORTED_LANGUAGES.includes(document.languageId)) return;
+    if (!this.supportedLanguages.includes(document.languageId)) return;
 
     return this.getLanguageClientForResource(document.uri);
   }
@@ -613,7 +655,7 @@ export class LanguageClientsManager {
     }
 
     for (const document of vscode.workspace.textDocuments) {
-      if (SUPPORTED_LANGUAGES.includes(document.languageId)) {
+      if (this.supportedLanguages.includes(document.languageId)) {
         const workspaceFolder = vscode.workspace.getWorkspaceFolder(document.uri);
         if (workspaceFolder) {
           folders.add(workspaceFolder);
@@ -728,7 +770,7 @@ export class LanguageClientsManager {
   }
 
   private async updateStatusbarItem(editor: vscode.TextEditor | undefined) {
-    if (editor && SUPPORTED_LANGUAGES.includes(editor.document.languageId)) {
+    if (editor && this.supportedLanguages.includes(editor.document.languageId)) {
       try {
         const folder = vscode.workspace.getWorkspaceFolder(editor.document.uri);
         if (folder) {

vscode-client/pythonmanger.ts

@@ -233,10 +233,12 @@ export class PythonManager {
 
       process.stdout.on("data", (data) => {
         stdout += data;
+        // this.outputChannel.appendLine(data as string);
       });
 
       process.stderr.on("data", (data) => {
         stderr += data;
+        this.outputChannel.appendLine(data as string);
       });
 
       process.on("error", (err) => {

vscode-client/testcontrollermanager.ts

@@ -6,13 +6,7 @@ import * as vscode from "vscode";
 import { DebugManager } from "./debugmanager";
 import * as fs from "fs";
 
-import {
-  ClientState,
-  LanguageClientsManager,
-  toVsCodeRange,
-  SUPPORTED_LANGUAGES,
-  SUPPORTED_SUITE_FILE_EXTENSIONS,
-} from "./languageclientsmanger";
+import { ClientState, LanguageClientsManager, toVsCodeRange } from "./languageclientsmanger";
 import { filterAsync, Mutex, sleep, truncateAndReplaceNewlines, WeakValueMap } from "./utils";
 import { CONFIG_SECTION } from "./config";
 import { Range, Diagnostic, DiagnosticSeverity } from "vscode-languageclient/node";
@@ -553,8 +547,9 @@ export class TestControllerManager {
   }
 
   public refreshDocument(document: vscode.TextDocument): void {
-    if (!SUPPORTED_LANGUAGES.includes(document.languageId)) return;
-    if (!SUPPORTED_SUITE_FILE_EXTENSIONS.some((ext) => document.uri.path.toLowerCase().endsWith(ext))) return;
+    if (!this.languageClientsManager.supportedLanguages.includes(document.languageId)) return;
+    if (!this.languageClientsManager.fileExtensions.some((ext) => document.uri.path.toLowerCase().endsWith(`.${ext}`)))
+      return;
     if (document.uri.path.toLowerCase().endsWith("__init__.robot")) return;
 
     const uri_str = document.uri.toString();
@@ -712,7 +707,7 @@ export class TestControllerManager {
   ): Promise<RobotTestItem[] | undefined> {
     // TODO do not use hardcoded file extensions
     const robotFiles = await vscode.workspace.findFiles(
-      new vscode.RelativePattern(folder, "**/*.robot"),
+      new vscode.RelativePattern(folder, `**/*.{${this.languageClientsManager.fileExtensions.join(",")}}`),
       undefined,
       1,
       token,
@@ -727,10 +722,10 @@ export class TestControllerManager {
 
       for (const document of vscode.workspace.textDocuments) {
         if (
-          SUPPORTED_LANGUAGES.includes(document.languageId) &&
+          this.languageClientsManager.supportedLanguages.includes(document.languageId) &&
           vscode.workspace.getWorkspaceFolder(document.uri) === folder
         ) {
-          o[document.fileName] = document.getText();
+          o[document.uri.toString()] = document.getText();
         }
       }
 
@@ -785,10 +780,10 @@ export class TestControllerManager {
       const o: { [key: string]: string } = {};
       for (const document of vscode.workspace.textDocuments) {
         if (
-          SUPPORTED_LANGUAGES.includes(document.languageId) &&
+          this.languageClientsManager.supportedLanguages.includes(document.languageId) &&
           vscode.workspace.getWorkspaceFolder(document.uri) === folder
         ) {
-          o[document.fileName] = document.getText();
+          o[document.uri.toString()] = document.getText();
         }
       }