Merge pull request #3516 from obsidian-tasks-group/tests-for-issue-3481

vault, tests: Visualise Obsidian, dataview & Tasks behaviour with #3481

Author: claremacrae

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

@@ -0,0 +1,12 @@
+# numbered_tasks_issue_3481
+
+See https://github.com/obsidian-tasks-group/obsidian-tasks/issues/3481.
+
+- [ ] 1. #task Task 1 in 'numbered_tasks_issue_3481'
+- [ ] 2 #task Task 2 in 'numbered_tasks_issue_3481'
+- [ ] 3) #task Task 3 in 'numbered_tasks_issue_3481'
+- [ ] 4 - #task Task 4 in 'numbered_tasks_issue_3481'
+- [ ] 5: #task Task 5 in 'numbered_tasks_issue_3481'
+- [ ] (6) #task Task 6 in 'numbered_tasks_issue_3481'
+
+The file [[numbered_tasks_issue_3481_searches]] shows how Obsidian and some plugins parse the above data.

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

@@ -0,0 +1,38 @@
+# numbered_tasks_issue_3481_searches
+
+## Tasks
+
+The Tasks plugin finds ==6 tasks==, but with 2 nested list items.
+
+### show tree
+
+```tasks
+path includes numbered_tasks_issue_3481
+show tree
+full mode
+```
+
+### hide tree
+
+```tasks
+path includes numbered_tasks_issue_3481
+hide tree
+full mode
+```
+
+## Dataview
+
+Dataview finds ==4 tasks==:
+
+```dataview
+TASK
+FROM "Test Data/numbered_tasks_issue_3481"
+```
+
+## Obsidian search
+
+Obsidian finds ==6 tasks==:
+
+```query
+task:3481
+```

tests/Obsidian/AllCacheSampleData.ts

@@ -57,6 +57,8 @@ import no_yaml from './__test_data__/no_yaml.json';
 import non_tasks from './__test_data__/non_tasks.json';
 import numbered_list_items_standard from './__test_data__/numbered_list_items_standard.json';
 import numbered_list_items_with_paren from './__test_data__/numbered_list_items_with_paren.json';
+import numbered_tasks_issue_3481 from './__test_data__/numbered_tasks_issue_3481.json';
+import numbered_tasks_issue_3481_searches from './__test_data__/numbered_tasks_issue_3481_searches.json';
 import one_task from './__test_data__/one_task.json';
 import query_file_defaults_all_options_false from './__test_data__/query_file_defaults_all_options_false.json';
 import query_file_defaults_all_options_null from './__test_data__/query_file_defaults_all_options_null.json';
@@ -150,6 +152,8 @@ export function allCacheSampleData(): SimulatedFile[] {
         non_tasks,
         numbered_list_items_standard,
         numbered_list_items_with_paren,
+        numbered_tasks_issue_3481,
+        numbered_tasks_issue_3481_searches,
         one_task,
         query_file_defaults_all_options_false,
         query_file_defaults_all_options_null,

tests/Obsidian/Cache.test.ts

@@ -28,6 +28,7 @@ import inheritance_task_listitem_task from './__test_data__/inheritance_task_lis
 import inheritance_task_mixed_children from './__test_data__/inheritance_task_mixed_children.json';
 import numbered_list_items_with_paren from './__test_data__/numbered_list_items_with_paren.json';
 import numbered_list_items_standard from './__test_data__/numbered_list_items_standard.json';
+import numbered_tasks_issue_3481 from './__test_data__/numbered_tasks_issue_3481.json';
 import one_task from './__test_data__/one_task.json';
 import callouts_nested_issue_2890_labelled from './__test_data__/callouts_nested_issue_2890_labelled.json';
 import callout from './__test_data__/callout.json';
@@ -177,6 +178,48 @@ describe('cache', () => {
         expect(tasks.length).toEqual(2);
     });
 
+    it('visualise how Tasks handles sample tasks in issue #3481', () => {
+        // This test name does not yet begin 'should', because it is only documenting/visualsing
+        // the current behaviour - and not stating that the current behaviour is correct.
+
+        // See https://github.com/obsidian-tasks-group/obsidian-tasks/issues/3481
+        //      "Tasks query turns single-line tasks into multi-line tasks"
+        const data = numbered_tasks_issue_3481;
+        const tasks = readTasksFromSimulatedFile(data);
+        expect(data.fileContents).toMatchInlineSnapshot(`
+            "# numbered_tasks_issue_3481
+
+            See https://github.com/obsidian-tasks-group/obsidian-tasks/issues/3481.
+
+            - [ ] 1. #task Task 1 in 'numbered_tasks_issue_3481'
+            - [ ] 2 #task Task 2 in 'numbered_tasks_issue_3481'
+            - [ ] 3) #task Task 3 in 'numbered_tasks_issue_3481'
+            - [ ] 4 - #task Task 4 in 'numbered_tasks_issue_3481'
+            - [ ] 5: #task Task 5 in 'numbered_tasks_issue_3481'
+            - [ ] (6) #task Task 6 in 'numbered_tasks_issue_3481'
+
+            The file [[numbered_tasks_issue_3481_searches]] shows how Obsidian and some plugins parse the above data.
+            "
+        `);
+
+        // This shows the current behaviour of the Tasks code for processing Obsidian listItems.
+        // The two nested ListItem lines are not expected.
+        // But reviewing the listItems values in numbered_tasks_issue_3481.json, it is plausible
+        // to see why Tasks might have created them.
+        expect(printRoots(tasks)).toMatchInlineSnapshot(`
+            "- [ ] 1. #task Task 1 in 'numbered_tasks_issue_3481' : Task
+                - [ ] 1. #task Task 1 in 'numbered_tasks_issue_3481' : ListItem
+            - [ ] 2 #task Task 2 in 'numbered_tasks_issue_3481' : Task
+            - [ ] 3) #task Task 3 in 'numbered_tasks_issue_3481' : Task
+                - [ ] 3) #task Task 3 in 'numbered_tasks_issue_3481' : ListItem
+            - [ ] 4 - #task Task 4 in 'numbered_tasks_issue_3481' : Task
+            - [ ] 5: #task Task 5 in 'numbered_tasks_issue_3481' : Task
+            - [ ] (6) #task Task 6 in 'numbered_tasks_issue_3481' : Task
+            "
+        `);
+        expect(tasks.length).toEqual(6);
+    });
+
     it('should read one parent and one child task', () => {
         const tasks = readTasksFromSimulatedFile(inheritance_1parent1child);
         expect(inheritance_1parent1child.fileContents).toMatchInlineSnapshot(`
@@ -852,6 +895,7 @@ describe('all mock files', () => {
             const files_without_tasks = [
                 'Test Data/docs_sample_for_explain_query_file_defaults.md',
                 'Test Data/non_tasks.md',
+                'Test Data/numbered_tasks_issue_3481_searches.md',
             ];
             if (files_without_tasks.includes(path)) {
                 expect(tasks.length).toEqual(0);