Merge pull request #3357 from byronluk/byronluk/inline-links

fix: convert internal heading links when task is rendered in different file

Fixes #3297.

Author: claremacrae

resources/sample_vaults/Tasks-Demo/Manual Testing/Internal Heading Links/Internal Heading Links.md

@@ -0,0 +1,5 @@
+# Internal Heading Links
+
+```tasks
+filter by function task.file.filename.includes("internal_heading_links")
+```

resources/sample_vaults/Tasks-Demo/Manual Testing/Internal Heading Links/Other File.md

@@ -0,0 +1,3 @@
+# Other File
+
+## Some Header

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

@@ -0,0 +1,43 @@
+# Internal Heading Links Test
+
+This file contains test cases for internal heading links in tasks.
+
+## Simple Headers
+
+## Another Header
+
+## Basic Internal Links
+
+- [ ] #task Task with [[#Basic Internal Links]]
+
+## Multiple Links In One Task
+
+- [ ] #task Task with [[#Multiple Links In One Task]] and [[#Simple Headers]]
+
+## External File Links
+
+- [ ] #task Task with [[Other File]]
+
+## Mixed Link Types
+
+- [ ] #task Task with [[Other File]] and [[#Mixed Link Types]]
+
+## Header Links With File Reference
+
+- [ ] #task [[#Header Links With File Reference]] then [[Other File#Some Header]] and [[#Another Header]]
+
+## Headers-With_Special Characters
+
+- [ ] #task Task with [[#Headers-With_Special Characters]]
+
+## Aliased Links
+
+- [ ] #task Task with [[#Aliased Links|I am an alias]]
+
+## Links In Code Blocks
+
+- [ ] #task Task with `[[#Links In Code Blocks]]` code block
+
+## Escaped Links
+
+- [ ] #task Task with \[\[#Escaped Links\]\] escaped link

src/Renderer/QueryResultsRenderer.ts

@@ -418,7 +418,9 @@ export class QueryResultsRenderer {
         queryRendererParameters: QueryRendererParameters,
     ) {
         const isFilenameUnique = this.isFilenameUnique({ task }, queryRendererParameters.allMarkdownFiles);
-        const listItem = await taskLineRenderer.renderTaskLine(task, taskIndex, isFilenameUnique);
+        const processedTask = this.processTaskLinks(task);
+
+        const listItem = await taskLineRenderer.renderTaskLine(processedTask, taskIndex, isFilenameUnique);
 
         // Remove all footnotes. They don't re-appear in another document.
         const footnotes = listItem.querySelectorAll('[data-footnote-id]');
@@ -545,6 +547,43 @@ export class QueryResultsRenderer {
         }
     }
 
+    private processTaskLinks(task: Task): Task {
+        // Skip if task is from the same file as the query
+        if (this.filePath === task.path) {
+            return task;
+        }
+
+        const linkCache = task.file.cachedMetadata.links;
+        if (!linkCache) return task;
+
+        // Find links in the task description
+        const taskLinks = linkCache.filter((link) => {
+            return (
+                link.position.start.line === task.taskLocation.lineNumber &&
+                task.description.includes(link.original) &&
+                link.link.startsWith('#')
+            );
+        });
+        if (taskLinks.length === 0) return task;
+
+        let description = task.description;
+
+        // a task can only be from one file, so we can replace all the internal links
+        //in the description with the new file path
+        for (const link of taskLinks) {
+            const fullLink = `[[${task.path}${link.link}|${link.displayText}]]`;
+            description = description.replace(link.original, fullLink);
+        }
+
+        // Return a new Task with the updated description
+        return new Task({
+            ...task,
+            description,
+            // Preserve the original task's location information
+            taskLocation: task.taskLocation,
+        });
+    }
+
     private addPostponeButton(listItem: HTMLElement, task: Task, shortMode: boolean) {
         const amount = 1;
         const timeUnit = 'day';

tests/Obsidian/AllCacheSampleData.ts

@@ -35,6 +35,7 @@ import inheritance_task_listitem from './__test_data__/inheritance_task_listitem
 import inheritance_task_listitem_mixed_grandchildren from './__test_data__/inheritance_task_listitem_mixed_grandchildren.json';
 import inheritance_task_listitem_task from './__test_data__/inheritance_task_listitem_task.json';
 import inheritance_task_mixed_children from './__test_data__/inheritance_task_mixed_children.json';
+import internal_heading_links from './__test_data__/internal_heading_links.json';
 import jason_properties from './__test_data__/jason_properties.json';
 import link_in_file_body from './__test_data__/link_in_file_body.json';
 import link_in_file_body_with_custom_display_text from './__test_data__/link_in_file_body_with_custom_display_text.json';
@@ -113,6 +114,7 @@ export function allCacheSampleData() {
         inheritance_task_listitem_mixed_grandchildren,
         inheritance_task_listitem_task,
         inheritance_task_mixed_children,
+        internal_heading_links,
         jason_properties,
         link_in_file_body,
         link_in_file_body_with_custom_display_text,