✨ allow task toggle in mark cycle; resolves #456

Author: ebullient

src/@types/settings.d.ts

@@ -3,6 +3,7 @@ export type TaskCollectorSettings = {
     collectionEnabled: boolean;
     previewClickModal: boolean;
     markCycle: string;
+    markCycleRemoveTask: boolean;
     skipSectionMatch: string;
     contextMenu: {
         markTask: boolean;

src/taskcollector-Constants.ts

@@ -31,6 +31,7 @@ export const DEFAULT_SETTINGS: TaskCollectorSettings = {
         },
     },
     markCycle: "",
+    markCycleRemoveTask: false,
     collectionEnabled: false,
     previewClickModal: true,
     contextMenu: {

src/taskcollector-Data.ts

@@ -41,6 +41,10 @@ function sanitize(tcp: TaskCollectorPlugin, settings: TaskCollectorSettings) {
     // Make sure characters in cycle are unique
     if (settings.markCycle) {
         settings.markCycle = [...new Set(settings.markCycle)].join("");
+        settings.markCycle.replace("§", "");
+        if (settings.markCycleRemoveTask) {
+            settings.markCycle += "§";
+        }
     }
 
     // resolve groups with a key / mts.name mismatch

src/taskcollector-SettingsTab.ts

@@ -121,18 +121,42 @@ export class TaskCollectorSettingsTab extends PluginSettingTab {
         new Setting(this.containerEl)
             .setName("Define task mark cycle")
             .setDesc(
-                "Specify characters (as a string) for Previous/Next commands",
+                "Specify characters (as a string) for Previous/Next commands. Use the button to include checkbox removal in the cycle.",
             )
             .addText((input) =>
                 input
                     .setPlaceholder("")
-                    .setValue(this.newSettings.markCycle)
+                    .setValue(this.newSettings.markCycle.replace("§", ""))
                     .onChange(async (value) => {
                         this.newSettings.markCycle = [...new Set(value)].join(
                             "",
                         );
                     }),
-            );
+            )
+            .addExtraButton((button) => {
+                const el = button
+                    .setTooltip(
+                        "Include checkbox removal in the cycle: " +
+                            this.newSettings.markCycleRemoveTask,
+                    )
+                    .setIcon("cross-in-box")
+                    .onClick(() => {
+                        this.newSettings.markCycleRemoveTask =
+                            !this.newSettings.markCycleRemoveTask;
+                        el.classList.toggle(
+                            "is-active",
+                            this.newSettings.markCycleRemoveTask,
+                        );
+                        button.setTooltip(
+                            "Include checkbox removal in the cycle: " +
+                                this.newSettings.markCycleRemoveTask,
+                        );
+                    }).extraSettingsEl;
+                el.classList.toggle(
+                    "is-active",
+                    this.newSettings.markCycleRemoveTask,
+                );
+            });
 
         new Setting(this.containerEl)
             .setName("Convert non-list lines")

src/taskcollector-TaskCollector.ts

@@ -166,23 +166,27 @@ export class TaskCollector {
                 const i = this.settings.markCycle.indexOf(old);
                 const next =
                     i < 0
-                        ? d == Direction.NEXT
-                            ? 0
-                            : len - 1
-                        : d == Direction.NEXT
-                          ? (i + 1) % len
-                          : (i + len - 1) % len;
-
-                split[n] = this.doMarkTask(
-                    split[n],
-                    old,
-                    this.settings.markCycle[next],
-                );
+                        ? d == Direction.NEXT // i < 0
+                            ? 0 // NEXT
+                            : len - 1 // PREV
+                        : d == Direction.NEXT // i >= 0
+                          ? (i + 1) % len // NEXT
+                          : (i + len - 1) % len; // PREV
+
+                const chosenMark = this.settings.markCycle[next];
+                if (chosenMark === "§") {
+                    split[n] = this.doRemoveTask(split[n]);
+                } else {
+                    split[n] = this.doMarkTask(split[n], old, chosenMark);
+                }
             } else if (listMatch && listMatch[2]) {
+                const cycle = this.settings.markCycle.replace("§", "");
+                const chosenMark =
+                    cycle[d == Direction.NEXT ? 0 : cycle.length - 1];
                 // convert to a task, and then mark
                 split[n] = this.updateLineText(
                     `${listMatch[1]}[ ] ${listMatch[2]}`,
-                    this.settings.markCycle[d == Direction.NEXT ? 0 : len - 1],
+                    chosenMark,
                 );
             }
         }

test/dataMigration.test.ts

@@ -58,6 +58,7 @@ export const DEFAULT_MIGRATION = {
         }
     },
     markCycle: "",
+    markCycleRemoveTask: false,
     collectionEnabled: true,
     previewClickModal: false,
     contextMenu: {
@@ -130,6 +131,7 @@ test('Task Marker: User configuration', async () => {
         JSON.parse(JSON.stringify(DEFAULT_MIGRATION)),
         {
             markCycle: " x/>-",
+            markCycleRemoveTask: false,
             previewClickModal: false,
             collectionEnabled: false,
             contextMenu: {

test/markTasks.test.ts

@@ -149,6 +149,26 @@ describe('Task mark cycle', () => {
         expect(tc.markInCycle('- something', Direction.NEXT, [0])).toEqual("- [a] something");
         expect(tc.markInCycle('- something', Direction.PREV, [0])).toEqual("- [c] something");
     });
+
+    test('Mark tasks forward in a cycle (next) include remove task', () => {
+        config.markCycle = " ab§";
+        config.markCycleRemoveTask = true;
+        tc.init(config);
+        expect(tc.markInCycle('- something', Direction.NEXT, [0])).toEqual("- [ ] something");
+        expect(tc.markInCycle('- [ ] something', Direction.NEXT, [0])).toEqual("- [a] something");
+        expect(tc.markInCycle('- [a] something', Direction.NEXT, [0])).toEqual("- [b] something");
+        expect(tc.markInCycle('- [b] something', Direction.NEXT, [0])).toEqual("- something");
+    });
+
+    test('Mark tasks backward in a cycle (prev) include remove task', () => {
+        config.markCycle = " ab§";
+        config.markCycleRemoveTask = true;
+        tc.init(config);
+        expect(tc.markInCycle('- [b] something', Direction.PREV, [0])).toEqual("- [a] something");
+        expect(tc.markInCycle('- [a] something', Direction.PREV, [0])).toEqual("- [ ] something");
+        expect(tc.markInCycle('- [ ] something', Direction.PREV, [0])).toEqual("- something");
+        expect(tc.markInCycle('- something', Direction.PREV, [0])).toEqual("- [b] something");
+    });
 });