Merge pull request #3423 from chmac/2751-drop-scheduled-dates

feat: Add option to discard Scheduled date on new recurring tasks

Author: claremacrae

docs/Getting Started/Recurring Tasks.md

@@ -55,6 +55,10 @@ Use this setting to control where the recurring task is inserted. The default is
 > [!released]
 > Control of the location (or order) of the new task was introduced in Tasks 3.8.0
 
+### Drop scheduled dates
+
+Use this setting to control whether the scheduled date should be removed from the next occurrence. The scheduled date is only removed the task also has another date.
+
 ### Recurring Tasks with Custom Statuses
 
 > [!Warning]

src/Config/Settings.ts

@@ -76,6 +76,7 @@ export interface Settings {
     filenameAsScheduledDateFormat: string;
     filenameAsDateFolders: string[];
     recurrenceOnNextLine: boolean;
+    dropScheduledDateOnRecurrence: boolean;
 
     // The custom status states.
     statusSettings: StatusSettings;
@@ -110,6 +111,7 @@ const defaultSettings: Settings = {
     filenameAsScheduledDateFormat: '',
     filenameAsDateFolders: [],
     recurrenceOnNextLine: false,
+    dropScheduledDateOnRecurrence: false,
     statusSettings: new StatusSettings(),
     features: Feature.settingsFlags,
     generalSettings: {

src/Config/SettingsTab.ts

@@ -376,6 +376,23 @@ export class SettingsTab extends PluginSettingTab {
                 });
             });
 
+        new Setting(containerEl)
+            .setName(i18n.t('settings.recurringTasks.dropScheduledDate.name'))
+            .setDesc(
+                SettingsTab.createFragmentWithHTML(
+                    i18n.t('settings.recurringTasks.dropScheduledDate.description') +
+                        '</br>' +
+                        this.seeTheDocumentation('https://publish.obsidian.md/tasks/Getting+Started/Recurring+Tasks'),
+                ),
+            )
+            .addToggle((toggle) => {
+                const { dropScheduledDateOnRecurrence } = getSettings();
+                toggle.setValue(dropScheduledDateOnRecurrence).onChange(async (value) => {
+                    updateSettings({ dropScheduledDateOnRecurrence: value });
+                    await this.plugin.saveSettings();
+                });
+            });
+
         // ---------------------------------------------------------------------------
         new Setting(containerEl).setName(i18n.t('settings.autoSuggest.heading')).setHeading();
         // ---------------------------------------------------------------------------

src/Task/Occurrence.ts

@@ -87,8 +87,9 @@ export class Occurrence {
      * If the occurrence has no reference date, an empty {@link Occurrence} will be returned.
      *
      * @param nextReferenceDate
+     * @param dropScheduledDate - Optional boolean to drop the scheduled date from the next occurrence so long as a start or due date exists.
      */
-    public next(nextReferenceDate: Date): Occurrence {
+    public next(nextReferenceDate: Date, dropScheduledDate: boolean = false): Occurrence {
         // Only if a reference date is given. A reference date will exist if at
         // least one of the other dates is set.
         if (this.referenceDate === null) {
@@ -99,10 +100,21 @@ export class Occurrence {
             });
         }
 
+        const hasStartDate = this.startDate !== null;
+        const hasDueDate = this.dueDate !== null;
+        const canDropScheduledDate = hasStartDate || hasDueDate;
+        const shouldDropScheduledDate = dropScheduledDate && canDropScheduledDate;
+
+        const startDate = this.nextOccurrenceDate(this.startDate, nextReferenceDate);
+        const scheduledDate = shouldDropScheduledDate
+            ? null
+            : this.nextOccurrenceDate(this.scheduledDate, nextReferenceDate);
+        const dueDate = this.nextOccurrenceDate(this.dueDate, nextReferenceDate);
+
         return new Occurrence({
-            startDate: this.nextOccurrenceDate(this.startDate, nextReferenceDate),
-            scheduledDate: this.nextOccurrenceDate(this.scheduledDate, nextReferenceDate),
-            dueDate: this.nextOccurrenceDate(this.dueDate, nextReferenceDate),
+            startDate,
+            scheduledDate,
+            dueDate,
         });
     }
 

src/Task/Recurrence.ts

@@ -72,15 +72,16 @@ export class Recurrence {
      * Returns the dates of the next occurrence or null if there is no next occurrence.
      *
      * @param today - Optional date representing the completion date. Defaults to today.
+     * @param dropScheduledDate - Optional boolean to drop the scheduled date from the next occurrence so long as a start or due date exists.
      */
-    public next(today = window.moment()): Occurrence | null {
+    public next(today = window.moment(), dropScheduledDate: boolean = false): Occurrence | null {
         const nextReferenceDate = this.nextReferenceDate(today);
 
         if (nextReferenceDate === null) {
             return null;
         }
 
-        return this.occurrence.next(nextReferenceDate);
+        return this.occurrence.next(nextReferenceDate, dropScheduledDate);
     }
 
     public identicalTo(other: Recurrence) {

src/Task/Task.ts

@@ -377,7 +377,8 @@ export class Task extends ListItem {
             return [toggledTask];
         }
 
-        const nextOccurrence = this.recurrence.next(today);
+        const { dropScheduledDateOnRecurrence } = getSettings();
+        const nextOccurrence = this.recurrence.next(today, dropScheduledDateOnRecurrence);
         if (nextOccurrence === null) {
             return [toggledTask];
         }

src/i18n/locales/en.json

@@ -180,6 +180,10 @@
       "nextLine": {
         "description": "Enabling this will make the next recurrence of a task appear on the line below the completed task. Otherwise the next recurrence will appear before the completed one.",
         "name": "Next recurrence appears on the line below"
+      },
+      "dropScheduledDate": {
+        "description": "Enabling this will make the next recurrence of a task have no scheduled date, unless the scheduled date is the only date the task has.",
+        "name": "Drop scheduled date (only if Start or Due is present)"
       }
     },
     "seeTheDocumentation": "See the documentation",

tests/Task/Recurrence.test.ts

@@ -228,3 +228,41 @@ describe('identicalTo', () => {
         expect(date1Recurrence?.identicalTo(date2Recurrence)).toBe(false);
     });
 });
+
+describe('Recurrence - with dropScheduledDateOnRecurrence', () => {
+    it('drops the scheduledDate when dropScheduledDate is true', () => {
+        // Arrange
+        const recurrence = Recurrence.fromText({
+            recurrenceRuleText: 'every month',
+            occurrence: new Occurrence({
+                startDate: moment('2022-01-01').startOf('day'),
+                scheduledDate: moment('2022-01-04').startOf('day'),
+                dueDate: moment('2022-01-10').startOf('day'),
+            }),
+        });
+
+        // Act
+        const next = recurrence!.next(undefined, true);
+
+        // Assert
+        expect(next!.startDate).toEqualMoment(moment('2022-02-01'));
+        expect(next!.scheduledDate).toBeNull();
+        expect(next!.dueDate).toEqualMoment(moment('2022-02-10'));
+    });
+
+    it('does not drop the scheduledDate when it is the only date', () => {
+        // Arrange
+        const recurrence = Recurrence.fromText({
+            recurrenceRuleText: 'every month',
+            occurrence: new Occurrence({
+                scheduledDate: moment('2022-01-04').startOf('day'),
+            }),
+        });
+
+        // Act
+        const next = recurrence!.next(undefined, true);
+
+        // Assert
+        expect(next!.scheduledDate).not.toBeNull();
+    });
+});