Enhanced the user experience in the "Project Tasks" // Resolve platformio#3750

ivankravets · ivankravets · commit e65705ebbedf · 2023-07-10T14:33:18.000+03:00
diff --git a/.github/media/platformio-toggle-multienv-tasks.gif b/.github/media/platformio-toggle-multienv-tasks.gif
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,12 @@
 
 ## 3.3.0 (2023-07-??)
 
-* Added [Serial & UDP Plotter"](https://marketplace.visualstudio.com/items?itemName=alexnesnes.teleplot) item to the "PlatformIO IDE > Quick Access" menu
-* Updated PlatformIO Core Installer Script to [v1.2.0](https://github.com/platformio/platformio-core-installer/releases/tag/v1.2.0)
+* **Enhanced the user experience in the "Project Tasks" explorer by displaying tasks specific to the selected environment by default.** This improvement provides immediate visibility and access to the relevant tasks associated with the chosen environment, streamlining project navigation and task execution.
+* **Introduced a new option that allows seamless switching between multi-environment project tasks.** This addition empowers developers to effortlessly switch between different environments within a project and view their respective tasks, enabling efficient task management and execution within complex project setups.
+* **Expanded the functionality of the "Actvity Bar > PlatformIO IDE > Quick Access" menu by including a new item called** [Serial & UDP Plotter](https://marketplace.visualstudio.com/items?itemName=alexnesnes.teleplot). This addition simplifies and accelerates access to the Serial and UDP Plotter feature, allowing developers to quickly visualize and analyze data streams from connected devices.
+* **Updated the PlatformIO Core Installer Script to version** [v1.2.0](https://github.com/platformio/platformio-core-installer/releases/tag/v1.2.0). This update ensures that developers have the latest version of the Core Installer, benefiting from bug fixes, performance enhancements, and new features introduced in the latest release. Keeping the Core Installer up to date guarantees a more stable and reliable development environment for PlatformIO users.
+
+![Toggle between Multi Environment Project Tasks](https://raw.githubusercontent.com/platformio/platformio-vscode-ide/develop/.github/media/platformio-toggle-multienv-tasks.gif)
 
 ## 3.2.0 (2023-06-09)
 
diff --git a/package.json b/package.json
@@ -142,40 +142,47 @@
         "icon": "$(plug)",
         "enablement": "pioProjectReady"
       },
+      {
+        "command": "platformio-ide.toggleMultiEnvProjectTasks",
+        "title": "Toggle between Multi Environment Project Tasks",
+        "category": "PlatformIO",
+        "icon": "$(layers)",
+        "enablement": "pioProjectTasksReady"
+      },
       {
         "command": "platformio-ide.refreshProjectTasks",
         "title": "Refresh Project Tasks",
         "category": "PlatformIO",
         "icon": "$(refresh)",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.build",
         "title": "Build",
         "category": "PlatformIO",
         "icon": "$(check)",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.upload",
         "title": "Upload",
         "category": "PlatformIO",
         "icon": "$(arrow-right)",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.uploadAndMonitor",
         "title": "Upload and Monitor",
         "category": "PlatformIO",
         "icon": "$(arrow-right)",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.clean",
         "title": "Clean",
         "category": "PlatformIO",
         "icon": "$(trashcan)",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.serialMonitor",
@@ -189,13 +196,13 @@
         "title": "Test",
         "category": "PlatformIO",
         "icon": "$(beaker)",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.rebuildProjectIndex",
         "title": "Rebuild IntelliSense Index",
         "category": "PlatformIO",
-        "enablement": "pioProjectReady"
+        "enablement": "pioProjectTasksReady"
       },
       {
         "command": "platformio-ide.startDebugging",
@@ -444,12 +451,17 @@
       "view/title": [
         {
           "command": "platformio-ide.pickProjectEnv",
-          "when": "pioMultiEnvProject && view == platformio-ide.projectTasks",
+          "when": "pioProjectTasksReady && pioMultiEnvProject && view == platformio-ide.projectTasks",
+          "group": "navigation"
+        },
+        {
+          "command": "platformio-ide.toggleMultiEnvProjectTasks",
+          "when": "pioProjectTasksReady && view == platformio-ide.projectTasks",
           "group": "navigation"
         },
         {
           "command": "platformio-ide.refreshProjectTasks",
-          "when": "pioProjectReady && view == platformio-ide.projectTasks",
+          "when": "pioProjectTasksReady && view == platformio-ide.projectTasks",
           "group": "navigation"
         },
         {
diff --git a/src/project/manager.js b/src/project/manager.js
@@ -112,6 +112,9 @@ export default class ProjectManager {
       vscode.commands.registerCommand('platformio-ide.refreshProjectTasks', () =>
         this._taskManager.refresh({ force: true })
       ),
+      vscode.commands.registerCommand('platformio-ide.toggleMultiEnvProjectTasks', () =>
+        this._taskManager.toggleMultiEnvExplorer()
+      ),
       vscode.commands.registerCommand('platformio-ide._runProjectTask', (task) =>
         this._taskManager.runTask(task)
       ),
diff --git a/src/project/task-tree.js b/src/project/task-tree.js
@@ -11,12 +11,35 @@ import * as vscode from 'vscode';
 export default class ProjectTasksTreeProvider {
   static DEFAULT_ENV_NAME = 'Default';
 
-  constructor(id, envs, tasks, selectedEnv = undefined) {
+  constructor(id, envs, tasks, selectedEnv = undefined, multiEnvExplorer = false) {
     this.id = id;
     this.envs = envs;
     this.tasks = tasks;
     this.selectedEnv = selectedEnv;
     this.multiEnvProject = this.envs.length > 1;
+    this.multiEnvExplorer = multiEnvExplorer;
+  }
+
+  getEnvTasks(env = undefined, group = undefined) {
+    const cmpGroup = (task) => {
+      if (!group) {
+        return true;
+      }
+      return task.group === group;
+    };
+    const result = this.tasks.filter((task) => cmpGroup(task) && task.coreEnv === env);
+    // merge default/env-independent tasks
+    if (env) {
+      result.push(
+        ...this.tasks.filter(
+          (task) =>
+            cmpGroup(task) &&
+            env !== ProjectTasksTreeProvider.DEFAULT_ENV_NAME &&
+            !task.multienv
+        )
+      );
+    }
+    return result;
   }
 
   getTreeItem(item) {
@@ -40,9 +63,11 @@ export default class ProjectTasksTreeProvider {
 
   getChildren(element) {
     if (element && element.group) {
-      return this.getEnvGroupChildren(element.env, element.group);
+      return this.getEnvTasks(element.env, element.group);
     } else if (element) {
       return this.getEnvChildren(element.env);
+    } else if (this.selectedEnv && !this.multiEnvExplorer) {
+      return this.getEnvChildren(this.selectedEnv);
     }
     return this.getRootChildren();
   }
@@ -64,12 +89,8 @@ export default class ProjectTasksTreeProvider {
     return result;
   }
 
-  getEnvGroupChildren(env, group) {
-    return this.tasks.filter((task) => task.coreEnv === env && task.group === group);
-  }
-
   getEnvChildren(env) {
-    const envTasks = this.tasks.filter((task) => task.coreEnv === env);
+    const envTasks = this.getEnvTasks(env);
     if (!envTasks.length) {
       return [new vscode.TreeItem('Loading...')];
     }
diff --git a/src/project/tasks.js b/src/project/tasks.js
@@ -25,6 +25,7 @@ export default class ProjectTaskManager {
     this.subscriptions = [];
 
     this._sid = Math.random();
+    this._multienvTaskExplorer = false;
     this._refreshTimeout = undefined;
     this._startedTask = undefined;
     this._tasksToRestore = [];
@@ -38,6 +39,11 @@ export default class ProjectTaskManager {
     disposeSubscriptions(this.subscriptions);
   }
 
+  toggleMultiEnvExplorer() {
+    this._multienvTaskExplorer = !this._multienvTaskExplorer;
+    this.refresh({ force: true });
+  }
+
   requestRefresh() {
     if (this._refreshTimeout) {
       clearTimeout(this._refreshTimeout);
@@ -67,7 +73,8 @@ export default class ProjectTaskManager {
         this._sid,
         projectEnvs,
         projectTasks,
-        this.projectObserver.getSelectedEnv()
+        this.projectObserver.getSelectedEnv(),
+        this._multienvTaskExplorer
       ),
       showCollapseAll: true,
     });
@@ -95,6 +102,7 @@ export default class ProjectTaskManager {
 
     this.registerTaskBasedCommands(projectTasks);
     this.registerPortSwitcher();
+    vscode.commands.executeCommand('setContext', 'pioProjectTasksReady', true);
     vscode.commands.executeCommand(
       'setContext',
       'pioMultiEnvProject',
