Improvements in tree views (#1220)

foambubble · May 2, 2023 · 93c5d2f · 93c5d2f
1 parent 1c294d8
commit 93c5d2f
Show file tree

Hide file tree

Showing 6 changed files with 140 additions and 120 deletions.
diff --git a/packages/foam-vscode/src/features/panels/backlinks.ts b/packages/foam-vscode/src/features/panels/backlinks.ts
@@ -10,6 +10,7 @@ import { fromVsCodeUri } from '../../utils/vsc-utils';
 import {
   ResourceRangeTreeItem,
   ResourceTreeItem,
+  createBacklinkItemsForResource,
   groupRangesByResource,
 } from '../../utils/tree-view-utils';
 
@@ -65,17 +66,12 @@ export class BacklinksTreeDataProvider
       return Promise.resolve([]);
     }
 
-    const connections = this.graph
-      .getConnections(uri)
-      .filter(c => c.target.asPlain().isEqual(uri));
-
-    const backlinkItems = connections.map(c =>
-      ResourceRangeTreeItem.createStandardItem(
-        this.workspace,
-        this.workspace.get(c.source),
-        c.link.range
-      )
+    const backlinkItems = createBacklinkItemsForResource(
+      this.workspace,
+      this.graph,
+      uri
     );
+
     return groupRangesByResource(
       this.workspace,
       backlinkItems,

diff --git a/packages/foam-vscode/src/features/panels/orphans.ts b/packages/foam-vscode/src/features/panels/orphans.ts
@@ -5,6 +5,9 @@ import { getOrphansConfig } from '../../settings';
 import { FoamFeature } from '../../types';
 import { GroupedResourcesTreeDataProvider } from '../../utils/grouped-resources-tree-data-provider';
 import { ResourceTreeItem, UriTreeItem } from '../../utils/tree-view-utils';
+import { IMatcher } from '../../core/services/datastore';
+import { FoamWorkspace } from '../../core/model/workspace';
+import { FoamGraph } from '../../core/model/graph';
 
 const EXCLUDE_TYPES = ['image', 'attachment'];
 const feature: FoamFeature = {
@@ -17,24 +20,11 @@ const feature: FoamFeature = {
     const { matcher } = await createMatcherAndDataStore(
       getOrphansConfig().exclude
     );
-    const provider = new GroupedResourcesTreeDataProvider(
-      'orphans',
-      'orphan',
+    const provider = new OrphanTreeView(
       context.globalState,
-      matcher,
-      () =>
-        foam.graph
-          .getAllNodes()
-          .filter(
-            uri =>
-              !EXCLUDE_TYPES.includes(foam.workspace.find(uri)?.type) &&
-              foam.graph.getConnections(uri).length === 0
-          ),
-      uri => {
-        return uri.isPlaceholder()
-          ? new UriTreeItem(uri)
-          : new ResourceTreeItem(foam.workspace.find(uri), foam.workspace);
-      }
+      foam.workspace,
+      foam.graph,
+      matcher
     );
 
     const treeView = vscode.window.createTreeView('foam-vscode.orphans', {
@@ -56,4 +46,30 @@ const feature: FoamFeature = {
   },
 };
 
+export class OrphanTreeView extends GroupedResourcesTreeDataProvider {
+  constructor(
+    state: vscode.Memento,
+    private workspace: FoamWorkspace,
+    private graph: FoamGraph,
+    matcher: IMatcher
+  ) {
+    super('orphans', 'orphan', state, matcher);
+  }
+
+  createTreeItem = uri => {
+    return uri.isPlaceholder()
+      ? new UriTreeItem(uri)
+      : new ResourceTreeItem(this.workspace.find(uri), this.workspace);
+  };
+
+  computeResources = () =>
+    this.graph
+      .getAllNodes()
+      .filter(
+        uri =>
+          !EXCLUDE_TYPES.includes(this.workspace.find(uri)?.type) &&
+          this.graph.getConnections(uri).length === 0
+      );
+}
+
 export default feature;
diff --git a/packages/foam-vscode/src/features/panels/placeholders.ts b/packages/foam-vscode/src/features/panels/placeholders.ts
@@ -5,14 +5,15 @@ import { getPlaceholdersConfig } from '../../settings';
 import { FoamFeature } from '../../types';
 import { GroupedResourcesTreeDataProvider } from '../../utils/grouped-resources-tree-data-provider';
 import {
-  ResourceRangeTreeItem,
   UriTreeItem,
+  createBacklinkItemsForResource,
   groupRangesByResource,
 } from '../../utils/tree-view-utils';
 import { IMatcher } from '../../core/services/datastore';
 import { ContextMemento, fromVsCodeUri } from '../../utils/vsc-utils';
 import { FoamGraph } from '../../core/model/graph';
 import { URI } from '../../core/model/uri';
+import { FoamWorkspace } from '../../core/model/workspace';
 
 const feature: FoamFeature = {
   activate: async (
@@ -25,7 +26,8 @@ const feature: FoamFeature = {
     );
     const provider = new PlaceholderTreeView(
       context.globalState,
-      foam,
+      foam.workspace,
+      foam.graph,
       matcher
     );
 
@@ -56,42 +58,19 @@ const feature: FoamFeature = {
 };
 
 export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
-  private graph: FoamGraph;
   public show = new ContextMemento<'all' | 'for-current-file'>(
     this.state,
     `foam-vscode.views.${this.providerId}.show`,
     'all'
   );
 
-  public constructor(state: vscode.Memento, foam: Foam, matcher: IMatcher) {
-    super(
-      'placeholders',
-      'placeholder',
-      state,
-      matcher,
-      () => {
-        // we override computeResources below (as we can't use "this" here)
-        throw new Error('Not implemented');
-      },
-      uri => {
-        return new UriTreeItem(uri, {
-          icon: 'link',
-          getChildren: async () => {
-            return groupRangesByResource(
-              foam.workspace,
-              foam.graph.getBacklinks(uri).map(link => {
-                return ResourceRangeTreeItem.createStandardItem(
-                  foam.workspace,
-                  foam.workspace.get(link.source),
-                  link.link.range
-                );
-              })
-            );
-          },
-        });
-      }
-    );
-    this.graph = foam.graph;
+  public constructor(
+    state: vscode.Memento,
+    private workspace: FoamWorkspace,
+    private graph: FoamGraph,
+    matcher: IMatcher
+  ) {
+    super('placeholders', 'placeholder', state, matcher);
     this.disposables.push(
       vscode.commands.registerCommand(
         `foam-vscode.views.${this.providerId}.show:all`,
@@ -110,6 +89,20 @@ export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
     );
   }
 
+  createTreeItem = uri => {
+    const item = new UriTreeItem(uri, {
+      collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,
+    });
+    item.getChildren = async () => {
+      return groupRangesByResource(
+        this.workspace,
+        createBacklinkItemsForResource(this.workspace, this.graph, uri)
+      );
+    };
+    item.iconPath = new vscode.ThemeIcon('link');
+    return item;
+  };
+
   computeResources = (): URI[] => {
     if (this.show.get() === 'for-current-file') {
       const currentFile = vscode.window.activeTextEditor?.document.uri;

diff --git a/packages/foam-vscode/src/features/panels/tags-explorer.ts b/packages/foam-vscode/src/features/panels/tags-explorer.ts
@@ -120,7 +120,8 @@ export class TagsProvider implements vscode.TreeDataProvider<TagTreeItem> {
           ResourceRangeTreeItem.createStandardItem(
             this.workspace,
             note,
-            t.range
+            t.range,
+            'tag'
           )
         );
         return [...acc, ...items];

diff --git a/packages/foam-vscode/src/utils/grouped-resources-tree-data-provider.ts b/packages/foam-vscode/src/utils/grouped-resources-tree-data-provider.ts
@@ -84,8 +84,12 @@ export class GroupedResourcesTreeDataProvider
     private resourceName: string,
     protected state: vscode.Memento,
     private matcher: IMatcher,
-    protected computeResources: () => Array<URI>,
-    private createTreeItem: (item: URI) => GroupedResourceTreeItem
+    protected computeResources: () => Array<URI> = () => {
+      throw new Error('Not implemented');
+    },
+    protected createTreeItem: (item: URI) => GroupedResourceTreeItem = () => {
+      throw new Error('Not implemented');
+    }
   ) {
     this.disposables.push(
       vscode.commands.registerCommand(
@@ -151,7 +155,7 @@ export class GroupedResourcesTreeDataProvider
   resolveTreeItem(
     item: GroupedResourceTreeItem
   ): Promise<GroupedResourceTreeItem> {
-    return item.resolveTreeItem();
+    return item.resolveTreeItem() as Promise<GroupedResourceTreeItem>;
   }
 
   private doComputeResources(): void {