feat: open file on device

Opens the corresponding file on a connected device

Author: jakobrosenberg

package.json

@@ -358,6 +358,11 @@
       }
     ],
     "commands": [
+      {
+        "command": "pymakr.openOnDevice",
+        "title": "Open file on device.",
+        "category": "PyMakr"
+      },
       {
         "command": "pymakr.logState",
         "title": "[DEBUG] Logs current state to the terminal",
@@ -776,6 +781,11 @@
         {
           "command": "pymakr.uploadPrompt",
           "group": "pymakr"
+        },
+        {
+          "command": "pymakr.openOnDevice",
+          "group": "pymakr",
+          "when": "resourceScheme == file"
         }
       ],
       "pymakr.explorerContextMenu": [
@@ -792,6 +802,11 @@
         {
           "command": "pymakr.uploadPrompt",
           "group": "pymakr"
+        },
+        {
+          "command": "pymakr.openOnDevice",
+          "group": "pymakr",
+          "when": "resourceScheme == file"
         }
       ],
       "view/item/context": [

src/commands/index.js

@@ -1,15 +1,7 @@
 const { mkdirSync, readFileSync, writeFileSync } = require("fs");
-const { writeFile } = require("fs").promises;
 const vscode = require("vscode");
 const { msgs } = require("../utils/msgs");
-const {
-  mapEnumsToQuickPick,
-  getTemplates,
-  copyTemplateByName,
-  serializedEntriesToObj,
-  objToSerializedEntries,
-  waitFor,
-} = require("../utils/misc");
+const { mapEnumsToQuickPick, getTemplates, copyTemplateByName, waitFor } = require("../utils/misc");
 const { relative } = require("path");
 const { Project } = require("../Project");
 const { DeviceManager } = require("../Watcher/DeviceManager");
@@ -46,6 +38,40 @@ class Commands {
   }
 
   commands = {
+    /**
+     *
+     * @param {vscode.Uri} file
+     */
+    openOnDevice: async (file) => {
+      this.pymakr.notifier.notifications.openOnDeviceFile();
+
+      const project = this.pymakr.vscodeHelpers.coerceProject(file);
+
+      if (!project) return this.pymakr.notifier.notifications.openOnDeviceHasNoProject(file);
+
+      const devices = project.devices
+        .filter((device) => device.adapter.__proxyMeta.target.isConnected())
+        .filter((device) => !device.busy.get());
+
+      devices.forEach(async (device) => {
+        const path = relative(project.folder, file.fsPath).replace(/\\/g, "/");
+        const uri = vscode.Uri.parse(`${device.protocol}://${device.address}${device.config.rootPath}/${path}`);
+        try {
+          await vscode.window.showTextDocument(uri);
+        } catch (err) {
+          if (err.message.match(/Unable to resolve nonexistent file/)) {
+            const result = await this.pymakr.notifier.notifications.openOnDeviceFileDoesntExist(path, device);
+            if (result === "create") {
+              await this.commands.upload(file, device, path);
+              await vscode.window.showTextDocument(uri);
+            }
+          }
+        }
+      });
+
+      if (!devices.length) this.pymakr.notifier.notifications.openOnDeviceNoAvailableDevice(project);
+    },
+
     // todo link to this command from configuration's "Devices: Include" section
     listDevices: async () => {
       let uri = vscode.Uri.parse("pymakrDocument:" + "Pymakr: available devices");

src/utils/Notifier.js

@@ -201,6 +201,27 @@ class Notifier {
         }
       ),
 
+    openOnDeviceFile: () =>
+      this.createNotification(
+        "info",
+        '"Open file on device." opens the corresponding file on all idle devices that are connected to the file\'s project.',
+        {
+          "": [null, this.DONT_SHOW_AGAIN],
+        }
+      ),
+
+    openOnDeviceFileDoesntExist: (file, device) =>
+      this.createNotification("info", `"${file}" does not exist on "${device.name}"`, { create: "Upload it" }),
+
+    openOnDeviceHasNoProject: (file) =>
+      this.createNotification("info", `"${file.path.split("/").pop()}" does not belong to any project.`),
+
+    openOnDeviceNoAvailableDevice: (project) =>
+      this.createNotification(
+        "info",
+        `No available devices found for "${project.name}". Please make sure that at least one idle device is connected to the project.`
+      ),
+
     /**
      *
      * @param {import('../Watcher/DeviceManager').DeviceManager} deviceManager