feat: toggle tree view nesting

Author: pd93

CHANGELOG.md

@@ -11,4 +11,6 @@
   - If no Taskfile is detected a button will appear in the sidebar.
 - Refresh on save.
   - Configurable via `task.updateOn` setting (values: `save` (default) or `manual`).
+- Toggle tree nesting on/off
+  - Configurable via `task.nesting` setting (values: `true` (default) or `false`).
 - Sidebar icon provided by @drite93.

README.md

@@ -29,3 +29,10 @@
 ---
 
 ![Task for Visual Studio Code Preview](./res/preview.png)
+
+## Configuration
+
+| Setting        | Type      | Allowed Values       | Default  | Description                                      |
+| -------------- | --------- | -------------------- | -------- | ------------------------------------------------ |
+| `updateOn`     | `string`  | `"manual"`, `"save"` | `"save"` | When should the task list be updated.            |
+| `tree.nesting` | `boolean` |                      | `true`   | Should the task list be nested or not by default |

package.json

@@ -48,6 +48,18 @@
         "category": "Task",
         "icon": "$(refresh)"
       },
+      {
+        "command": "vscode-task.viewAsList",
+        "title": "View as List",
+        "category": "Task Tree",
+        "icon": "$(list-tree)"
+      },
+      {
+        "command": "vscode-task.viewAsTree",
+        "title": "View as Tree",
+        "category": "Task Tree",
+        "icon": "$(list-flat)"
+      },
       {
         "command": "vscode-task.runTask",
         "title": "Run Task",
@@ -117,7 +129,17 @@
         {
           "command": "vscode-task.refresh",
           "when": "view == vscode-task.tasks",
-          "group": "navigation"
+          "group": "navigation@1"
+        },
+        {
+          "command": "vscode-task.viewAsList",
+          "when": "view == vscode-task.tasks && vscode-task:treeNesting",
+          "group": "navigation@2"
+        },
+        {
+          "command": "vscode-task.viewAsTree",
+          "when": "view == vscode-task.tasks && !vscode-task:treeNesting",
+          "group": "navigation@3"
         }
       ],
       "view/item/context": [
@@ -190,6 +212,17 @@
               ],
               "default": "save",
               "description": "When the list of tasks should be updated."
+            },
+            "tree": {
+              "type": "object",
+              "description": "Tree view configuration options.",
+              "properties": {
+                "nesting": {
+                  "type": "boolean",
+                  "default": true,
+                  "description": "Whether to nest tasks by their namespace in the tree view."
+                }
+              }
             }
           }
         }

res/preview.png

