Merge pull request #3520 from obsidian-tasks-group/rename-outlinks

refactor: Rename `outLinks` getters to `outlinks` - changing unreleased code

Author: claremacrae

src/Scripting/TasksFile.ts

@@ -53,7 +53,7 @@ export class TasksFile {
     /**
      * Return an array of {@link Link} in the body of the file.
      */
-    get outLinks(): Link[] {
+    get outlinks(): Link[] {
         return this.cachedMetadata?.links?.map((link) => new Link(link, this.filenameWithoutExtension)) ?? [];
     }
 

src/Task/ListItem.ts

@@ -200,14 +200,14 @@ export class ListItem {
      * The data contest is documented here:
      * https://docs.obsidian.md/Reference/TypeScript+API/LinkCache
      */
-    get rawLinksInFileBody(): LinkCache[] {
+    private 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[] {
+    public get outlinks(): Link[] {
         return this.rawLinksInFileBody
             .filter((link) => link.position.start.line === this.lineNumber)
             .map((link) => new Link(link, this.file.filenameWithoutExtension));

tests/Scripting/TasksFile.test.ts

@@ -241,13 +241,13 @@ describe('TasksFile - reading frontmatter', () => {
 describe('TasksFile - accessing links', () => {
     it('should return all links in the file 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(3);
+        expect(tasksFile.outlinks[0].originalMarkdown).toEqual('[[link_in_file_body]]');
     });
 
     it('should return no yaml links', () => {
         const tasksFile = getTasksFileFromMockData(link_in_yaml);
-        expect(tasksFile.outLinks.length).toEqual(0);
+        expect(tasksFile.outlinks.length).toEqual(0);
     });
 });
 

tests/Task/ListItem.test.ts

@@ -207,23 +207,17 @@ describe('related items', () => {
         expect(grandChild.findClosestParentTask()).toEqual(parentTask);
     });
 });
-describe('outLinks', () => {
-    it('should return all links in the task file', () => {
-        const tasks = readTasksFromSimulatedFile(links_everywhere);
-
-        expect(tasks[0].rawLinksInFileBody.length).toEqual(3);
-    });
-
+describe('outlinks', () => {
     it('should return all links in the task line', () => {
         const tasks = readTasksFromSimulatedFile(links_everywhere);
 
-        expect(tasks[0].outLinks.length).toEqual(1);
-        expect(tasks[0].outLinks[0].originalMarkdown).toEqual('[[link_in_task_wikilink]]');
+        expect(tasks[0].outlinks.length).toEqual(1);
+        expect(tasks[0].outlinks[0].originalMarkdown).toEqual('[[link_in_task_wikilink]]');
     });
 
     it('should return [] when no links in the task line', () => {
         const tasks = readTasksFromSimulatedFile(multi_line_task_and_list_item);
-        expect(tasks[0].outLinks).toEqual([]);
+        expect(tasks[0].outlinks).toEqual([]);
     });
 });