refactor: add toggleWithRecurrenceInUsersOrder()

Author: ilandikov

src/Commands/ToggleDone.ts

@@ -72,7 +72,7 @@ export const toggleLine = (line: string, path: string): EditorInsertion => {
         fallbackDate: null, // We don't need this to toggle it here in the editor.
     });
     if (task !== null) {
-        const lines = task.toggle().map((t) => t.toFileLineString());
+        const lines = task.toggleWithRecurrenceInUsersOrder().map((t) => t.toFileLineString());
         return { text: lines.join('\n'), moveTo: { line: lines.length - 1 } };
     } else {
         // If the task is null this means that we have one of:

src/LivePreviewExtension.ts

@@ -75,7 +75,7 @@ class LivePreviewExtension implements PluginValue {
         event.preventDefault();
 
         // Clicked on a task's checkbox. Toggle the task and set it.
-        const toggled = task.toggle();
+        const toggled = task.toggleWithRecurrenceInUsersOrder();
         const toggledString = toggled.map((t) => t.toFileLineString()).join(state.lineBreak);
 
         // Creates a CodeMirror transaction in order to update the document.

src/Task.ts

@@ -291,12 +291,16 @@ export class Task {
     }
 
     /**
-     * Toggles this task and returns the resulting tasks.
+     * Toggles this task and returns the resulting task(s). If the
+     * task is not recurring, it will return `[toggled]`.
      *
      * Toggling can result in more than one returned task in the case of
-     * recurrence. If it is a recurring task, the toggled task will be returned
-     * together with the next occurrence in the order `[next, toggled]`. If the
-     * task is not recurring, it will return `[toggled]`.
+     * recurrence. In this case, the toggled task will be returned
+     * together with the next occurrence in the order `[next, toggled]`.
+     *
+     * There is a possibility to use user set order `[next, toggled]`
+     * or `[toggled, next]` - {@link toggleWithRecurrenceInUsersOrder}.
+     *
      */
     public toggle(): Task[] {
         const newStatus = StatusRegistry.getInstance().getNextStatusOrCreate(this.status);
@@ -353,6 +357,24 @@ export class Task {
         // Write next occurrence before previous occurrence.
         newTasks.push(toggledTask);
 
+        return newTasks;
+    }
+
+    /**
+     * Toggles this task and returns the resulting task(s). If the
+     * task is not recurring, it will return `[toggled]`.
+     *
+     * Toggling can result in more than one returned task in the case of
+     * recurrence. In this case, the toggled task will be returned in
+     * user set order `[next, toggled]` or `[toggled, next]` depending
+     * on {@link Settings}.
+     *
+     * If there is no need to consider user settings call {@link toggle}.
+     *
+     */
+    public toggleWithRecurrenceInUsersOrder(): Task[] {
+        const newTasks = this.toggle();
+
         const { recurrenceOnNextLine: recurrenceOnNextLine } = getSettings();
         return recurrenceOnNextLine ? newTasks.reverse() : newTasks;
     }

src/TaskLineRenderer.ts

@@ -89,7 +89,7 @@ export async function renderTaskLine(
 
         // Should be re-rendered as enabled after update in file.
         checkbox.disabled = true;
-        const toggledTasks = task.toggle();
+        const toggledTasks = task.toggleWithRecurrenceInUsersOrder();
         replaceTaskWithTasks({
             originalTask: task,
             newTasks: toggledTasks,

tests/Task.test.ts

@@ -1139,7 +1139,7 @@ describe('next task recurrence appearance', () => {
         const task = fromLine({ line: '- [ ] this is a recurring task 🔁 every day' });
 
         // Act
-        const lines = task.toggle().map((t) => t.toFileLineString());
+        const lines = task.toggleWithRecurrenceInUsersOrder().map((t) => t.toFileLineString());
 
         // Assert
         expect(lines.length).toEqual(2);
@@ -1153,7 +1153,7 @@ describe('next task recurrence appearance', () => {
         updateSettings({ recurrenceOnNextLine: false });
 
         // Act
-        const lines = task.toggle().map((t) => t.toFileLineString());
+        const lines = task.toggleWithRecurrenceInUsersOrder().map((t) => t.toFileLineString());
 
         // Assert
         expect(lines.length).toEqual(2);
@@ -1167,7 +1167,7 @@ describe('next task recurrence appearance', () => {
         updateSettings({ recurrenceOnNextLine: true });
 
         // Act
-        const lines = task.toggle().map((t) => t.toFileLineString());
+        const lines = task.toggleWithRecurrenceInUsersOrder().map((t) => t.toFileLineString());
 
         // Assert
         expect(lines.length).toEqual(2);