feat: Add Reminders fields and Notifications

.gitignore

@@ -34,3 +34,11 @@ yarn-error.log
 
 # Backup files.
 *.bak
+
+# vscode files
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets

docs/advanced/Task-Reminders.md

@@ -0,0 +1,25 @@
+---
+publish: false
+---
+
+# Notifications
+
+<span class="related-pages">#plugin/reminder</span>
+
+Within Tasks, reminder notifications can be set using the standard Tasks format `⏲️ YYYY-MM-DD` for daily notifications at a set or by specifying the hour `⏲️ YYYY-MM-DD h:mm a`. Multiple reminders can be set by separating secondary reminders with a comma: `⏲️ 2000-03-24, 2000-03-28 10:05 am, 2000-03-31`
+
+## Limitnations
+
+- It's not posible to set a reminder for midnight 12:00 am. This due to a limination with how tasks creates dates using momentjs which sets the defaults time to midnight when one isn't provided.
+- System notifications don't work on Mobile because Obsidian doesn't provide an API
+
+## How to complete the reminder
+
+The reminder date doesn't change when completing the task, the date will change only when you complete it from the reminder popup or from the notification.
+
+![image](https://user-images.githubusercontent.com/38974541/143463881-e4af4b91-426f-48e8-938e-4a1053b06677.png)
+![image](https://user-images.githubusercontent.com/38974541/143464983-542675ae-a467-41c0-aaca-1075c42f8328.png)
+
+## Acknowledgment
+
+This feature was created using code from uphy's [obsidian-reminder](https://github.com/uphy/obsidian-reminder) plugin.

src/Commands/CreateOrEditTaskParser.ts

@@ -60,6 +60,7 @@ export const taskFromLine = ({ line, path }: { line: string; path: string }): Ta
  recurrence: null,
  blockLink: '',
  tags: [],
+ reminders: null,
  originalMarkdown: '',
  scheduledDateIsInferred: false,
  });
@@ -95,6 +96,7 @@ export const taskFromLine = ({ line, path }: { line: string; path: string }): Ta
  doneDate: null,
  recurrence: null,
  tags: [],
+ reminders: null,
  originalMarkdown: '',
  // Not needed since the inferred status is always re-computed after submitting.
  scheduledDateIsInferred: false,

src/Config/Settings.ts

@@ -6,6 +6,7 @@ import { Status } from '../Status';
 import { DefaultTaskSerializer, type TaskSerializer } from '../TaskSerializer';
 import type { SuggestionBuilder } from '../Suggestor';
 import { DataviewTaskSerializer } from '../TaskSerializer/DataviewTaskSerializer';
+import { ReminderSettings } from '../Reminders/Reminder';
 import { DebugSettings } from './DebugSettings';
 import { StatusSettings } from './StatusSettings';
 import { Feature } from './Feature';
@@ -49,6 +50,12 @@ export const TASK_FORMATS = {
 
 export type TASK_FORMATS = typeof TASK_FORMATS; // For convenience to make some typing easier
 
+// Time formats for the reminder settings.
+export const TIME_FORMATS = {
+ twelveHour: 'YYYY-MM-DD h:mm a',
+ twentyFourHour: 'YYYY-MM-DD HH:mm',
+};
+
 export interface Settings {
  globalQuery: string;
  globalFilter: string;
@@ -73,6 +80,8 @@ export interface Settings {
  // dynamically generated.
  generalSettings: SettingsMap;
 
+ reminderSettings: ReminderSettings;
+
  // Tracks the stage of the headings in the settings UI.
  headingOpened: HeadingState;
  debugSettings: DebugSettings;
@@ -104,6 +113,7 @@ const defaultSettings: Settings = {
  },
  headingOpened: {},
  debugSettings: new DebugSettings(),
+ reminderSettings: new ReminderSettings(),
 };
 
 let settings: Settings = { ...defaultSettings };

src/Config/SettingsTab.ts

@@ -5,7 +5,7 @@ import { StatusRegistry } from '../StatusRegistry';
 import { Status } from '../Status';
 import type { StatusCollection } from '../StatusCollection';
 import * as Themes from './Themes';
-import { type HeadingState, TASK_FORMATS } from './Settings';
+import { type HeadingState, TASK_FORMATS, TIME_FORMATS } from './Settings';
 import { getSettings, isFeatureEnabled, updateGeneralSetting, updateSettings } from './Settings';
 import { GlobalFilter } from './GlobalFilter';
 import { StatusSettings } from './StatusSettings';
@@ -223,6 +223,68 @@ export class SettingsTab extends PluginSettingTab {
  });
  });
 
