feat(vscode): added "File > New File" menu support and context menu option for creating Robot files in the file explorer

closes #259

Author: d-biehl

package.json

@@ -61,7 +61,9 @@
     }
   },
   "activationEvents": [
-    "workspaceContains:**/*.{robot,resource}",
+    "workspaceContains:**/*.{robot,resource,robotrepl,robotscript}",
+    "workspaceContains:robot.toml",
+    "workspaceContains:.robot.toml",
     "onDebug",
     "onDebugResolve:robotcode",
     "onDebugInitialConfigurations",
@@ -1333,19 +1335,26 @@
         "icon": "$(book)"
       },
       {
-        "title": "Create New File",
+        "title": "New Robot Framework File",
         "shortTitle": "Robot Framework File",
         "category": "RobotCode",
         "command": "robotcode.createNewFile"
       },
       {
-        "title": "Create New Robot Framework Notebook",
+        "title": "New Robot Framework Notebook",
         "shortTitle": "Robot Framework Notebook",
         "category": "RobotCode",
         "command": "robotcode.createNewNotebook"
       }
     ],
     "menus": {
+      "explorer/context": [
+        {
+          "command": "robotcode.createNewFile",
+          "group": "1_robotcode@1",
+          "when": "!virtualWorkspace && explorerResourceIsFolder"
+        }
+      ],
       "editor/title/run": [
         {
           "command": "robotcode.runCurrentFile",
@@ -1925,4 +1934,4 @@
   "workspaces": [
     "docs"
   ]
-}
+}

packages/core/src/robotcode/core/uri.py

@@ -121,7 +121,7 @@ def _to_path_str(self) -> str:
         netloc = parse.unquote(self.netloc)
         path = parse.unquote(self.path)
 
-        if self._parts.scheme != "file":
+        if self._parts.scheme not in ["file", "untitled"]:
             raise InvalidUriError(f"Invalid URI scheme '{self!s}'.")
 
         if netloc and self._parts.scheme == "file":

packages/robot/src/robotcode/robot/diagnostics/document_cache_helper.py

@@ -338,7 +338,7 @@ def get_model(self, document: TextDocument, data_only: bool = True) -> ast.AST:
         if document_type == DocumentType.RESOURCE:
             return self.get_resource_model(document, data_only)
 
-        raise UnknownFileTypeError(f"Unknown file type '{document.uri}'.")
+        return self.get_general_model(document, data_only)
 
     def __get_model(
         self,

vscode-client/extension/languageToolsManager.ts

@@ -212,6 +212,7 @@ export class LanguageToolsManager {
       this.pythonVersion,
       this.robocopVersion,
       this.tidyVersion,
+      vscode.commands.registerCommand("robotcode.createNewFile", LanguageToolsManager.createNewFile),
       vscode.commands.registerCommand(
         "robotcode.startTerminalRepl",
         async (folder: vscode.WorkspaceFolder | undefined): Promise<void> => {
@@ -443,6 +444,84 @@ export class LanguageToolsManager {
     }, 500);
   }
 
+  static async createNewFile(destinationFolder?: vscode.Uri): Promise<vscode.TextDocument | undefined> {
+    let showSaveDialog = false;
+
+    if (destinationFolder === undefined) {
+      let folder: vscode.WorkspaceFolder | undefined = undefined;
+      if (vscode.workspace.workspaceFolders?.length == 1) {
+        folder = vscode.workspace.workspaceFolders[0];
+      } else {
+        folder = await vscode.window.showWorkspaceFolderPick({
+          placeHolder: "Select a workspace folder to create the file in",
+        });
+      }
+      if (folder === undefined) {
+        return undefined;
+      }
+
+      destinationFolder = folder.uri;
+      showSaveDialog = true;
+    }
+
+    const type = (
+      await vscode.window.showQuickPick(
+        [
+          { description: "Robot Framework suite file", label: ".robot", picked: true, type: "robot" },
+          { description: "Robot Framework resource file", label: ".resource", type: "resource" },
+          {
+            description: "Robot Framework suite init file",
+            label: "__init__.robot",
+            type: "init",
+          },
+        ],
+        { title: "Select a Robot Framework file type", placeHolder: "Select a file type" },
+      )
+    )?.type;
+
+    if (type === undefined) {
+      return undefined;
+    }
+
+    let uri: vscode.Uri | undefined = undefined;
+
+    if (type === "init") {
+      uri = vscode.Uri.joinPath(destinationFolder, `__init__.robot`);
+    } else {
+      uri = vscode.Uri.joinPath(destinationFolder, `newfile.${type}`);
+      let i = 1;
+      while (await fs.pathExists(uri.fsPath)) {
+        uri = vscode.Uri.joinPath(destinationFolder, `newfile-${i++}.${type}`);
+      }
+    }
+
+    if (showSaveDialog) {
+      uri = await vscode.window.showSaveDialog({
+        defaultUri: uri,
+        filters: { "Robot Framework": ["robot", "resource"] },
+        title: "Create new Robot Framework file",
+      });
+
+      if (uri === undefined) {
+        return;
+      }
+    }
+
+    await fs.ensureFile(uri.fsPath);
+
+    const doc = await vscode.workspace.openTextDocument(uri);
+
+    await vscode.window.showTextDocument(doc);
+
+    if (!showSaveDialog && type !== "init") {
+      await vscode.commands.executeCommand("workbench.files.action.focusFilesExplorer");
+      await vscode.commands.executeCommand("revealInExplorer", uri);
+      await vscode.commands.executeCommand("renameFile", uri);
+    }
+
+    return doc;
+  }
+
   private removeFolder(folder: vscode.WorkspaceFolder) {
     if (this._workspaceFolderLanguageStatuses.has(folder)) {
       this._workspaceFolderLanguageStatuses.delete(folder);

vscode-client/extension/languageclientsmanger.ts

@@ -547,8 +547,14 @@ export class LanguageClientsManager {
         documentSelector:
           // TODO: use SUPPORTED_LANGUAGES here
           vscode.workspace.workspaceFolders?.length === 1
-            ? [{ scheme: "file", language: "robotframework" }]
-            : [{ scheme: "file", language: "robotframework", pattern: `${workspaceFolder.uri.fsPath}/**/*` }],
+            ? [
+                { scheme: "file", language: "robotframework" },
+                { scheme: "untitled", language: "robotframework" },
+              ]
+            : [
+                { scheme: "file", language: "robotframework", pattern: `${workspaceFolder.uri.fsPath}/**/*` },
+                { scheme: "untitled", language: "robotframework", pattern: `${workspaceFolder.uri.fsPath}/**/*` },
+              ],
         synchronize: {
           configurationSection: [CONFIG_SECTION],
         },