feat: Add ability to filter and group by linked note (#3466)

* feat: Add access to links in body of note

Co-Authored-By: rhhub <[email protected]>

* feat: Add task.links, to access links on task line

Co-Authored-By: rhhub <[email protected]>

* Added experimental Link class.

* Added destination and displayText getters to Link class.

* chore: add Test-TasksInLocalObsidian.bat

* refactor: . moved Link class to own file

* test: - Move link test to appropiate file.

* refactor: - ListItem.links now returns Link object

* refactor: . rename ListItem.links to .outLinks

* feat: added TasksFile.outLinks

* refactor: - change return type of get outLinks to Link

* create script for running hot reload plugins

* Renamed and added comments.

* update to accept multiple target vaults, group repo settings, clean up comments

* Fix splitting, add notes.

* feat: Create destinationFilename getter.

* test: ensure ListItem.outlinks return empty array when no links on line

* feat: link.destinationFilename now handles internal heading links

* test: add test for internal alias link

* chore - Add .yarn to .gitignore

* fix - ensure validation works correctly

* feat: handle wikilink with path

* perf: increased performande of destinationFilename()

* test: test destinationFilename for wikilink with path and heading link

* test: add case for alias in destinationFilename

* test: add path/path and alias case for destinationFilename

* feat: handle # in path

* fix: don't handle # in path

* test: add 2 more tests

* chore: add link_in_task_wikilink for the prior tests

* feat: remove .md from destinationFilename() and refactor

* test: basic wikilink

* feat: handle markdown links

* test: add more test cases for markdown links

* test: destinationFilename empty links and cleanup

* refactor: headings

* chore: clean up

* refactor: use slice

* refactor: clean up

* chore: feat-access-links depends on generating these

* refactor: clean up and comment

* test: Push to test script on macbook.

* Revert "test: Push to test script on macbook."

This reverts commit 765aa4e.

* temp to track

* pull: untrack Untitled.md

* pull: git rm --cached .\scripts\Test-TasksInLocalObsidianCrossPlatform.ps1

* pull: make more readable

* test: add test to ensure no links from yaml section and rename test

* pull: make first line level 1 heading

* refactor: rename to rawLinksInFileBody

---------

Co-authored-by: Clare Macrae <[email protected]>

Author: hollowhemlock

.gitignore

@@ -4,6 +4,7 @@
 
 # npm
 node_modules
+.yarn
 yarn-error.log
 
 # build

resources/sample_vaults/Tasks-Demo/Test Data/link_in_task_markdown_link.md

@@ -1,3 +1,51 @@
 # link_in_task_markdown_link
 
-- [ ] #task Task in 'link_in_task_markdown_link' [jason_properties](jason_properties) [multiple_headings](multiple_headings)
+## Multiple Links
+
+- [ ] #task Multiple Links [jason_properties](jason_properties.md) [multiple_headings](multiple_headings.md)
+
+## Link with Simple Link
+
+- [ ] #task Link with Markdown Extension [link_in_task_markdown_link](link_in_task_markdown_link.md)
+
+## Link with Path
+
+- [ ] #task Link with Path [link_in_task_markdown_link](path/link_in_task_markdown_link.md)
+
+## Link with Path Heading Link
+
+- [ ] #task Link with Heading Reference Link [heading_link](path/link_in_task_markdown_link.md#heading_link)
+
+## Link with Alias
+
+- [ ] #task Link with Alias [alias](link_in_task_markdown_link.md)
+
+## Link with Nested Path and Alias
+
+- [ ] #task Link with Nested Path and Alias [alias](path/path/link_in_task_markdown_link.md)
+
+## Link with Hash in Path
+
+- [ ] #task Heading Link with text that looks like a path [link_in_task_markdown_link](pa#th/path/link_in_task_markdown_link.md)
+
+## Link with Internal Link
+
+- [ ] #task Link with Internal Link [heading](#heading)
+
+## Link with Markdown Link No Suffix
+
+- [ ] #task Link with Markdown Link No Suffix [link_in_task_markdown_link](link_in_task_markdown_link)
+
+## Link with PDF File
+
+- [ ] #task Link with PDF File [a_pdf_file](a_pdf_file.pdf)
+
+## Link with Spaces
+
+- [ ] Link with spaces everywhere[spaces everywhere](Test%20Data/spaced%20filename%20link.md#spaced%20heading)
+
+## Empty Links That Aren't Processed
+
+- [ ] #task Link with empty link []()
+- [ ] #task Link with empty link [alias]()
+

resources/sample_vaults/Tasks-Demo/Test Data/link_in_task_wikilink.md

@@ -1,3 +1,43 @@
 # link_in_task_wikilink
 
-- [ ] #task Task in 'link_in_task_wikilink' [[link_in_task_wikilink]] [[multiple_headings]]
+## Multiple
+
+- [ ]  #task Link with Multiple Wikilinks [[link_in_task_wikilink]] [[multiple_headings]]
+
+## Link with Simple Path
+
+- [ ]  #task Link with Simple Path [[path/link_in_task_wikilink]]
+
+## Link with Heading Reference
+
+- [ ]  #task Link with Heading Reference [[path/link_in_task_wikilink#heading_link]]
+
+## Link with Alias
+
+- [ ]  #task Link with Alias [[link_in_task_wikilink|alias]]
+
+## Link with Nested Path and Alias
+
+- [ ]  #task Link with Nested Path and Alias [[path/path/link_in_task_wikilink|alias]]
+
+## Link with Hash in Path
+
+- [ ]  #task Link with Hash in Path [[pa#th/path/link_in_task_wikilink]]
+
+## Link with Markdown File Extension
+
+- [ ]  #task Link with Markdown File Extension [[link_in_task_wikilink.md]]
+
+## Link with PDF File
+
+- [ ]  #task Link with PDF File [[a_pdf_file.pdf]]
+
+## Empty Link That Obsidian Doesn't Parse
+
+- [ ] #task Link with empty link [[]]
+
+## Empty Links That Obsidian Parses
+
+- [ ] #task Link with empty link [[|]]
+- [ ] #task Link with empty link [[|alias]]
+- [ ] #task Link with empty link [[|#alias]]

scripts/Test-TasksInLocalObsidian.bat

@@ -0,0 +1,5 @@
+rem Should be run from root of repository
+copy "main.js"          "resources\sample_vaults\Tasks-Demo\.obsidian\plugins\obsidian-tasks-plugin\"
+copy "manifest.json"    "resources\sample_vaults\Tasks-Demo\.obsidian\plugins\obsidian-tasks-plugin\"
+copy "styles.css"       "resources\sample_vaults\Tasks-Demo\.obsidian\plugins\obsidian-tasks-plugin\"
+

src/Scripting/TasksFile.ts

@@ -1,4 +1,5 @@
 import { type CachedMetadata, type FrontMatterCache, getAllTags, parseFrontMatterTags } from 'obsidian';
+import { Link } from '../Task/Link';
 
 export type OptionalTasksFile = TasksFile | undefined;
 
@@ -49,6 +50,13 @@ export class TasksFile {
         return this._tags;
     }
 
+    /**
+     * Return a array of Link in the body of the file.
+     */
+    get outLinks(): Link[] {
+        return this.cachedMetadata?.links?.map((link) => new Link(link, this.filenameWithoutExtension)) ?? [];
+    }
+
     /**
      * Return Obsidian's [CachedMetadata](https://docs.obsidian.md/Reference/TypeScript+API/CachedMetadata)
      * for this file, if available.

src/Task/Link.ts

@@ -0,0 +1,45 @@
+import type { LinkCache } from 'obsidian';
+
+export class Link {
+    private rawLink: LinkCache;
+    private filename: string;
+
+    /**
+     * @param {LinkCache} rawLink - The raw link from Obsidian cache.
+     * @param {string} filename - The name of the file where this link is located.
+     */
+    constructor(rawLink: LinkCache, filename: string) {
+        this.rawLink = rawLink;
+        this.filename = filename;
+    }
+
+    public get originalMarkdown() {
+        return this.rawLink.original;
+    }
+
+    public get destination() {
+        return this.rawLink.link;
+    }
+
+    /**
+     * Returns the filename of the link destination without the path or alias
+     * Removes the .md extension if present leaves other extensions intact.
+     * No accomodation for empty links.
+     * @returns {string}
+     */
+    public get destinationFilename() {
+        // Handle internal links (starting with '#')
+        if (this.destination[0] === '#') return this.filename;
+
+        // Extract filename from path (handles both path and optional hash fragment)
+        const pathPart = this.destination.split('#', 1)[0];
+        const destFilename = pathPart.substring(pathPart.lastIndexOf('/') + 1);
+
+        // Remove.md extension if present
+        return destFilename.endsWith('.md') ? destFilename.slice(0, -3) : destFilename;
+    }
+
+    public get displayText() {
+        return this.rawLink.displayText;
+    }
+}

src/Task/ListItem.ts

@@ -1,7 +1,9 @@
+import type { LinkCache } from 'obsidian';
 import type { TasksFile } from '../Scripting/TasksFile';
 import type { Task } from './Task';
 import type { TaskLocation } from './TaskLocation';
 import { TaskRegularExpressions } from './TaskRegularExpressions';
+import { Link } from './Link';
 
 export class ListItem {
     // The original line read from file.
@@ -191,6 +193,26 @@ export class ListItem {
         return this.taskLocation.tasksFile;
     }
 
+    /**
+     * Return a list of links in the body of the file containing
+     * the task or list item.
+     *
+     * The data contest is documented here:
+     * https://docs.obsidian.md/Reference/TypeScript+API/LinkCache
+     */
+    get rawLinksInFileBody(): LinkCache[] {
+        return this.file.cachedMetadata?.links ?? [];
+    }
+
+    /**
+     * Return a list of links in the task or list item's line.
+     */
+    public get outLinks(): Link[] {
+        return this.rawLinksInFileBody
+            .filter((link) => link.position.start.line === this.lineNumber)
+            .map((link) => new Link(link, this.file.filenameWithoutExtension));
+    }
+
     /**
      * Return the name of the file containing this object, with the .md extension removed.
      */