refactor: - Add non_task example, to show these are not in the CachedMetadata

This involved making getTasksFromFileContent2() accept CachedMetadata with
no ListItemCache.

Author: claremacrae

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

@@ -0,0 +1,21 @@
+# non_tasks
+
+```tasks
+path includes {{query.file.path}}
+```
+
+```
+- [ ] I look like a task but am in a code block
+```
+
+Below is an HTML comment in `<!-- .... ->`, so the "task" inside is not seen by Obsidian or any of its task-based plugins.
+
+<!--
+- [ ] I look like a task but am in an HTML comment
+-->
+
+Below is an Obsidian comment in `%% ... %%`, so the "task" inside is not seen by Obsidian or any of its task-based plugins.
+
+%%
+- [ ] I look like a task but am in an Obsidian (percent) comment
+%%

src/Obsidian/Cache.ts

@@ -22,13 +22,19 @@ export enum State {
 export function getTasksFromFileContent2(
     filePath: string,
     fileContent: string,
-    listItems: ListItemCache[],
+    listItems: ListItemCache[] | undefined,
     logger: Logger,
     fileCache: CachedMetadata,
     errorReporter: (e: any, filePath: string, listItem: ListItemCache, line: string) => void,
 ) {
-    const tasksFile = new TasksFile(filePath, fileCache);
     const tasks: Task[] = [];
+    if (listItems === undefined) {
+        // When called via Cache, this function would never be called or files without list items.
+        // It is useful for tests to be act gracefully on sample Markdown files with no list items, however.
+        return tasks;
+    }
+
+    const tasksFile = new TasksFile(filePath, fileCache);
     const fileLines = fileContent.split('\n');
     const linesInFile = fileLines.length;
 

tests/Obsidian/AllCacheSampleData.ts

@@ -44,6 +44,7 @@ import { multi_line_task_and_list_item } from './__test_data__/multi_line_task_a
 import { multiple_headings } from './__test_data__/multiple_headings';
 import { no_heading } from './__test_data__/no_heading';
 import { no_yaml } from './__test_data__/no_yaml';
+import { non_tasks } from './__test_data__/non_tasks';
 import { one_task } from './__test_data__/one_task';
 import { yaml_1_alias } from './__test_data__/yaml_1_alias';
 import { yaml_2_aliases } from './__test_data__/yaml_2_aliases';
@@ -108,6 +109,7 @@ export function allCacheSampleData() {
         multiple_headings,
         no_heading,
         no_yaml,
+        non_tasks,
         one_task,
         yaml_1_alias,
         yaml_2_aliases,

tests/Obsidian/Cache.test.ts

@@ -627,9 +627,13 @@ describe('all mock files', () => {
 
     it.each(listPathAndData(files))(
         'should be able to read tasks from all mock files: "%s"',
-        (_path: string, file: any) => {
+        (path: string, file: any) => {
             const tasks = readTasksFromSimulatedFile(file);
-            expect(tasks.length).toBeGreaterThan(0);
+            if (path === 'Test Data/non_tasks.md') {
+                expect(tasks.length).toEqual(0);
+            } else {
+                expect(tasks.length).toBeGreaterThan(0);
+            }
         },
     );
 });

tests/Obsidian/__test_data__/non_tasks.ts

@@ -0,0 +1,155 @@
+export const non_tasks = {
+    filePath: 'Test Data/non_tasks.md',
+    fileContents:
+        '# non_tasks\n' +
+        '\n' +
+        '```tasks\n' +
+        'path includes {{query.file.path}}\n' +
+        '```\n' +
+        '\n' +
+        '```\n' +
+        '- [ ] I look like a task but am in a code block\n' +
+        '```\n' +
+        '\n' +
+        'Below is an HTML comment in `<!-- .... ->`, so the "task" inside is not seen by Obsidian or any of its task-based plugins.\n' +
+        '\n' +
+        '<!--\n' +
+        '- [ ] I look like a task but am in an HTML comment\n' +
+        '-->\n' +
+        '\n' +
+        'Below is an Obsidian comment in `%% ... %%`, so the "task" inside is not seen by Obsidian or any of its task-based plugins.\n' +
+        '\n' +
+        '%%\n' +
+        '- [ ] I look like a task but am in an Obsidian (percent) comment\n' +
+        '%%\n',
+    cachedMetadata: {
+        headings: [
+            {
+                position: {
+                    start: {
+                        line: 0,
+                        col: 0,
+                        offset: 0,
+                    },
+                    end: {
+                        line: 0,
+                        col: 11,
+                        offset: 11,
+                    },
+                },
+                heading: 'non_tasks',
+                level: 1,
+            },
+        ],
+        sections: [
+            {
+                type: 'heading',
+                position: {
+                    start: {
+                        line: 0,
+                        col: 0,
+                        offset: 0,
+                    },
+                    end: {
+                        line: 0,
+                        col: 11,
+                        offset: 11,
+                    },
+                },
+            },
+            {
+                type: 'code',
+                position: {
+                    start: {
+                        line: 2,
+                        col: 0,
+                        offset: 13,
+                    },
+                    end: {
+                        line: 4,
+                        col: 3,
+                        offset: 59,
+                    },
+                },
+            },
+            {
+                type: 'code',
+                position: {
+                    start: {
+                        line: 6,
+                        col: 0,
+                        offset: 61,
+                    },
+                    end: {
+                        line: 8,
+                        col: 3,
+                        offset: 116,
+                    },
+                },
+            },
+            {
+                type: 'paragraph',
+                position: {
+                    start: {
+                        line: 10,
+                        col: 0,
+                        offset: 118,
+                    },
+                    end: {
+                        line: 10,
+                        col: 122,
+                        offset: 240,
+                    },
+                },
+            },
+            {
+                type: 'html',
+                position: {
+                    start: {
+                        line: 12,
+                        col: 0,
+                        offset: 242,
+                    },
+                    end: {
+                        line: 14,
+                        col: 3,
+                        offset: 301,
+                    },
+                },
+            },
+            {
+                type: 'paragraph',
+                position: {
+                    start: {
+                        line: 16,
+                        col: 0,
+                        offset: 303,
+                    },
+                    end: {
+                        line: 16,
+                        col: 123,
+                        offset: 426,
+                    },
+                },
+            },
+            {
+                type: 'comment',
+                position: {
+                    start: {
+                        line: 18,
+                        col: 0,
+                        offset: 428,
+                    },
+                    end: {
+                        line: 20,
+                        col: 2,
+                        offset: 498,
+                    },
+                },
+            },
+        ],
+    },
+    obsidianApiVersion: '1.7.5',
+    getAllTags: [],
+    parseFrontMatterTags: null,
+};