@@ -3,11 +3,11 @@ import * as providers from '../providers';
 import * as models from '../models';
 
 export class ActivityBar {
-    private _provider: providers.Tasks;
+    private _provider: providers.TaskTreeDataProvider;
 
     constructor() {
         // Create the data provider
-        this._provider = new providers.Tasks();
+        this._provider = new providers.TaskTreeDataProvider();
 
         // Register the tree view with its data provider
         vscode.window.createTreeView('vscode-task.tasks', {
@@ -16,7 +16,12 @@ export class ActivityBar {
         });
     }
 
-    public refresh(taskfiles: models.Taskfile[]) {
+    public setTreeNesting(enabled: boolean) {
+        this._provider.setTreeNesting(enabled);
+        this._provider.refresh();
+    }
+
+    public refresh(taskfiles?: models.Taskfile[]) {
         this._provider.refresh(taskfiles);
     }
 }

src/elements/activityBar.ts

@@ -1 +1 @@
-export * from './tasks';
+export * from './taskTreeDataProvider';

src/providers/index.ts

@@ -5,11 +5,19 @@ import * as path from 'path';
 
 const namespaceSeparator = ':';
 
-export class Tasks implements vscode.TreeDataProvider<elements.TreeItem> {
+export class TaskTreeDataProvider implements vscode.TreeDataProvider<elements.TreeItem> {
     private _onDidChangeTreeData: vscode.EventEmitter<elements.TaskTreeItem | undefined> = new vscode.EventEmitter<elements.TaskTreeItem | undefined>();
     readonly onDidChangeTreeData: vscode.Event<elements.TaskTreeItem | undefined> = this._onDidChangeTreeData.event;
     private _taskfiles?: models.Taskfile[];
 
+    constructor(
+        private nestingEnabled: boolean = false
+    ) { }
+
+    setTreeNesting(enabled: boolean) {
+        this.nestingEnabled = enabled;
+    }
+
     getTreeItem(element: elements.TreeItem): vscode.TreeItem {
         return element;
     }
@@ -74,7 +82,7 @@ export class Tasks implements vscode.TreeDataProvider<elements.TreeItem> {
 
                 // Check if the task has a namespace
                 // If it does, add it to the namespace/tasks map
-                if (namespacePath !== "") {
+                if (this.nestingEnabled && namespacePath !== "") {
                     let namespaceLabel = getNamespaceLabel(namespacePath);
                     let namespaceTreeItem = namespaceTreeItems.get(namespaceLabel) ?? new elements.NamespaceTreeItem(
                         namespaceLabel,
@@ -89,7 +97,7 @@ export class Tasks implements vscode.TreeDataProvider<elements.TreeItem> {
 
                 // Otherwise, create a tree item for the task
                 else {
-                    let taskLabel = getTaskLabel(task);
+                    let taskLabel = getTaskLabel(task, this.nestingEnabled);
                     let taskTreeItem = new elements.TaskTreeItem(
                         taskLabel,
                         workspace,
@@ -138,8 +146,10 @@ export class Tasks implements vscode.TreeDataProvider<elements.TreeItem> {
         return workspaceTreeItems;
     }
 
-    refresh(taskfiles: models.Taskfile[]): void {
-        this._taskfiles = taskfiles;
+    refresh(taskfiles?: models.Taskfile[]): void {
+        if (taskfiles) {
+            this._taskfiles = taskfiles;
+        }
         this._onDidChangeTreeData.fire(undefined);
     }
 }
@@ -174,9 +184,9 @@ function getNamespaceLabel(namespacePath: string): string {
     return namespacePath.substring(0, namespacePath.indexOf(namespaceSeparator));
 }
 
-function getTaskLabel(task: models.Task): string {
+function getTaskLabel(task: models.Task, nestingEnabled: boolean): string {
     // If the task has no namespace, return the task's name
-    if (!task.name.includes(namespaceSeparator)) {
+    if (!task.name.includes(namespaceSeparator) || !nestingEnabled) {
         return task.name;
     }
     // Return the task's name by removing the namespace

src/providers/tasks.ts src/providers/taskTreeDataProvider.tssrc/providers/tasks.ts renamed to src/providers/taskTreeDataProvider.ts

@@ -1,24 +1,20 @@
 import * as vscode from 'vscode';
 
-
 export class Settings {
+    public updateOn!: string;
+    public treeNesting!: boolean;
 
     constructor() {
         this.update();
     }
 
-    // Variables
-    public updateOn!: string;
-
     // Fetches all the settings from the workspace configuration file
     public update() {
         // Get the workspace config
         let config = vscode.workspace.getConfiguration("task");
 
-        // Get the configs
-        let updateOn: string | undefined = config.get("updateOn");
-
-        // Set the configs
-        this.updateOn = updateOn !== undefined ? updateOn : "change";
+        // Set the properties
+        this.updateOn = config.get("updateOn") ?? "change";
+        this.treeNesting = config.get("tree.nesting") ?? true;
     }
 }

src/settings.ts

@@ -14,6 +14,7 @@ export class TaskExtension {
         this._settings = new Settings();
         this._activityBar = new elements.ActivityBar();
         this._watcher = vscode.workspace.createFileSystemWatcher("**/*.{yml,yaml}");
+        this.setTreeNesting(this._settings.treeNesting);
     }
 
     public async update(): Promise<void> {
@@ -38,6 +39,11 @@ export class TaskExtension {
         });
     }
 
+    public setTreeNesting(enabled: boolean): void {
+        this._activityBar.setTreeNesting(enabled);
+        vscode.commands.executeCommand('setContext', 'vscode-task:treeNesting', enabled);
+    }
+
     public registerCommands(context: vscode.ExtensionContext): void {
 
         // Initialise Taskfile
@@ -65,6 +71,16 @@ export class TaskExtension {
             this.updateAndRefresh();
         }));
 
+        // View tasks as list
+        context.subscriptions.push(vscode.commands.registerCommand('vscode-task.viewAsList', () => {
+            this.setTreeNesting(false);
+        }));
+
+        // View tasks as tree
+        context.subscriptions.push(vscode.commands.registerCommand('vscode-task.viewAsTree', () => {
+            this.setTreeNesting(true);
+        }));
+
         // Run task
         context.subscriptions.push(vscode.commands.registerCommand('vscode-task.runTask', (treeItem?: elements.TaskTreeItem) => {
             if (treeItem?.task) {