fix: find tasks in blockquotes and Obsidian callouts (#953)

* fix: find tasks in blockquotes and Obsidian callouts

* fix: Update comment about changed regex

* fix: CreateOrEdit should treat blockquotes or callouts the same as fromLine

* test: Add indentation to initial blockquote parsing test

* fix: More regexes needed updating.

* fix: attempt at logical definition of subitems inside blockquote or callout

* Temporarily change the last test in Query.test.ts to put input in nested blockquote

* fix: typo, since I am reading. No functionality change

* Undo change to Query.test.ts

* fix: Properly detect sections of tasks inside callouts or blockquotes in Cache

* fix: Add warning to LivePreview that clicking checkbox inside callout not supported

* docs: Document this feature and LP caveat

* test: Update Smoke Test to test tasks in callouts and blockquotes.

* fix: Better explanation in comments about LP issues.

* Add some tests with * as listmarker instead of -

* fix: Lengthen Notice in LP for callouts from 3s to 30s

* fix: Wording in Smoke Test file

Commit from the web editor to avoid lefthook issues due to space in filename.

Signed-off-by: Anna Kornfeld Simpson <AnnaKornfeldSimpson@users.noreply.github.com>

* fix: remove change to cache that is unrelated to callouts

* fix: Clearer warning notice in LP about callouts

Author: AnnaKornfeldSimpson

docs/getting-started/index.md

@@ -78,6 +78,22 @@ The following _does not work:_
 
 ---
 
+Warning
+{: .label .label-yellow}
+Tasks can read tasks that are inside blockquotes or [Obsidian's built-in callouts](https://help.obsidian.md/How+to/Use+callouts).
+However, in the Live Preview editor mode (pencil icon in lower right corner), tasks written inside callouts cannot be completed by clicking the checkbox.
+You will see a warning; use the command `Tasks: Toggle Done`, or switch to Reading View (book icon in lower right corner) to click the checkbox.
+Completing a task by clicking its checkbox from a `tasks` query block _will_ work in any editor mode, even if the query is inside a callout.
+
+---
+
+Warning
+{: .label .label-yellow}
+
+Tasks cannot read tasks that are inside code blocks, such as the ones used by the Admonitions plugin. Use Obsidian's built-in callouts instead.
+
+---
+
 Warning
 {: .label .label-yellow}
 Tasks can only render inline footnotes. Regular footnotes are not supported.

resources/sample_vaults/Tasks-Demo/Manual Testing/Smoke Testing the Tasks Plugin.md

@@ -63,12 +63,17 @@ Work through all the tasks below, until zero tasks remain in this query:
 
 ### Recurring Tasks
 
-Confirm that when a recurring task is completed, a new task is created and all the date fields are incremented.
+Confirm that when a recurring task is completed, a new task is created, all the date fields are incremented, and the indentation is unchanged.
+
+> [!Todo]
+>
+> - [ ] #task Complete this recurring task in **Source view** using **Tasks: Toggle task done** command 🔁 every day 🛫 2022-02-17 ⏳ 2022-02-18 📅 2022-02-19
+>
+> > - [ ] #task Complete this recurring task in **Reading view**🔁 every day 🛫 2022-02-17 ⏳ 2022-02-18 📅 2022-02-19
 
-- [ ] #task Complete this recurring task in **Source view** using **Tasks: Toggle task done** command 🔁 every day 🛫 2022-02-17 ⏳ 2022-02-18 📅 2022-02-19
-- [ ] #task Complete this recurring task in **Reading view**🔁 every day 🛫 2022-02-17 ⏳ 2022-02-18 📅 2022-02-19
 - [ ] #task Complete this recurring task in **Live Preview**🔁 every day 🛫 2022-02-17 ⏳ 2022-02-18 📅 2022-02-19
-- [ ] #task **check**: Checked all above steps for **recurring tasks** worked
+
+> - [ ] #task **check**: Checked all above steps for **recurring tasks** worked
 
 ### Rendering of Task Blocks
 

src/Cache.ts

@@ -1,6 +1,6 @@
 import { MetadataCache, TAbstractFile, TFile, Vault } from 'obsidian';
-import type { CachedMetadata, ListItemCache } from 'obsidian';
-import type { EventRef, SectionCache } from 'obsidian';
+import type { CachedMetadata, EventRef } from 'obsidian';
+import type { ListItemCache, SectionCache } from 'obsidian';
 import { Mutex } from 'async-mutex';
 
 import { Task } from './Task';
@@ -320,7 +320,6 @@ export class Cache {
 
         for (const section of sections) {
             if (
-                section.type === 'list' &&
                 section.position.start.line <= lineNumberTask &&
                 section.position.end.line >= lineNumberTask
             ) {

src/Commands/CreateOrEdit.ts

@@ -58,7 +58,7 @@ const taskFromLine = ({ line, path }: { line: string; path: string }): Task => {
 
     // If we are not on a line of a task, we take what we have.
     // The non-task line can still be a checklist, for example if it is lacking the global filter.
-    const nonTaskRegex: RegExp = /^([\s\t]*)[-*]? *(\[(.)\])? *(.*)/u;
+    const nonTaskRegex: RegExp = /^([\s\t>]*)[-*]? *(\[(.)\])? *(.*)/u;
     const nonTaskMatch = line.match(nonTaskRegex);
     if (nonTaskMatch === null) {
         // Should never happen; everything in the regex is optional.

src/Commands/ToggleDone.ts

@@ -72,13 +72,13 @@ const toggleLine = ({ line, path }: { line: string; path: string }): string => {
             // 1. a list item
             // 2. a simple text line
 
-            const listItemRegex = /^([\s\t]*)([-*])/;
+            const listItemRegex = /^([\s\t>]*)([-*])/;
             if (listItemRegex.test(line)) {
                 // Let's convert the list item to a checklist item.
                 toggledLine = line.replace(listItemRegex, '$1$2 [ ]');
             } else {
                 // Let's convert the line to a list item.
-                toggledLine = line.replace(/^([\s\t]*)/, '$1- ');
+                toggledLine = line.replace(/^([\s\t>]*)/, '$1- ');
             }
         }
     }

src/Events.ts

@@ -16,8 +16,8 @@ interface CacheUpdateData {
 export class Events {
     private obsidianEvents: ObsidianEvents;
 
-    constructor({ obsidianEents }: { obsidianEents: ObsidianEvents }) {
-        this.obsidianEvents = obsidianEents;
+    constructor({ obsidianEvents }: { obsidianEvents: ObsidianEvents }) {
+        this.obsidianEvents = obsidianEvents;
     }
 
     public onCacheUpdate(

src/LivePreviewExtension.ts

@@ -1,5 +1,6 @@
 import { EditorView, ViewPlugin } from '@codemirror/view';
 import type { PluginValue } from '@codemirror/view';
+import { Notice } from 'obsidian';
 
 import { Task } from './Task';
 
@@ -33,8 +34,31 @@ class LivePreviewExtension implements PluginValue {
             return false;
         }
 
+        /* Right now Obsidian API does not give us a way to handle checkbox clicks inside rendered-widgets-in-LP such as
+         * callouts, tables, and transclusions because `this.view.posAtDOM` will return the beginning of the widget
+         * as the position for any click inside the widget.
+         * For callouts, this means that the task will never be found, since the `lineAt` will be the beginning of the callout.
+         * Therefore, produce an error message pop-up using Obsidian's "Notice" feature, log a console warning, then return.
+         */
+
+        // Tasks from "task" query codeblocks handle themselves thanks to `toLi`, so be specific about error messaging, but still return.
+        const ancestor = target.closest(
+            'ul.plugin-tasks-query-result, div.callout-content',
+        );
+        if (ancestor) {
+            if (ancestor.matches('div.callout-content')) {
+                // Error message for now.
+                const msg =
+                    'obsidian-tasks-plugin warning: Tasks cannot add or remove completion dates or make the next copy of a recurring task for tasks written inside a callout when you click their checkboxes in Live Preview. \n' +
+                    'If you wanted Tasks to do these things, please undo your change, then either click the line of the task and use the "Toggle Task Done" command, or switch to Reading View to click the checkbox.';
+                console.warn(msg);
+                new Notice(msg, 45000);
+            }
+            return false;
+        }
+
         const { state } = this.view;
-        const position = this.view.posAtDOM(target as Node);
+        const position = this.view.posAtDOM(target);
         const line = state.doc.lineAt(position);
         const task = Task.fromLine({
             line: line.text,
@@ -47,6 +71,10 @@ class LivePreviewExtension implements PluginValue {
             precedingHeader: null,
         });
 
+        console.debug(
+            `Live Preview Extension: toggle called. Position: ${position} Line: ${line.text}`,
+        );
+
         // Only handle checkboxes of tasks.
         if (task === null) {
             return false;
@@ -58,7 +86,7 @@ class LivePreviewExtension implements PluginValue {
         // Clicked on a task's checkbox. Toggle the task and set it.
         const toggled = task.toggle();
         const toggledString = toggled
-            .map((task) => task.toFileLineString())
+            .map((t) => t.toFileLineString())
             .join(state.lineBreak);
 
         // Creates a CodeMirror transaction in order to update the document.

src/Query/Filter/ExcludeSubItemsField.ts

@@ -7,10 +7,15 @@ export class ExcludeSubItemsField extends FilterInstructionsBasedField {
     constructor() {
         super();
 
-        this._filters.add(
-            'exclude sub-items',
-            (task) => task.indentation === '',
-        );
+        this._filters.add('exclude sub-items', (task) => {
+            if (task.indentation === '') return true; // no indentation, not a subitem
+
+            const lastBlockquoteMark = task.indentation.lastIndexOf('>');
+            if (lastBlockquoteMark === -1) return false; // indentation present, not in a blockquote, subitem
+
+            // Up to one space allowed after last > in blockquote/callout, otherwise subitem
+            return /^ ?$/.test(task.indentation.slice(lastBlockquoteMark + 1));
+        });
     }
 
     protected fieldName(): string {

src/Task.ts

@@ -85,10 +85,10 @@ export class Task {
     public static readonly dateFormat = 'YYYY-MM-DD';
 
     // Main regex for parsing a line. It matches the following:
-    // - Indentation
+    // - Indentation (including > for potentially nested blockquotes or Obsidian callouts)
     // - Status character
     // - Rest of task after checkbox markdown
-    public static readonly taskRegex = /^([\s\t]*)[-*] +\[(.)\] *(.*)/u;
+    public static readonly taskRegex = /^([\s\t>]*)[-*] +\[(.)\] *(.*)/u;
 
     // Match on block link at end.
     public static readonly blockLinkRegex = / \^[a-zA-Z0-9-]+$/u;

src/main.ts

@@ -27,7 +27,7 @@ export default class TasksPlugin extends Plugin {
             vault: this.app.vault,
         });
 
-        const events = new Events({ obsidianEents: this.app.workspace });
+        const events = new Events({ obsidianEvents: this.app.workspace });
         this.cache = new Cache({
             metadataCache: this.app.metadataCache,
             vault: this.app.vault,