+ // ---------------------------------------------------------------------------
+ containerEl.createEl('h4', { text: 'Reminder Settings' });
+ // ---------------------------------------------------------------------------
+
+ new Setting(containerEl)
+ .setName('Reminder Format')
+ .setDesc(
+ SettingsTab.createFragmentWithHTML(
+ '<p class="tasks-setting-important">Do not change if reminders already exist, otherwise you will not be notified unless manually converted to new format.</p>' +
+ '<p>The format that Tasks uses to read and write reminders time i.e 12hr 6:00 pm or 24hr 18:00.</p>',
+ ),
+ )
+ .addDropdown((dropdown) => {
+ let k: keyof typeof TIME_FORMATS;
+ for (k in TIME_FORMATS) {
+ dropdown.addOption(TIME_FORMATS[k], k);
+ }
+ const settings = getSettings().reminderSettings;
+
+ dropdown.setValue(settings.dateTimeFormat).onChange(async (value) => {
+ settings.dateTimeFormat = value;
+ updateSettings({ reminderSettings: settings });
+ await this.plugin.saveSettings();
+ });
+ });
+
+ new Setting(containerEl)
+ .setName('Daily Reminder Time')
+ .setDesc(
+ SettingsTab.createFragmentWithHTML(
+ '<p>When daily reminders should be triggered. Should be in same format as above i.e 12 or 24hr.</p>',
+ ),
+ )
+ .addText((text) => {
+ const settings = getSettings().reminderSettings;
+ text.setPlaceholder('10')
+ .setValue(settings.dailyReminderTime)
+ .onChange(async (value) => {
+ settings.dailyReminderTime = value;
+ updateSettings({ reminderSettings: settings });
+ await this.plugin.saveSettings();
+ });
+ });
+
+ new Setting(containerEl)
+ .setName('Check Reminders interval')
+ .setDesc(
+ SettingsTab.createFragmentWithHTML('<p>How often Tasks should check for reminders in Seconds.</p>'),
+ )
+ .addSlider((slider) => {
+ const settings = getSettings().reminderSettings;
+ slider
+ .setLimits(1, 30, 1)
+ .setValue(settings.refreshIntervalMilliseconds / 1000) // convert from miliseconds to seconds
+ .setDynamicTooltip()
+ .onChange(async (value) => {
+ settings.refreshIntervalMilliseconds = value * 1000; // convert from seconds to miliseconds
+ updateSettings({ reminderSettings: settings });
+ await this.plugin.saveSettings();
+ });
+ });
+
  // ---------------------------------------------------------------------------
  containerEl.createEl('h4', { text: 'Auto-suggest Settings' });
  // ---------------------------------------------------------------------------

src/Query/Filter/ReminderDateField.ts

