lumoe
diff --git a/‎README.md‎
Lines changed: 95 additions & 85 deletions b/‎README.md‎
Lines changed: 95 additions & 85 deletions
diff --git a/‎package.json‎
Lines changed: 2 additions & 2 deletions b/‎package.json‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎src/get-todos.js‎
Lines changed: 69 additions & 5 deletions b/‎src/get-todos.js‎
Lines changed: 69 additions & 5 deletions
@@ -1,85 +1,95 @@
-# 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. 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 **#3** from above toggled on, it will also delete empty todos.
+
+### 5. Roll over children of todos
+
+By default, only the actual todos are rolled over. If you add nested Markdown elements beneath your todos, these are not rolled over but stay in place. Toggling this setting on allows for also migrating the nested elements, including ones that are completed.
+
+### 6. Done status markers
+
+By default, the plugin considers checkboxes containing 'x', 'X', or '-' as completed tasks that won't be rolled over. You can customize this by adding any characters that should be considered "done" markers. For example, adding '?+>' would also treat checkboxes like '[?]', '[+]', and '[>]' as completed tasks. This is useful for users of custom status markers like the [Obsidian Tasks](https://publish.obsidian.md/tasks/Introduction) plugin.
+
+The plugin supports Unicode characters, including complex emoji and grapheme clusters, in checkbox content. This means you can use emojis or special Unicode characters as status markers and they will be handled correctly.
+
+## 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*[-*+] \[[^xX-]\].*/g` (or with your custom done markers)
+- 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
@@ -21,9 +21,9 @@
     "@rollup/plugin-commonjs": "^15.1.0",
     "@rollup/plugin-node-resolve": "^9.0.0",
     "obsidian": "https://github.com/obsidianmd/obsidian-api/tarball/master",
+    "prettier": "^2.8.1",
     "rollup": "^2.32.1",
-    "vitest": "^0.25.7",
-    "prettier": "^2.8.1"
+    "vitest": "^3.1.2"
   },
   "dependencies": {
     "obsidian-daily-notes-interface": "^0.9.2"
 
@@ -2,21 +2,81 @@ class TodoParser {
   // Support all unordered list bullet symbols as per spec (https://daringfireball.net/projects/markdown/syntax#list)
   bulletSymbols = ["-", "*", "+"];
 
+  // Default completed status markers
+  doneStatusMarkers = ["x", "X", "-"];
+
   // List of strings that include the Markdown content
   #lines;
 
   // Boolean that encodes whether nested items should be rolled over
   #withChildren;
 
-  constructor(lines, withChildren) {
+  // Parse content with segmentation to allow for Unicode grapheme clusters
+  #parseIntoChars(content, contentType = "content") {
+    // Use Intl.Segmenter to properly split grapheme clusters if available,
+    // otherwise fall back to Array.from. The fallback should not trigger in
+    // Obsidian since it uses Electron which supports Intl.Segmenter.
+    if (typeof Intl !== "undefined" && Intl.Segmenter) {
+      const segmenter = new Intl.Segmenter("en", { granularity: "grapheme" });
+      return Array.from(segmenter.segment(content), (s) => s.segment);
+    } else {
+      // Array.from() splits surrogate pairs correctly but not complex grapheme clusters
+      // (e.g., 👨‍👩‍👧‍👦 would be split incorrectly) and fail to match.
+      console.error(
+        `Intl.Segmenter not available, falling back to Array.from() for ${contentType}`
+      );
+      return Array.from(content);
+    }
+  }
+
+  constructor(lines, withChildren, doneStatusMarkers) {
     this.#lines = lines;
     this.#withChildren = withChildren;
+    if (doneStatusMarkers) {
+      this.doneStatusMarkers = this.#parseIntoChars(
+        doneStatusMarkers,
+        "done status markers"
+      );
+    }
   }
 
   // Returns true if string s is a todo-item
   #isTodo(s) {
-    const r = new RegExp(`\\s*[${this.bulletSymbols.join("")}] \\[[^xX-]\\].*`, "g"); // /\s*[-*+] \[[^xX-]\].*/g;
-    return r.test(s);
+    // Extract the checkbox content
+    const match = s.match(/\s*[*+-] \[(.+?)\]/);
+    if (!match) return false;
+
+    const checkboxContent = match[1];
+
+    // Parse content with segmentation to allow for Unicode grapheme clusters
+    const contentChars = this.#parseIntoChars(
+      checkboxContent,
+      "checkbox content"
+    );
+
+    // Valid checkbox content must be exactly one grapheme cluster
+    if (contentChars.length !== 1) {
+      return false;
+    }
+
+    const singleChar = contentChars[0];
+
+    // Exclude grapheme modifiers that are not valid as standalone content
+    const graphemeModifiers = ['\u202E', '\u200B', '\u200C', '\u200D'];
+    const hasGraphemeModifier = contentChars.some((char) =>
+      graphemeModifiers.includes(char)
+    );
+    if (hasGraphemeModifier) {
+      return false;
+    }
+
+    // Check if the checkbox content contains any characters that are in doneStatusMarkers
+    const hasDoneMarker = contentChars.some((char) =>
+      this.doneStatusMarkers.includes(char)
+    );
+
+    // Return true (is a todo) if it does NOT contain any done markers
+    return !hasDoneMarker;
   }
 
   // Returns true if line after line-number `l` is a nested item
@@ -75,7 +135,11 @@ 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,
+  withChildren = false,
+  doneStatusMarkers = null,
+}) => {
+  const todoParser = new TodoParser(lines, withChildren, doneStatusMarkers);
   return todoParser.getTodos();
 };