Command for quickly inserting current date from default calendar (#192)

* Adds a command for quickly inserting the current date from the default calendar.

* Add comments describing new function.

* Fix insert command so that cursor moves to end of inserted text.

* chore(types): Update types

---------

Co-authored-by: Jeremy Valentine <[email protected]>

Author: sholder

src/api/calendar.ts

@@ -116,7 +116,7 @@ export class CalendarAPI {
      * @param {string} dateFormat Optional date format string
      * @returns formatted string
      */
-    toDisplayDate(date: CalDate, end?: CalDate, dateFormat?: string): string {
+    toDisplayDate(date: CalDate, end?: CalDate | null, dateFormat?: string): string {
         return dateString(date, this.#object, end, dateFormat);
     }
 

src/main.ts

@@ -1,8 +1,19 @@
-import { Platform, Plugin, WorkspaceLeaf, addIcon } from "obsidian";
+import {
+    Editor,
+    Platform,
+    Plugin,
+    WorkspaceLeaf,
+    addIcon,
+} from "obsidian";
 
 import CalendariumSettings from "./settings/settings.view";
 
-import type { Calendar, CalendariumData } from "./@types";
+import type {
+    CalDate,
+    Calendar,
+    CalendariumData,
+    StaticCalendarData,
+} from "./@types";
 import CalendariumView from "./calendar/view";
 
 import { Watcher } from "./watcher/watcher";
@@ -20,6 +31,8 @@ import { CalendariumNotice } from "./utils/notice";
 
 import { ViewType } from "./calendar/view.types";
 import { AgendaView } from "./agenda/view.agenda";
+import type { YearStoreCache } from "./stores/years.store";
+import { get } from "svelte/store";
 
 declare global {
     interface Window {
@@ -200,8 +213,12 @@ export default class Calendarium extends Plugin {
             id: "insert-calendarium-current-date",
             name: "Insert Current Date",
             /* Insert the current date from the default calendar at the current cursor location. */
-            editorCallback: (editor: Editor, view: MarkdownView) => {
-                this.insertCurrentDate(this.settings$.getDefaultCalendar(), editor, this.api);
+            editorCallback: (editor: Editor) => {
+                this.insertCurrentDate(
+                    this.settings$.getDefaultCalendar(),
+                    editor,
+                    this.api
+                );
             },
         });
 
@@ -210,6 +227,7 @@ export default class Calendarium extends Plugin {
             name: "Set Current Date to Next",
             callback: () => {
                 const defaultCal = this.settings$.getDefaultCalendar();
+                if (!defaultCal) return;
                 const store = this.getStoreByCalendar(defaultCal);
                 this.changeDay(defaultCal, store, incrementDay);
             },
@@ -220,6 +238,7 @@ export default class Calendarium extends Plugin {
             name: "Set Current Date to Previous",
             callback: () => {
                 const defaultCal = this.settings$.getDefaultCalendar();
+                if (!defaultCal) return;
                 const store = this.getStoreByCalendar(defaultCal);
                 this.changeDay(defaultCal, store, decrementDay);
             },
@@ -248,10 +267,19 @@ export default class Calendarium extends Plugin {
         return leaf;
     }
 
-    insertCurrentDate(calendar: Calendar, editor: Editor, api: API) {
+    insertCurrentDate(
+        calendar: Calendar | undefined,
+        editor: Editor,
+        api: API
+    ) {
+        if (!calendar) return;
         const currentCalDate = calendar.current;
         const calendarApi = api.getAPI(calendar.name);
-        const dateString = calendarApi.toDisplayDate(currentCalDate, calendar.dateFormat);
+        const dateString = calendarApi.toDisplayDate(
+            currentCalDate,
+            null,
+            calendar.dateFormat
+        );
         const cursor = editor.getCursor();
         editor.replaceRange(dateString, cursor);
         cursor.ch += dateString.length;
@@ -261,9 +289,18 @@ export default class Calendarium extends Plugin {
     changeDay(
         calendar: Calendar,
         store: CalendarStore,
-        changeFunction: (date: CalDate, yearCalculator: YearStoreCache, config: StaticCalendarData) => CalDate) {
+        changeFunction: (
+            date: CalDate,
+            yearCalculator: YearStoreCache,
+            config: StaticCalendarData
+        ) => CalDate
+    ) {
         const currentCalDate = calendar.current;
-        const newDay = changeFunction(currentCalDate, store.yearCalculator, store.staticStore.staticData);
+        const newDay = changeFunction(
+            currentCalDate,
+            store.yearCalculator,
+            get(store.staticStore.staticData)
+        );
         store.setCurrentDate(newDay);
     }
 }