@@ -0,0 +1,21 @@
+import type { Moment } from 'moment';
+import type { Task } from '../../Task';
+import { DateField } from './DateField';
+
+export class ReminderDateField extends DateField {
+ public fieldName(): string {
+ return 'reminder';
+ }
+
+ public date(task: Task): Moment | null {
+ if (task.reminders) {
+ return task.reminders.peek();
+ } else {
+ return null;
+ }
+ }
+
+ 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 { HeadingField } from './Filter/HeadingField';
 import { PathField } from './Filter/PathField';
@@ -45,6 +46,7 @@ const fieldCreators: EndsWith<BooleanField> = [
  () => new ScheduledDateField(),
  () => new DueDateField(),
  () => new DoneDateField(),
+ () => new ReminderDateField(),
  () => new PathField(),
  () => new FolderField(),
  () => new RootField(),

src/Query/Query.ts

@@ -20,7 +20,7 @@ export class Query implements IQuery {
  private _grouping: Grouper[] = [];
 
  private readonly hideOptionsRegexp =
- /^(hide|show) (task count|backlink|priority|created date|start date|scheduled date|done date|due date|recurrence rule|edit button|urgency)/;
+ /^(hide|show) (task count|backlink|priority|created date|start date|scheduled date|done date|due date|recurrence rule|edit button|urgency|reminder date|reminders)/;
  private readonly shortModeRegexp = /^short/;
  private readonly explainQueryRegexp = /^explain/;
 
@@ -192,6 +192,10 @@ export class Query implements IQuery {
  case 'due date':
  this._layoutOptions.hideDueDate = hide;
  break;
+ case 'reminder date':
+ case 'reminders':
+ this._layoutOptions.hideReminders = hide;
+ break;
  case 'done date':
  this._layoutOptions.hideDoneDate = hide;
  break;

src/Recurrence.ts

@@ -1,13 +1,15 @@
 import type { Moment } from 'moment';
 import { RRule } from 'rrule';
-import { compareByDate } from './lib/DateTools';
+import { compareByDate, isRemindersSame } from './lib/DateTools';
+import { Reminder, ReminderList } from './Reminders/Reminder';
 
 export class Recurrence {
  private readonly rrule: RRule;
  private readonly baseOnToday: boolean;
  private readonly startDate: Moment | null;
  private readonly scheduledDate: Moment | null;
  private readonly dueDate: Moment | null;
+ private readonly reminders: ReminderList | null;
 
  /**
  * The reference date is used to calculate future occurrences.
@@ -31,32 +33,37 @@ export class Recurrence {
  startDate,
  scheduledDate,
  dueDate,
+ reminders,
  }: {
  rrule: RRule;
  baseOnToday: boolean;
  referenceDate: Moment | null;
  startDate: Moment | null;
  scheduledDate: Moment | null;
  dueDate: Moment | null;
+ reminders: ReminderList | null;
  }) {
  this.rrule = rrule;
  this.baseOnToday = baseOnToday;
  this.referenceDate = referenceDate;
  this.startDate = startDate;
  this.scheduledDate = scheduledDate;
  this.dueDate = dueDate;
+ this.reminders = reminders;
  }
 
  public static fromText({
  recurrenceRuleText,
  startDate,
  scheduledDate,
  dueDate,
+ reminders,
  }: {
  recurrenceRuleText: string;
  startDate: Moment | null;
  scheduledDate: Moment | null;
  dueDate: Moment | null;
+ reminders: ReminderList | null;
  }): Recurrence | null {
  try {
  const match = recurrenceRuleText.match(/^([a-zA-Z0-9, !]+?)( when done)?$/i);
@@ -95,6 +102,7 @@ export class Recurrence {
  startDate,
  scheduledDate,
  dueDate,
+ reminders,
  });
  }
  } catch (error) {
@@ -120,6 +128,7 @@ export class Recurrence {
  startDate: Moment | null;
  scheduledDate: Moment | null;
  dueDate: Moment | null;
+ reminders: ReminderList | null;
  } | null {
  const next = this.nextReferenceDate();
 
@@ -129,6 +138,7 @@ export class Recurrence {
  let startDate: Moment | null = null;
  let scheduledDate: Moment | null = null;
  let dueDate: Moment | null = null;
+ let reminders: ReminderList | null = null;
 
  // Only if a reference date is given. A reference date will exist if at
  // least one of the other dates is set.
@@ -157,12 +167,26 @@ export class Recurrence {
  // Rounding days to handle cross daylight-savings-time recurrences.
  dueDate.add(Math.round(originalDifference.asDays()), 'days');
  }
+
+ if (this.reminders) {
+ reminders = new ReminderList(null);
+ this.reminders.reminders.forEach((reminder) => {
+ const originalDifference = window.moment.duration(reminder.time.diff(this.referenceDate));
+ const remTime = window.moment(next);
+
+ remTime.add(Math.floor(originalDifference.asDays()), 'days');
+ // add back time
+ remTime.set({ hour: reminder.time.hour(), minute: reminder.time.minute() });
+ reminders!.reminders.push(new Reminder(remTime, reminder.type));
+ });
+ }
  }
 
  return {
  startDate,
  scheduledDate,
  dueDate,
+ reminders,
  };
  }
 
@@ -185,6 +209,10 @@ export class Recurrence {
  return false;
  }
 
+ if (!isRemindersSame(this.reminders, other.reminders)) {
+ return false;
+ }
+
  return this.toText() === other.toText(); // this also checks baseOnToday
  }
 

src/Suggestor/Suggestor.ts

@@ -262,6 +262,7 @@ function addRecurrenceSuggestions(line: string, cursorPos: number, settings: Set
  startDate: null,
  scheduledDate: null,
  dueDate: null,
+ reminders: null,
  })?.toText();
  if (parsedRecurrence) {
  const appendedText = `${recurrencePrefix} ${parsedRecurrence} `;