Merge pull request #3526 from obsidian-tasks-group/feat-frontmatter-outlinks

feat: Add `outlinksInProperties` and `outlinksInBody` - `outlinks` returns both

Author: claremacrae

src/Scripting/TasksFile.ts

@@ -51,9 +51,23 @@ export class TasksFile {
     }
 
     /**
-     * Return an array of {@link Link} in the body of the file.
+     * Return an array of {@link Link} all the links in the file - both in frontmatter and in the file body.
      */
     get outlinks(): Link[] {
+        return [...this.outlinksInProperties, ...this.outlinksInBody];
+    }
+
+    /**
+     * Return an array of {@link Link} in the file's properties/frontmatter.
+     */
+    get outlinksInProperties(): Link[] {
+        return this.cachedMetadata.frontmatterLinks?.map((link) => new Link(link, this.filenameWithoutExtension)) ?? [];
+    }
+
+    /**
+     * Return an array of {@link Link} in the body of the file.
+     */
+    get outlinksInBody(): Link[] {
         return this.cachedMetadata?.links?.map((link) => new Link(link, this.filenameWithoutExtension)) ?? [];
     }
 

tests/Obsidian/Cache.test.ts

@@ -755,21 +755,9 @@ describe('accessing links in file', function () {
 
         const cachedMetadata: CachedMetadata = task.file.cachedMetadata;
 
-        /**
-         * I am thinking of the following, to evantually make links accessible to users.
-         * 1. Provide a class or interface called Link, with fields:
-         *      - displayText, e.g. "link_in_yaml"
-         *      - link, e.g. "link_in_yaml"
-         *      - original, e.g. "[[link_in_yaml]]"
-         * 2. Add some getters that construct the relevant Link objects from cached metadata on demand, such as:
-         *      - task.file.linksInBody
-         *      - task.file.linksInFrontMatter
-         *      - task.file.allLinks
-         *      - task.links
-         * 3. Consider the vocabulary - some dataview users talk about inlines and outlinks.
-         *    The above are all outlinks - but do we want to name them as such, to prepare
-         *    for if or when inlinks are also supported?
-         */
+        // Usability note:
+        //    These tests are for visualising how Obsidian caches link properties.
+        //    See TasksFile and ListItem classes for accessing links via the Link class in Tasks cvode
 
         it('see source', () => {
             expect(data.fileContents).toMatchInlineSnapshot(`
@@ -788,7 +776,7 @@ describe('accessing links in file', function () {
             `);
         });
 
-        it('should access links in frontmatter', () => {
+        it('visualise raw links in frontmatter', () => {
             const frontMatterLinks = cachedMetadata['frontmatterLinks'];
             expect(frontMatterLinks).toBeDefined();
 
@@ -804,7 +792,7 @@ describe('accessing links in file', function () {
                     `);
         });
 
-        it('should access links in file body', () => {
+        it('visualise raw links in file body', () => {
             const fileBodyLinks = cachedMetadata.links;
 
             const originalLinkText = fileBodyLinks?.map((link) => link.original).join('\n');
@@ -836,7 +824,7 @@ describe('accessing links in file', function () {
             `);
         });
 
-        it('should access links in task line', () => {
+        it('visualise raw links in task line', () => {
             const fileBodyLinks = cachedMetadata.links;
             const linksOnTask = fileBodyLinks?.filter((link) => link.position.start.line === task.lineNumber);
 

tests/Scripting/TasksFile.test.ts

@@ -239,15 +239,37 @@ describe('TasksFile - reading frontmatter', () => {
 });
 
 describe('TasksFile - accessing links', () => {
-    it('should return all links in the file body', () => {
+    it('should access all links in the file - both properties and body', () => {
         const tasksFile = getTasksFileFromMockData(links_everywhere);
-        expect(tasksFile.outlinks.length).toEqual(3);
-        expect(tasksFile.outlinks[0].originalMarkdown).toEqual('[[link_in_file_body]]');
+        expect(tasksFile.outlinks.length).toEqual(5);
+        expect(tasksFile.outlinks.map((link) => link.originalMarkdown)).toMatchInlineSnapshot(`
+            [
+              "[[link_in_yaml]]",
+              "[[#A link in a link_in_heading]]",
+              "[[link_in_file_body]]",
+              "[[link_in_heading]]",
+              "[[link_in_task_wikilink]]",
+            ]
+        `);
+    });
+
+    it('should access all links in the file body', () => {
+        {
+            const tasksFile = getTasksFileFromMockData(links_everywhere);
+            expect(tasksFile.outlinksInBody.length).toEqual(3);
+            expect(tasksFile.outlinksInBody[0].originalMarkdown).toEqual('[[link_in_file_body]]');
+        }
+
+        {
+            const tasksFile = getTasksFileFromMockData(link_in_yaml);
+            expect(tasksFile.outlinksInBody.length).toEqual(0);
+        }
     });
 
-    it('should return no yaml links', () => {
+    it('should access all links in properties', () => {
         const tasksFile = getTasksFileFromMockData(link_in_yaml);
-        expect(tasksFile.outlinks.length).toEqual(0);
+        expect(tasksFile.outlinksInProperties.length).toEqual(1);
+        expect(tasksFile.outlinksInProperties[0].originalMarkdown).toEqual('[[yaml_tags_is_empty]]');
     });
 });
 

tests/Task/Link.test.ts

@@ -246,21 +246,27 @@ describe('visualise links', () => {
 
     it('note bodies', () => {
         let output = '';
-        allCacheSampleData().map((file) => {
+        allCacheSampleData().forEach((file) => {
             const tasksFile = getTasksFileFromMockData(file);
-            output += visualiseLinks(tasksFile.outlinks, file);
+            output += visualiseLinks(tasksFile.outlinksInBody, file);
         });
         verifyMarkdown(output);
     });
 
     it('properties', () => {
         let output = '';
-        allCacheSampleData().map((file) => {
+        allCacheSampleData().forEach((file) => {
+            const tasksFile = getTasksFileFromMockData(file);
+            output += visualiseLinks(tasksFile.outlinksInProperties, file);
+        });
+        verifyMarkdown(output);
+    });
+
+    it('outlinks', () => {
+        let output = '';
+        allCacheSampleData().forEach((file) => {
             const tasksFile = getTasksFileFromMockData(file);
-            const frontmatterLinks = tasksFile.cachedMetadata.frontmatterLinks;
-            const links =
-                frontmatterLinks?.map((rawLink) => new Link(rawLink, tasksFile.filenameWithoutExtension)) ?? [];
-            output += visualiseLinks(links, file);
+            output += visualiseLinks(tasksFile.outlinks, file);
         });
         verifyMarkdown(output);
     });