Added navigation for tags in editor (#1433)

Author: riccardoferretti

packages/foam-vscode/package.json

@@ -405,6 +405,11 @@
         "title": "Expand all",
         "icon": "$(expand-all)"
       },
+      {
+        "command": "foam-vscode.views.tags-explorer.focus",
+        "title": "Focus on tag",
+        "icon": "$(symbol-number)"
+      },
       {
         "command": "foam-vscode.views.placeholders.show:for-current-file",
         "title": "Show placeholders in current file",

packages/foam-vscode/src/features/navigation-provider.ts

@@ -157,7 +157,7 @@ export class NavigationProvider
       })
     );
 
-    return targets
+    const links: vscode.DocumentLink[] = targets
       .filter(o => o.target.isPlaceholder()) // links to resources are managed by the definition provider
       .map(o => {
         const command = CREATE_NOTE_COMMAND.forPlaceholder(
@@ -180,5 +180,26 @@ export class NavigationProvider
         documentLink.tooltip = `Create note for '${o.target.path}'`;
         return documentLink;
       });
+
+    const tags: vscode.DocumentLink[] = resource.tags.map(tag => {
+      const command = {
+        name: 'foam-vscode.views.tags-explorer.focus',
+        params: [tag.label, documentUri],
+      };
+
+      const documentLink = new vscode.DocumentLink(
+        new vscode.Range(
+          tag.range.start.line,
+          tag.range.start.character,
+          tag.range.end.line,
+          tag.range.end.character
+        ),
+        commandAsURI(command)
+      );
+      documentLink.tooltip = `Explore tag '${tag.label}'`;
+      return documentLink;
+    });
+
+    return links.concat(tags);
   }
 }

packages/foam-vscode/src/features/panels/tags-explorer.ts

@@ -54,6 +54,51 @@ export default async function activate(
           provider,
           node => node.contextValue === 'tag' || node.contextValue === 'folder'
         )
+    ),
+    vscode.commands.registerCommand(
+      `foam-vscode.views.${provider.providerId}.focus`,
+      async (tag?: string, source?: object) => {
+        if (tag == null) {
+          tag = await vscode.window.showQuickPick(
+            Array.from(foam.tags.tags.keys()),
+            {
+              title: 'Select a tag to focus',
+            }
+          );
+        }
+        if (tag == null) {
+          return;
+        }
+        const tagItem = (await provider.findTreeItemByPath(
+          provider.valueToPath(tag)
+        )) as TagItem;
+        if (tagItem == null) {
+          return;
+        }
+        await treeView.reveal(tagItem, {
+          select: true,
+          focus: true,
+          expand: true,
+        });
+        const children = await provider.getChildren(tagItem);
+        const sourceUri = source ? new URI(source) : undefined;
+        const resourceItem = sourceUri
+          ? children.find(
+              t =>
+                t instanceof ResourceTreeItem &&
+                sourceUri.isEqual(t.resource?.uri)
+            )
+          : undefined;
+        // doing it as a two reveal process as revealing just the resource
+        // was only working when the tag item was already expanded
+        if (resourceItem) {
+          treeView.reveal(resourceItem, {
+            select: true,
+            focus: true,
+            expand: false,
+          });
+        }
+      }
     )
   );
 }

packages/foam-vscode/src/features/preview/tag-highlight.ts

@@ -4,6 +4,7 @@ import markdownItRegex from 'markdown-it-regex';
 import { FoamWorkspace } from '../../core/model/workspace';
 import { Logger } from '../../core/utils/log';
 import { isNone } from '../../core/utils';
+import { commandAsURI } from '../../utils/commands';
 
 export const markdownItFoamTags = (
   md: markdownit,
@@ -14,10 +15,7 @@ export const markdownItFoamTags = (
     regex: /(?<=^|\s)(#[0-9]*[\p{L}/_-][\p{L}\p{N}/_-]*)/u,
     replace: (tag: string) => {
       try {
-        const resource = workspace.find(tag);
-        if (isNone(resource)) {
-          return getFoamTag(tag);
-        }
+        return getFoamTag(tag);
       } catch (e) {
         Logger.error(
           `Error while creating link for ${tag} in Preview panel`,
@@ -29,6 +27,8 @@ export const markdownItFoamTags = (
   });
 };
 
+// Commands can't be run in the preview (see https://github.com/microsoft/vscode/issues/102532)
+// for we just return the tag as a span
 const getFoamTag = (content: string) =>
   `<span class='foam-tag'>${content}</span>`;