test: Show that 'Simple Tab Indent' plugin breaks task reading

https://github.com/hoomersinpsom/simple-tab-indent

Author: claremacrae

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

@@ -0,0 +1,10 @@
+# zero_width
+
+- Root 1
+	- [ ] #task Task line 1 in 'zero_width' - indented by tab character
+- Root 2
+​	- [ ] #task Task line 2 in 'zero_width' - indented by ZWSP + tab character
+
+```tasks
+path includes {{query.file.path}}
+```

tests/Obsidian/AllCacheSampleData.ts

@@ -81,6 +81,7 @@ import yaml_tags_with_one_value_on_new_line from './__test_data__/yaml_tags_with
 import yaml_tags_with_one_value_on_single_line from './__test_data__/yaml_tags_with_one_value_on_single_line.json';
 import yaml_tags_with_two_values_on_one_line from './__test_data__/yaml_tags_with_two_values_on_one_line.json';
 import yaml_tags_with_two_values_on_two_lines from './__test_data__/yaml_tags_with_two_values_on_two_lines.json';
+import zero_width from './__test_data__/zero_width.json';
 
 /**
  * All the sample data in `resources/sample_vaults/Tasks-Demo/Test Data`.
@@ -171,5 +172,6 @@ export function allCacheSampleData(): SimulatedFile[] {
         yaml_tags_with_one_value_on_single_line,
         yaml_tags_with_two_values_on_one_line,
         yaml_tags_with_two_values_on_two_lines,
+        zero_width,
     ];
 }

tests/Obsidian/FileParser.test.ts

@@ -1,5 +1,6 @@
 import { readTasksFromSimulatedFile } from './SimulatedFile';
 import multiple_headings from './__test_data__/multiple_headings.json';
+import zero_width from './__test_data__/zero_width.json';
 
 describe('FileParser', () => {
     it('should set all non-TasksFile data in TaskLocation', () => {
@@ -44,4 +45,17 @@ describe('FileParser', () => {
             ]
         `);
     });
+
+    it('does not read task lines beginning with a ZWSP - zero-width space', () => {
+        // Demo the behaviour of Obsidian when then Simple Tab Indent plugin indents what looks like a task line.
+        // https://github.com/hoomersinpsom/simple-tab-indent
+        const data = zero_width;
+        expect(data.fileContents).toContain("- [ ] #task Task line 1 in 'zero_width' - indented by tab character");
+        expect(data.fileContents).toContain(
+            "- [ ] #task Task line 2 in 'zero_width' - indented by ZWSP + tab character",
+        );
+        const tasks = readTasksFromSimulatedFile(data);
+        expect(tasks.length).toEqual(1);
+        expect(tasks[0].description).toEqual("#task Task line 1 in 'zero_width' - indented by tab character");
+    });
 });

tests/Obsidian/__test_data__/zero_width.json

@@ -0,0 +1,156 @@
+{
+  "cachedMetadata": {
+    "headings": [
+      {
+        "heading": "zero_width",
+        "level": 1,
+        "position": {
+          "end": {
+            "col": 12,
+            "line": 0,
+            "offset": 12
+          },
+          "start": {
+            "col": 0,
+            "line": 0,
+            "offset": 0
+          }
+        }
+      }
+    ],
+    "listItems": [
+      {
+        "parent": -2,
+        "position": {
+          "end": {
+            "col": 8,
+            "line": 2,
+            "offset": 22
+          },
+          "start": {
+            "col": 0,
+            "line": 2,
+            "offset": 14
+          }
+        }
+      },
+      {
+        "parent": 2,
+        "position": {
+          "end": {
+            "col": 68,
+            "line": 3,
+            "offset": 91
+          },
+          "start": {
+            "col": 1,
+            "line": 3,
+            "offset": 24
+          }
+        },
+        "task": " "
+      },
+      {
+        "parent": -2,
+        "position": {
+          "end": {
+            "col": 76,
+            "line": 5,
+            "offset": 177
+          },
+          "start": {
+            "col": 0,
+            "line": 4,
+            "offset": 92
+          }
+        }
+      }
+    ],
+    "sections": [
+      {
+        "position": {
+          "end": {
+            "col": 12,
+            "line": 0,
+            "offset": 12
+          },
+          "start": {
+            "col": 0,
+            "line": 0,
+            "offset": 0
+          }
+        },
+        "type": "heading"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 76,
+            "line": 5,
+            "offset": 177
+          },
+          "start": {
+            "col": 0,
+            "line": 2,
+            "offset": 14
+          }
+        },
+        "type": "list"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 3,
+            "line": 9,
+            "offset": 225
+          },
+          "start": {
+            "col": 0,
+            "line": 7,
+            "offset": 179
+          }
+        },
+        "type": "code"
+      }
+    ],
+    "tags": [
+      {
+        "position": {
+          "end": {
+            "col": 12,
+            "line": 3,
+            "offset": 35
+          },
+          "start": {
+            "col": 7,
+            "line": 3,
+            "offset": 30
+          }
+        },
+        "tag": "#task"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 13,
+            "line": 5,
+            "offset": 114
+          },
+          "start": {
+            "col": 8,
+            "line": 5,
+            "offset": 109
+          }
+        },
+        "tag": "#task"
+      }
+    ]
+  },
+  "fileContents": "# zero_width\n\n- Root 1\n\t- [ ] #task Task line 1 in 'zero_width' - indented by tab character\n- Root 2\n​\t- [ ] #task Task line 2 in 'zero_width' - indented by ZWSP + tab character\n\n```tasks\npath includes {{query.file.path}}\n```\n",
+  "filePath": "Test Data/zero_width.md",
+  "getAllTags": [
+    "#task",
+    "#task"
+  ],
+  "parseFrontMatterTags": null
+}