Feature: ToDo is Child of Heading

README.md

@@ -1,85 +1,93 @@
-# Rollover Daily Todos
-
-[![Build](https://github.com/lumoe/obsidian-rollover-daily-todos/actions/workflows/ci.yml/badge.svg)](https://github.com/lumoe/obsidian-rollover-daily-todos/actions/workflows/ci.yml)
-
-This Obsidian plugin will rollover any incomplete todo items from the previous daily note (could be yesterday, or a week ago) to today. This is triggered automatically when a new daily note is created via the internal `Daily notes` plugin, or the `Periodic Notes` plugin., It can also be run as a command from the Command Palette.
-
-![A demo of the plugin working](./demo.gif)
-
-## Usage
-
-### 1. New Daily Note
-
-Just create a new daily note using the `Daily notes` or `Periodic Notes` plugin. The previous day's incomplete todos will be rolled over to today's daily note.
-
-**Note:** Automatic rollover can cause conflicts with other plugins, particularly the Templater plugin. If you're using Templater for your daily notes, it's recommended that you disable automatic rollover in the plugin's settings and instead trigger it manually after creation.
-
-### 2. Command: Manual Rollover Todos Now
-
-You can also open your command palette (CMD+P on macOS) and start typing `roll` to find this command. No matter where you are in Obsidian, the previous day's todos will get rolled forward. There is also a command called `Undo last rollover` which can be run within 2 minutes of a rollover occurring. Both commands are potentially destructive, and the default text element undo command (CMD+Z on macOS) didn't work. Currently only 1 undo is available for use at the moment.
-
-Note that if you create a daily note in the future, and you try to run this command, todos will not be rolled into a future date. They will always be rolled to today's note (if it doesn't exist, nothing will happen), from the chronologically closest (in the past) daily note.
-
-## Requirements
-
-- [ ] You must have either:
-  1. `Daily notes` plugin installed _or_
-  2. `Periodic Notes` plugin installed AND the **Daily Notes** setting toggled on
-- [ ] A Note folder set in one of these plugins. Inside it you must have:
-  1. 2 or more notes
-  2. All notes must be named in the format you use for daily notes (for example `2021-08-29` for `YYYY-MM-DD` )
-
-## Settings
-
-### 1. Disable automatic rollover
-
-If you prefer to trigger the rollover of your todos manually, you can use this setting to prevent the plugin from rolling them over when a new note is created.
-
-### 2. Template Heading
-
-If you chose a template file to use for new daily notes in `Daily notes > Settings` or `Periodic Notes > Settings`, you will be able to choose a heading for incomplete notes to roll into. Note that incomplete todos are taken from the entire file, regardless of what heading they are under. And they are all rolled into today's daily note, right under the heading of choice.
-
-If you leave this field as blank, or select `None`, then incomplete todos will be rolled onto the end of today's note (for new notes with no template, the end is the beginning of the note).
-
-### 3. Delete todos from previous day
-
-By default, this plugin will actually make a copy of incomplete todos. So if you forgot to wash your dog yesterday, and didn't check it off, then you will have an incomplete checkmark on yesterday's daily note, and a new incomplete checkmark will be rolled into today's daily note. If you use the `Undo last rollover` command, deleted todos will be restored (remember, the `time limit on this is 2 minutes`).
-
-Toggling this setting on will remove incomplete todos from the previous daily note once today's daily note has a copy of them.
-
-### 4. Remove empty todos in rollover
-
-By default, this plugin will roll over anything that has a checkbox, whether it has content or not. Toggling this setting on will ignore empty todos. If you have **#2** from above toggled on, it will also delete empty todos.
-
-## Bugs/Issues
-
-1. Sometimes you will use this plugin, and your unfinished todos will stay in the same spot. These could be formatting issues.
-
-- Regex is used to search for unfinished todos: `/\s*[-*+] \[ \].*/g`
-- At a minimum, they need to look like: `start of line | tabs`-` `[` `]`Your text goes here`
-- If you use spaces instead of tabs at the start of the line, the behavior of the plugin can be inconsistent. Sometimes it'll roll items over, but not delete them from the previous day when you have that option toggled on.
-
-2. Sometimes, if you trigger the `rollover` function too quickly, it will read the state of a file before the new data was saved to disk. For example, if you add a new incomplete todo to yesterday's daily note, and then quickly run the `Rollover Todos Now` command, it may grab the state of the file a second or two before you ran the command. If this happens, just run the `Undo last rollover` command. Wait a second or two, then try rolling over todos again.
-
-For example (no template heading, empty todos toggled on):
-
-```markdown
-You type in:
-
-- [x] Do the dishes
-- [ ] Take out the trash
-
-And then you run the Rollover Todos Now command. Today's daily note might look like:
-
-- [ ] Take out the trash
-
-And the previous day might look like
-
-- [x] Do the dishes
-```
-
-3. There are sometimes conflicts with other plugins that deal with new notes -- particularly the Templater plugin. In these situations, your todos may be removed from your previous note, and then not be saved into your new daily note. The simplest remedy is to disable the automatic rollover, and instead trigger it manually.
-
-## Installation
-
-This plugin can be installed within the `Third-party Plugins` tab within Obsidian.
+# Rollover Daily Todos
+
+[![Build](https://github.com/lumoe/obsidian-rollover-daily-todos/actions/workflows/ci.yml/badge.svg)](https://github.com/lumoe/obsidian-rollover-daily-todos/actions/workflows/ci.yml)
+
+This Obsidian plugin will rollover any incomplete todo items from the previous daily note (could be yesterday, or a week ago) to today. This is triggered automatically when a new daily note is created via the internal `Daily notes` plugin, or the `Periodic Notes` plugin., It can also be run as a command from the Command Palette.
+
+![A demo of the plugin working](./demo.gif)
+
+## Usage
+
+### 1. New Daily Note
+
+Just create a new daily note using the `Daily notes` or `Periodic Notes` plugin. The previous day's incomplete todos will be rolled over to today's daily note.
+
+**Note:** Automatic rollover can cause conflicts with other plugins, particularly the Templater plugin. If you're using Templater for your daily notes, it's recommended that you disable automatic rollover in the plugin's settings and instead trigger it manually after creation.
+
+### 2. Command: Manual Rollover Todos Now
+
+You can also open your command palette (CMD+P on macOS) and start typing `roll` to find this command. No matter where you are in Obsidian, the previous day's todos will get rolled forward. There is also a command called `Undo last rollover` which can be run within 2 minutes of a rollover occurring. Both commands are potentially destructive, and the default text element undo command (CMD+Z on macOS) didn't work. Currently only 1 undo is available for use at the moment.
+
+Note that if you create a daily note in the future, and you try to run this command, todos will not be rolled into a future date. They will always be rolled to today's note (if it doesn't exist, nothing will happen), from the chronologically closest (in the past) daily note.
+
+## Requirements
+
+- [ ] You must have either:
+  1. `Daily notes` plugin installed _or_
+  2. `Periodic Notes` plugin installed AND the **Daily Notes** setting toggled on
+- [ ] A Note folder set in one of these plugins. Inside it you must have:
+  1. 2 or more notes
+  2. All notes must be named in the format you use for daily notes (for example `2021-08-29` for `YYYY-MM-DD` )
+
+## Settings
+
+### 1. Disable automatic rollover
+
+If you prefer to trigger the rollover of your todos manually, you can use this setting to prevent the plugin from rolling them over when a new note is created.
+
+### 2. Template Heading
+
+If you chose a template file to use for new daily notes in `Daily notes > Settings` or `Periodic Notes > Settings`, you will be able to choose a heading for incomplete notes to roll into. Note that incomplete todos are taken from the entire file, regardless of what heading they are under. And they are all rolled into today's daily note, right under the heading of choice.
+
+If you leave this field as blank, or select `None`, then incomplete todos will be rolled onto the end of today's note (for new notes with no template, the end is the beginning of the note).
+
+### 3. Daily Note Heading
+
+This feature allows for detecting todo items that fall under specific headings using a Markdown structure with headings marked by 1 to 5 # symbols. When processing Markdown content, the parser will locate the closest heading above a todo item and check if it matches the desired heading.
+
+Note that todos are only considered if they are placed directly under the targeted heading, regardless of their indentation level or nesting. If no matching heading is found above the todo item, it will not be included in the results.
+
+This feature ensures that todos are correctly associated with the relevant section, allowing for more organized and precise task management in your daily notes.
+
+### 4. Delete todos from previous day
+
+By default, this plugin will actually make a copy of incomplete todos. So if you forgot to wash your dog yesterday, and didn't check it off, then you will have an incomplete checkmark on yesterday's daily note, and a new incomplete checkmark will be rolled into today's daily note. If you use the `Undo last rollover` command, deleted todos will be restored (remember, the `time limit on this is 2 minutes`).
+
+Toggling this setting on will remove incomplete todos from the previous daily note once today's daily note has a copy of them.
+
+### 5. Remove empty todos in rollover
+
+By default, this plugin will roll over anything that has a checkbox, whether it has content or not. Toggling this setting on will ignore empty todos. If you have **#2** from above toggled on, it will also delete empty todos.
+
+## Bugs/Issues
+
+1. Sometimes you will use this plugin, and your unfinished todos will stay in the same spot. These could be formatting issues.
+
+- Regex is used to search for unfinished todos: `/\s*[-*+] \[ \].*/g`
+- At a minimum, they need to look like: `start of line | tabs`-` `[` `]`Your text goes here`
+- If you use spaces instead of tabs at the start of the line, the behavior of the plugin can be inconsistent. Sometimes it'll roll items over, but not delete them from the previous day when you have that option toggled on.
+
+2. Sometimes, if you trigger the `rollover` function too quickly, it will read the state of a file before the new data was saved to disk. For example, if you add a new incomplete todo to yesterday's daily note, and then quickly run the `Rollover Todos Now` command, it may grab the state of the file a second or two before you ran the command. If this happens, just run the `Undo last rollover` command. Wait a second or two, then try rolling over todos again.
+
+For example (no template heading, empty todos toggled on):
+
+```markdown
+You type in:
+
+- [x] Do the dishes
+- [ ] Take out the trash
+
+And then you run the Rollover Todos Now command. Today's daily note might look like:
+
+- [ ] Take out the trash
+
+And the previous day might look like
+
+- [x] Do the dishes
+```
+
+3. There are sometimes conflicts with other plugins that deal with new notes -- particularly the Templater plugin. In these situations, your todos may be removed from your previous note, and then not be saved into your new daily note. The simplest remedy is to disable the automatic rollover, and instead trigger it manually.
+
+## Installation
+
+This plugin can be installed within the `Third-party Plugins` tab within Obsidian.

manifest.json

@@ -1,10 +1,10 @@
-{
-  "id": "obsidian-rollover-daily-todos",
-  "name": "Rollover Daily Todos",
-  "version": "1.1.8",
-  "minAppVersion": "0.12.12",
-  "description": "This Obsidian.md plugin rolls over incomplete TODOs from the previous daily note to today's daily note. (https://obsidian.md). (Originally created by Matthew Sessions)",
-  "author": "Lukas Mölschl",
-  "authorUrl": "https://moelschl.com",
-  "isDesktopOnly": false
-}
+{
+  "id": "obsidian-rollover-daily-todos",
+  "name": "Rollover Daily Todos",
+  "version": "1.1.9",
+  "minAppVersion": "0.12.12",
+  "description": "This Obsidian.md plugin rolls over incomplete TODOs from the previous daily note to today's daily note. (https://obsidian.md). (Originally created by Matthew Sessions)",
+  "author": "Lukas Mölschl",
+  "authorUrl": "https://moelschl.com",
+  "isDesktopOnly": false
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-rollover-daily-todos",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "This Obsidian.md plugin rolls over incomplete TODOs from the previous daily note to today's daily note. (https://obsidian.md)",
   "main": "main.js",
   "scripts": {

src/get-todos.js

@@ -8,17 +8,55 @@ class TodoParser {
   // Boolean that encodes whether nested items should be rolled over
   #withChildren;
 
-  constructor(lines, withChildren) {
+  // string that defines the searched heading or none
+  #dailyNoteHeading;
+
+  constructor(lines, withChildren, dailyNoteHeading) {
     this.#lines = lines;
     this.#withChildren = withChildren;
+    this.#dailyNoteHeading = dailyNoteHeading;
   }
 
   // Returns true if string s is a todo-item
   #isTodo(s) {
-    const r = new RegExp(`\\s*[${this.bulletSymbols.join("")}] \\[[^xX-]\\].*`, "g"); // /\s*[-*+] \[[^xX-]\].*/g;
+    const r = new RegExp(
+      `\\s*[${this.bulletSymbols.join("")}] \\[[^xX-]\\].*`,
+      "g"
+    ); // /\s*[-*+] \[[^xX-]\].*/g;
     return r.test(s);
   }
 
+  // Returns true if the line is a todo item under the correct heading
+  #isChildOfHeading(line) {
+    // if not set its valid under every heading
+    if (this.#dailyNoteHeading === "none") {
+      return true;
+    }
+
+    let currentHeading = null;
+
+    // Regex to detect headings (e.g., ## or ###)
+    const headingRegex = /^#{1,}\s*(.+)/;
+
+    // Find the index of the current line
+    const lineIndex = this.#lines.indexOf(line);
+
+    // Iterate backwards from the current line to find the closest heading
+    for (let i = lineIndex; i >= 0; i--) {
+      const prevLine = this.#lines[i];
+      const headingMatch = prevLine.match(headingRegex);
+
+      if (headingMatch) {
+        // If a heading is found, set it as the current heading and stop
+        currentHeading = headingMatch[1].trim();
+        break;
+      }
+    }
+
+    // Check if the current heading matches the target heading
+    return currentHeading === this.#dailyNoteHeading;
+  }
+
   // Returns true if line after line-number `l` is a nested item
   #hasChildren(l) {
     if (l + 1 >= this.#lines.length) {
@@ -61,7 +99,7 @@ class TodoParser {
     let todos = [];
     for (let l = 0; l < this.#lines.length; l++) {
       const line = this.#lines[l];
-      if (this.#isTodo(line)) {
+      if (this.#isTodo(line) && this.#isChildOfHeading(line)) {
         todos.push(line);
         if (this.#withChildren && this.#hasChildren(l)) {
           const cs = this.#getChildren(l);
@@ -75,7 +113,7 @@ class TodoParser {
 }
 
 // Utility-function that acts as a thin wrapper around `TodoParser`
-export const getTodos = ({ lines, withChildren = false }) => {
-  const todoParser = new TodoParser(lines, withChildren);
+export const getTodos = ({ lines, dailyNoteHeading, withChildren = false }) => {
+  const todoParser = new TodoParser(lines, withChildren, dailyNoteHeading);
   return todoParser.getTodos();
 };

src/index.js

@@ -42,6 +42,7 @@ export default class RolloverTodosPlugin extends Plugin {
   async loadSettings() {
     const DEFAULT_SETTINGS = {
       templateHeading: "none",
+      dailyNoteHeading: "none",
       deleteOnComplete: false,
       removeEmptyTodos: false,
       rolloverChildren: false,
@@ -126,6 +127,7 @@ export default class RolloverTodosPlugin extends Plugin {
     return getTodos({
       lines: dnLines,
       withChildren: this.settings.rolloverChildren,
+      dailyNoteHeading: this.settings.dailyNoteHeading,
     });
   }
 

src/ui/RolloverSettingTab.js

@@ -52,6 +52,27 @@ export default class RolloverSettingTab extends PluginSettingTab {
           })
       );
 
+    new Setting(this.containerEl)
+      .setName("Daily Note heading")
+      .setDesc(
+        "Which heading from your daily note should the todos get grabbed from"
+      )
+      .addDropdown((dropdown) =>
+        dropdown
+          .addOptions({
+            ...templateHeadings.reduce((acc, heading) => {
+              acc[heading] = heading;
+              return acc;
+            }, {}),
+            none: "None",
+          })
+          .setValue(this.plugin?.settings.dailyNoteHeading)
+          .onChange((value) => {
+            this.plugin.settings.dailyNoteHeading = value;
+            this.plugin.saveSettings();
+          })
+      );
+
     new Setting(this.containerEl)
       .setName("Delete todos from previous day")
       .setDesc(

versions.json

@@ -1,17 +1,18 @@
-{
-  "1.0.0": "0.9.20",
-  "1.0.1": "0.9.20",
-  "1.0.2": "0.9.20",
-  "1.0.3": "0.12.12",
-  "1.0.4": "0.12.12",
-  "1.0.5": "0.12.12",
-  "1.1.0": "0.12.12",
-  "1.1.1": "0.12.12",
-  "1.1.2": "0.12.12",
-  "1.1.3": "0.12.12",
-  "1.1.4": "0.12.12",
-  "1.1.5": "0.12.12",
-  "1.1.6": "0.12.12",
-  "1.1.7": "0.12.12",
-  "1.1.8": "0.12.12"
-}
+{
+  "1.0.0": "0.9.20",
+  "1.0.1": "0.9.20",
+  "1.0.2": "0.9.20",
+  "1.0.3": "0.12.12",
+  "1.0.4": "0.12.12",
+  "1.0.5": "0.12.12",
+  "1.1.0": "0.12.12",
+  "1.1.1": "0.12.12",
+  "1.1.2": "0.12.12",
+  "1.1.3": "0.12.12",
+  "1.1.4": "0.12.12",
+  "1.1.5": "0.12.12",
+  "1.1.6": "0.12.12",
+  "1.1.7": "0.12.12",
+  "1.1.8": "0.12.12",
+  "1.1.9": "0.12.12"
+}