Show project dependencies hierarchically (#1339)

* Show project dependencies hierarchically

Currently the Package Dependencies view lists all dependencies in a flat
list. This list not only includes those explicitly defined in the
project's Package.swift, but also all the dependencies of dependencies.

As such its difficult to tell at a glance how a dependency is included.
It can also be confusing to see dependencies in the list that you did
not explicitly add.

Instead, show a top level list that is only the dependencies explicitly
defined in Package.swift. Expanding one shows any child dependencies of
the dependency. The files in the dependency's folder are still shown as
well, just after any child deps.

Author: plemarquand

assets/test/dependencies/Package.swift

@@ -12,7 +12,7 @@ let package = Package(
     targets: [
         .executableTarget(
             name: "dependencies",
-            dependencies: [.product(name: "MarkdownLib", package: "swift-markdown")],
+            dependencies: [.product(name: "Markdown", package: "swift-markdown")],
             path: "Sources"),
     ]
 )

assets/test/dependencies/Sources/main.swift

@@ -1,4 +1,4 @@
-import MarkdownLib
+import Markdown
 
 print("Test Asset:(dependencies)")
 print(a)

assets/test/identity-different/Package.resolved

@@ -13,13 +13,13 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        .package(name: "cmark", url: "https://github.com/apple/swift-cmark.git", .branch("gfm")),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.5.2"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
             name: "identity-different",
-            dependencies: ["cmark"]),
+            dependencies: [.product(name: "Logging", package: "swift-log")]),
     ]
 )

assets/test/identity-different/Package.swift

@@ -129,6 +129,18 @@
         "icon": "$(refresh)",
         "category": "Swift"
       },
+      {
+        "command": "swift.flatDependenciesList",
+        "title": "Flat Dependencies List View",
+        "icon": "$(list-flat)",
+        "category": "Swift"
+      },
+      {
+        "command": "swift.nestedDependenciesList",
+        "title": "Nested Dependencies List View",
+        "icon": "$(list-tree)",
+        "category": "Swift"
+      },
       {
         "command": "swift.cleanBuild",
         "title": "Clean Build Folder",
@@ -793,6 +805,14 @@
           "command": "swift.openPackage",
           "when": "swift.hasPackage"
         },
+        {
+          "command": "swift.flatDependenciesList",
+          "when": "false"
+        },
+        {
+          "command": "swift.nestedDependenciesList",
+          "when": "false"
+        },
         {
           "command": "swift.useLocalDependency",
           "when": "false"
@@ -898,17 +918,27 @@
         {
           "command": "swift.updateDependencies",
           "when": "view == packageDependencies",
-          "group": "navigation"
+          "group": "navigation@1"
         },
         {
           "command": "swift.resolveDependencies",
           "when": "view == packageDependencies",
-          "group": "navigation"
+          "group": "navigation@2"
         },
         {
           "command": "swift.resetPackage",
           "when": "view == packageDependencies",
-          "group": "navigation"
+          "group": "navigation@3"
+        },
+        {
+          "command": "swift.flatDependenciesList",
+          "when": "view == packageDependencies && !swift.flatDependenciesList",
+          "group": "navigation@4"
+        },
+        {
+          "command": "swift.nestedDependenciesList",
+          "when": "view == packageDependencies && swift.flatDependenciesList",
+          "group": "navigation@5"
         }
       ],
       "view/item/context": [

package.json

@@ -128,13 +128,14 @@ export class FolderContext implements vscode.Disposable {
         await this.swiftPackage.reloadPackageResolved();
     }
 
+    /** reload workspace-state.json for this folder */
+    async reloadWorkspaceState() {
+        await this.swiftPackage.reloadWorkspaceState();
+    }
+
     /** Load Swift Plugins and store in Package */
     async loadSwiftPlugins() {
-        const plugins = await SwiftPackage.loadPlugins(
-            this.folder,
-            this.workspaceContext.toolchain
-        );
-        this.swiftPackage.plugins = plugins;
+        await this.swiftPackage.loadSwiftPlugins(this.workspaceContext.toolchain);
     }
 
     /**

src/FolderContext.ts

@@ -15,6 +15,7 @@
 import * as vscode from "vscode";
 import { FolderContext } from "./FolderContext";
 import { FolderOperation, WorkspaceContext } from "./WorkspaceContext";
+import { BuildFlags } from "./toolchain/BuildFlags";
 
 /**
  * Watches for changes to **Package.swift** and **Package.resolved**.
@@ -25,6 +26,7 @@ import { FolderOperation, WorkspaceContext } from "./WorkspaceContext";
 export class PackageWatcher {
     private packageFileWatcher?: vscode.FileSystemWatcher;
     private resolvedFileWatcher?: vscode.FileSystemWatcher;
+    private workspaceStateFileWatcher?: vscode.FileSystemWatcher;
 
     constructor(
         private folderContext: FolderContext,
@@ -38,6 +40,7 @@ export class PackageWatcher {
     install() {
         this.packageFileWatcher = this.createPackageFileWatcher();
         this.resolvedFileWatcher = this.createResolvedFileWatcher();
+        this.workspaceStateFileWatcher = this.createWorkspaceStateFileWatcher();
     }
 
     /**
@@ -47,6 +50,7 @@ export class PackageWatcher {
     dispose() {
         this.packageFileWatcher?.dispose();
         this.resolvedFileWatcher?.dispose();
+        this.workspaceStateFileWatcher?.dispose();
     }
 
     private createPackageFileWatcher(): vscode.FileSystemWatcher {
@@ -69,6 +73,20 @@ export class PackageWatcher {
         return watcher;
     }
 
+    private createWorkspaceStateFileWatcher(): vscode.FileSystemWatcher {
+        const uri = vscode.Uri.joinPath(
+            vscode.Uri.file(
+                BuildFlags.buildDirectoryFromWorkspacePath(this.folderContext.folder.fsPath, true)
+            ),
+            "workspace-state.json"
+        );
+        const watcher = vscode.workspace.createFileSystemWatcher(uri.fsPath);
+        watcher.onDidCreate(async () => await this.handleWorkspaceStateChange());
+        watcher.onDidChange(async () => await this.handleWorkspaceStateChange());
+        watcher.onDidDelete(async () => await this.handleWorkspaceStateChange());
+        return watcher;
+    }
+
     /**
      * Handles a create or change event for **Package.swift**.
      *
@@ -95,4 +113,14 @@ export class PackageWatcher {
             this.workspaceContext.fireEvent(this.folderContext, FolderOperation.resolvedUpdated);
         }
     }
+
+    /**
+     * Handles a create or change event for **.build/workspace-state.json**.
+     *
+     * This will resolve any changes in the workspace-state.
+     */
+    private async handleWorkspaceStateChange() {
+        await this.folderContext.reloadWorkspaceState();
+        this.workspaceContext.fireEvent(this.folderContext, FolderOperation.workspaceStateUpdated);
+    }
 }