feat: Add Reminder Field Support

.gitignore

@@ -39,3 +39,6 @@ yarn-error.log
 
 # Backup files.
 *.bak
+
+# Yarn
+.yarn

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

src/Commands/CreateOrEditTaskParser.ts

@@ -88,6 +88,7 @@ export const taskFromLine = ({ line, path }: { line: string; path: string }): Ta
             startDate: null,
             scheduledDate: null,
             dueDate: null,
+            reminderDate: null,
             doneDate: null,
             cancelledDate: null,
             recurrence: null,
@@ -128,6 +129,7 @@ export const taskFromLine = ({ line, path }: { line: string; path: string }): Ta
         startDate: null,
         scheduledDate: null,
         dueDate: null,
+        reminderDate: null,
         doneDate: null,
         cancelledDate: null,
         recurrence: null,

src/Layout/TaskLayoutOptions.ts

@@ -15,6 +15,7 @@ export enum TaskLayoutComponent {
     StartDate = 'startDate',
     ScheduledDate = 'scheduledDate',
     DueDate = 'dueDate',
+    ReminderDate = 'reminderDate',
     CancelledDate = 'cancelledDate',
     DoneDate = 'doneDate',
     BlockLink = 'blockLink',

src/Query/Filter/ReminderDateField.ts

@@ -0,0 +1,18 @@
+import type { Moment } from 'moment';
+import type { Task } from '../../Task/Task';
+import { DateField } from './DateField';
+
+/**
+ * Support the 'reminder' search instruction.
+ */
+export class ReminderDateField extends DateField {
+    public fieldName(): string {
+        return 'reminder';
+    }
+    public date(task: Task): Moment | null {
+        return task.reminderDate;
+    }
+    protected filterResultIfFieldMissing() {
+        return false;
+    }
+}

src/Query/FilterParser.ts

@@ -3,6 +3,7 @@ import { DescriptionField } from './Filter/DescriptionField';
 import { CreatedDateField } from './Filter/CreatedDateField';
 import { DoneDateField } from './Filter/DoneDateField';
 import { DueDateField } from './Filter/DueDateField';
+import { ReminderDateField } from './Filter/ReminderDateField';
 import { ExcludeSubItemsField } from './Filter/ExcludeSubItemsField';
 import { FunctionField } from './Filter/FunctionField';
 import { HeadingField } from './Filter/HeadingField';
@@ -50,6 +51,7 @@ export const fieldCreators: EndsWith<BooleanField> = [
     () => new StartDateField(),
     () => new ScheduledDateField(),
     () => new DueDateField(),
+    () => new ReminderDateField(),
     () => new DoneDateField(),
     () => new PathField(),
     () => new FolderField(),

src/Query/Query.ts

@@ -35,7 +35,7 @@ export class Query implements IQuery {
     private _ignoreGlobalQuery: boolean = false;
 
     private readonly hideOptionsRegexp =
-        /^(hide|show) (task count|backlink|priority|cancelled date|created date|start date|scheduled date|done date|due date|recurrence rule|edit button|postpone button|urgency|tags|depends on|id)/i;
+        /^(hide|show) (task count|backlink|priority|cancelled date|created date|start date|scheduled date|done date|due date|reminder date|recurrence rule|edit button|postpone button|urgency|tags|depends on|id)/i;
     private readonly shortModeRegexp = /^short/i;
     private readonly fullModeRegexp = /^full/i;
     private readonly explainQueryRegexp = /^explain/i;
@@ -309,6 +309,9 @@ Problem line: "${line}"`;
                 case 'due date':
                     this._taskLayoutOptions.setVisibility(TaskLayoutComponent.DueDate, !hide);
                     break;
+                case 'reminder date':
+                    this._taskLayoutOptions.setVisibility(TaskLayoutComponent.ReminderDate, !hide);
+                    break;
                 case 'done date':
                     this._taskLayoutOptions.setVisibility(TaskLayoutComponent.DoneDate, !hide);
                     break;

src/Query/Sort/Sort.ts

@@ -1,6 +1,7 @@
 import type { Task } from '../../Task/Task';
 import { StatusTypeField } from '../Filter/StatusTypeField';
 import { DueDateField } from '../Filter/DueDateField';
+import { ReminderDateField } from '../Filter/ReminderDateField';
 import { PriorityField } from '../Filter/PriorityField';
 import { PathField } from '../Filter/PathField';
 import { UrgencyField } from '../Filter/UrgencyField';
@@ -27,6 +28,7 @@ export class Sort {
             new StatusTypeField().createNormalSorter(),
             new UrgencyField().createNormalSorter(),
             new DueDateField().createNormalSorter(),
+            new ReminderDateField().createNormalSorter(),
             new PriorityField().createNormalSorter(),
             new PathField().createNormalSorter(),
         ];

src/Renderer/TaskFieldRenderer.ts

@@ -156,6 +156,7 @@ const taskFieldHTMLData: { [c in TaskLayoutComponent]: TaskFieldHTMLData } = {
     // NEW_TASK_FIELD_EDIT_REQUIRED
     createdDate: createDateField('task-created', 'taskCreated'),
     dueDate: createDateField('task-due', 'taskDue'),
+    reminderDate: createDateField('task-reminder', 'taskReminder'),
     startDate: createDateField('task-start', 'taskStart'),
     scheduledDate: createDateField('task-scheduled', 'taskScheduled'),
     doneDate: createDateField('task-done', 'taskDone'),

src/Renderer/TaskLineRenderer.ts

@@ -9,6 +9,7 @@ import { StatusRegistry } from '../Statuses/StatusRegistry';
 import type { Task } from '../Task/Task';
 import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 import { StatusMenu } from '../ui/Menus/StatusMenu';
+import { isDateTime } from '../lib/DateTools';
 import { TaskFieldRenderer } from './TaskFieldRenderer';
 
 /**
@@ -314,6 +315,7 @@ export class TaskLineRenderer {
             createdDateSymbol,
             scheduledDateSymbol,
             dueDateSymbol,
+            reminderDateSymbol,
             cancelledDateSymbol,
             doneDateSymbol,
         } = TASK_FORMATS.tasksPluginEmoji.taskSerializer.symbols;
@@ -332,9 +334,10 @@ export class TaskLineRenderer {
             }
 
             function toTooltipDate({ signifier, date }: { signifier: string; date: Moment }): string {
-                return `${signifier} ${date.format(TaskRegularExpressions.dateFormat)} (${date.from(
-                    window.moment().startOf('day'),
-                )})`;
+                const format = isDateTime(date)
+                    ? TaskRegularExpressions.dateTimeFormat
+                    : TaskRegularExpressions.dateFormat;
+                return `${signifier} ${date.format(format)} (${date.from(window.moment().startOf('day'))})`;
             }
 
             const tooltip = element.createDiv();
@@ -350,6 +353,7 @@ export class TaskLineRenderer {
             addDateToTooltip(tooltip, task.startDate, startDateSymbol);
             addDateToTooltip(tooltip, task.scheduledDate, scheduledDateSymbol);
             addDateToTooltip(tooltip, task.dueDate, dueDateSymbol);
+            addDateToTooltip(tooltip, task.reminderDate, reminderDateSymbol);
             addDateToTooltip(tooltip, task.cancelledDate, cancelledDateSymbol);
             addDateToTooltip(tooltip, task.doneDate, doneDateSymbol);
 

src/Scripting/TasksDate.ts

@@ -2,6 +2,7 @@ import type { DurationInputArg2, Moment, unitOfTime } from 'moment';
 import { Notice } from 'obsidian';
 import { PropertyCategory } from '../lib/PropertyCategory';
 import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
+import { isDateTime } from '../lib/DateTools';
 
 /**
  * TasksDate encapsulates a date, for simplifying the JavaScript expressions users need to
@@ -37,6 +38,14 @@ export class TasksDate {
         return this.format(TaskRegularExpressions.dateTimeFormat, fallBackText);
     }
 
+    /**
+     * Return the date formatted as YYYY-MM-DD HH:mm, or {@link fallBackText} if there is no date.
+     @param fallBackText - the string to use if the date is null. Defaults to empty string.
+     */
+    public formatAsDateAndTimeOrDate(fallBackText: string = ''): string {
+        return isDateTime(this.moment) ? this.formatAsDateAndTime(fallBackText) : this.formatAsDate(fallBackText);
+    }
+
     /**
      * Return the date formatted with the given format string, or {@link fallBackText} if there is no date.
      * See https://momentjs.com/docs/#/displaying/ for all the available formatting options.

src/Suggestor/Suggestor.ts

@@ -20,7 +20,12 @@ export function makeDefaultSuggestionBuilder(
     dataviewMode: boolean,
 ): SuggestionBuilder {
     // NEW_TASK_FIELD_EDIT_REQUIRED
-    const datePrefixRegex = [symbols.startDateSymbol, symbols.scheduledDateSymbol, symbols.dueDateSymbol].join('|');
+    const datePrefixRegex = [
+        symbols.startDateSymbol,
+        symbols.scheduledDateSymbol,
+        symbols.dueDateSymbol,
+        symbols.reminderDateSymbol,
+    ].join('|');
     /*
      * Return a list of suggestions, either generic or more fine-grained to the words at the cursor.
      */
@@ -97,6 +102,11 @@ function addTaskPropertySuggestions(
             displayText: `${symbols.dueDateSymbol} due date`,
             appendText: `${symbols.dueDateSymbol} `,
         });
+    if (!line.includes(symbols.reminderDateSymbol))
+        genericSuggestions.push({
+            displayText: `${symbols.reminderDateSymbol} reminder date`,
+            appendText: `${symbols.reminderDateSymbol} `,
+        });
     if (!line.includes(symbols.startDateSymbol))
         genericSuggestions.push({
             displayText: `${symbols.startDateSymbol} start date`,
@@ -320,6 +330,7 @@ function addRecurrenceSuggestions(
                 startDate: null,
                 scheduledDate: null,
                 dueDate: null,
+                reminderDate: null,
             })?.toText();
             if (parsedRecurrence) {
                 const appendedText = `${recurrencePrefix} ${parsedRecurrence}` + postfix;

src/Task/Recurrence.ts

@@ -11,6 +11,7 @@ export class Recurrence {
     private readonly startDate: Moment | null;
     private readonly scheduledDate: Moment | null;
     private readonly dueDate: Moment | null;
+    private readonly reminderDate: Moment | null;
 
     /**
      * The reference date is used to calculate future occurrences.
@@ -34,32 +35,37 @@ export class Recurrence {
         startDate,
         scheduledDate,
         dueDate,
+        reminderDate,
     }: {
         rrule: RRule;
         baseOnToday: boolean;
         referenceDate: Moment | null;
         startDate: Moment | null;
         scheduledDate: Moment | null;
         dueDate: Moment | null;
+        reminderDate: Moment | null;
     }) {
         this.rrule = rrule;
         this.baseOnToday = baseOnToday;
         this.referenceDate = referenceDate;
         this.startDate = startDate;
         this.scheduledDate = scheduledDate;
         this.dueDate = dueDate;
+        this.reminderDate = reminderDate;
     }
 
     public static fromText({
         recurrenceRuleText,
         startDate,
         scheduledDate,
         dueDate,
+        reminderDate,
     }: {
         recurrenceRuleText: string;
         startDate: Moment | null;
         scheduledDate: Moment | null;
         dueDate: Moment | null;
+        reminderDate: Moment | null;
     }): Recurrence | null {
         try {
             const match = recurrenceRuleText.match(/^([a-zA-Z0-9, !]+?)( when done)?$/i);
@@ -78,6 +84,8 @@ export class Recurrence {
                 // Clone the moment objects.
                 if (dueDate) {
                     referenceDate = window.moment(dueDate);
+                } else if (reminderDate) {
+                    referenceDate = window.moment(reminderDate);
                 } else if (scheduledDate) {
                     referenceDate = window.moment(scheduledDate);
                 } else if (startDate) {
@@ -98,6 +106,7 @@ export class Recurrence {
                     startDate,
                     scheduledDate,
                     dueDate,
+                    reminderDate,
                 });
             }
         } catch (e) {
@@ -129,6 +138,7 @@ export class Recurrence {
         startDate: Moment | null;
         scheduledDate: Moment | null;
         dueDate: Moment | null;
+        reminderDate: Moment | null;
     } | null {
         const next = this.nextReferenceDate(today);
 
@@ -138,6 +148,7 @@ export class Recurrence {
             let startDate: Moment | null = null;
             let scheduledDate: Moment | null = null;
             let dueDate: Moment | null = null;
+            let reminderDate: Moment | null = null;
 
             // Only if a reference date is given. A reference date will exist if at
             // least one of the other dates is set.
@@ -166,12 +177,21 @@ export class Recurrence {
                     // Rounding days to handle cross daylight-savings-time recurrences.
                     dueDate.add(Math.round(originalDifference.asDays()), 'days');
                 }
+                if (this.reminderDate) {
+                    const originalDifference = window.moment.duration(this.reminderDate.diff(this.referenceDate));
+
+                    // Cloning so that original won't be manipulated:
+                    reminderDate = window.moment(next);
+                    // Rounding days to handle cross daylight-savings-time recurrences.
+                    reminderDate.add(Math.round(originalDifference.asDays()), 'days');
+                }
             }
 
             return {
                 startDate,
                 scheduledDate,
                 dueDate,
+                reminderDate,
             };
         }
 
@@ -193,6 +213,9 @@ export class Recurrence {
         if (compareByDate(this.dueDate, other.dueDate) !== 0) {
             return false;
         }
+        if (compareByDate(this.reminderDate, other.reminderDate) !== 0) {
+            return false;
+        }
 
         return this.toText() === other.toText(); // this also checks baseOnToday
     }

src/Task/Task.ts

@@ -54,6 +54,7 @@ export class Task {
     public readonly startDate: Moment | null;
     public readonly scheduledDate: Moment | null;
     public readonly dueDate: Moment | null;
+    public readonly reminderDate: Moment | null;
     public readonly doneDate: Moment | null;
     public readonly cancelledDate: Moment | null;
 
@@ -88,6 +89,7 @@ export class Task {
         startDate,
         scheduledDate,
         dueDate,
+        reminderDate,
         doneDate,
         cancelledDate,
         recurrence,
@@ -109,6 +111,7 @@ export class Task {
         startDate: moment.Moment | null;
         scheduledDate: moment.Moment | null;
         dueDate: moment.Moment | null;
+        reminderDate: moment.Moment | null;
         doneDate: moment.Moment | null;
         cancelledDate: moment.Moment | null;
         recurrence: Recurrence | null;
@@ -134,6 +137,7 @@ export class Task {
         this.startDate = startDate;
         this.scheduledDate = scheduledDate;
         this.dueDate = dueDate;
+        this.reminderDate = reminderDate;
         this.doneDate = doneDate;
         this.cancelledDate = cancelledDate;
 
@@ -362,6 +366,7 @@ export class Task {
             startDate: Moment | null;
             scheduledDate: Moment | null;
             dueDate: Moment | null;
+            reminderDate: Moment | null;
         } | null = null;
         if (newStatus.isCompleted()) {
             if (!this.status.isCompleted() && this.recurrence !== null) {
@@ -423,6 +428,7 @@ export class Task {
             startDate: moment.Moment | null;
             scheduledDate: moment.Moment | null;
             dueDate: moment.Moment | null;
+            reminderDate: moment.Moment | null;
         },
     ) {
         const { setCreatedDate } = getSettings();
@@ -649,6 +655,13 @@ export class Task {
         return new TasksDate(this.dueDate);
     }
 
+    /**
+     * Return {@link reminderDate} as a {@link TasksDate}, so the field names in scripting docs are consistent with the existing search instruction names, and null values are easy to deal with.
+     */
+    public get reminder(): TasksDate {
+        return new TasksDate(this.reminderDate);
+    }
+
     /**
      * Return {@link scheduledDate} as a {@link TasksDate}, so the field names in scripting docs are consistent with the existing search instruction names, and null values are easy to deal with.
      */
@@ -893,6 +906,7 @@ export class Task {
             'startDate' as keyof Task,
             'scheduledDate' as keyof Task,
             'dueDate' as keyof Task,
+            'reminderDate' as keyof Task,
             'doneDate' as keyof Task,
             'cancelledDate' as keyof Task,
         ];