Add support for the ${command:platformio-ide.activeEnvironment} variable // Issue platformio#1697

Author: ivankravets

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 3.0.1 (2023-??-??)
 
-* Added new ``platformio-ide.uploadAndMonitor`` command to "Upload and Monitor" active environment (useful for custom PlatformIO Toolbar) (issue [#1697](https://github.com/platformio/platformio-vscode-ide/issues/1697))
+* Add support for the ``${command:platformio-ide.activeEnvironment}`` variable that can be used in a custom [PlatformIO Toolbar](https://docs.platformio.org/en/latest/integration/ide/vscode.html#platformio-toolbar) and [VSCode variable substitution](https://code.visualstudio.com/docs/editor/variables-reference) (issue [#1697](https://github.com/platformio/platformio-vscode-ide/issues/1697))
 * Focus on the project configuration output tab only on error (issue [#3535](https://github.com/platformio/platformio-vscode-ide/issues/3535))
 * Fixed an issue with a task runner on Windows 7 (issue [#3481](https://github.com/platformio/platformio-vscode-ide/issues/3481))
 * Fixed "Select All", "Undo", and "Redo" operations on macOS for PIO Home (pull [#3451](https://github.com/platformio/platformio-vscode-ide/pull/3451))

package.json

@@ -154,13 +154,6 @@
         "icon": "$(arrow-right)",
         "enablement": "pioProjectReady"
       },
-      {
-        "command": "platformio-ide.uploadAndMonitor",
-        "title": "Upload and Monitor active environment",
-        "category": "PlatformIO",
-        "icon": "$(arrow-right)",
-        "enablement": "pioProjectReady"
-      },
       {
         "command": "platformio-ide.clean",
         "title": "Clean active environment",

src/project/manager.js

@@ -102,6 +102,9 @@ export default class ProjectManager {
       vscode.commands.registerCommand('platformio-ide._runProjectTask', (task) =>
         this._taskManager.runTask(task)
       ),
+      vscode.commands.registerCommand('platformio-ide.activeEnvironment', () =>
+        this._pool.getActiveObserver().getActiveEnvName()
+      ),
     ];
     this.internalSubscriptions = [];
 

src/project/tasks.js

@@ -235,9 +235,6 @@ export default class ProjectTaskManager {
       vscode.commands.registerCommand('platformio-ide.upload', () =>
         _runTask('Upload')
       ),
-      vscode.commands.registerCommand('platformio-ide.uploadAndMonitor', () =>
-        _runTask('Upload and Monitor')
-      ),
       vscode.commands.registerCommand('platformio-ide.test', () => _runTask('Test')),
       vscode.commands.registerCommand('platformio-ide.clean', () => _runTask('Clean')),
       vscode.commands.registerCommand('platformio-ide.serialMonitor', () =>

src/toolbar.js

@@ -111,16 +111,37 @@ export default class PIOToolbar {
       ),
       vscode.commands.registerCommand(
         PIOToolbar.RUN_BUTTON_COMMANDS_ID,
-        async (button) => {
-          for (const cmd of button.commands) {
-            const args = cmd.args || [];
-            await vscode.commands.executeCommand(
-              cmd.id,
-              ...(Array.isArray(args) ? args : [args])
-            );
-          }
-        }
+        this.onButtonClick.bind(this)
       )
     );
   }
+
+  async onButtonClick(button) {
+    for (const cmd of button.commands) {
+      let args = cmd.args || [];
+      if (!Array.isArray(args)) {
+        args = [args];
+      }
+      for (let i = 0; i < args.length; i++) {
+        args[i] = await this._expandArgVariables(args[i]);
+      }
+      await vscode.commands.executeCommand(cmd.id, ...args);
+    }
+  }
+
+  async _expandArgVariables(arg) {
+    if (!arg.includes('${')) {
+      return arg;
+    }
+    const matches = arg.match(/\$\{[^\}]+\}/g);
+    for (const match of matches) {
+      if (match.startsWith('${command:')) {
+        arg = arg.replace(
+          match,
+          await vscode.commands.executeCommand(match.substring(10, match.length - 1))
+        );
+      }
+    }
+    return arg;
+  }
 }