feat: Add additional commands to open OR create the next/prev periodic note

Author: liamcain

src/commands.ts

@@ -1,4 +1,4 @@
-import { type Command, App, TFile } from "obsidian";
+import { type Command, App, TFile, Notice } from "obsidian";
 import type PeriodicNotesPlugin from "src/main";
 
 import type { Granularity } from "./types";
@@ -37,55 +37,54 @@ export const displayConfigs: Record<Granularity, IDisplayConfig> = {
   },
 };
 
-async function openNextNote(
+async function jumpToAdjacentNote(
   app: App,
   plugin: PeriodicNotesPlugin,
-  _granularity: Granularity
+  direction: "forwards" | "backwards"
 ): Promise<void> {
   const activeFile = app.workspace.getActiveFile();
-
   if (!activeFile) return;
   const activeFileMeta = plugin.findInCache(activeFile.path);
   if (!activeFileMeta) return;
 
-  const nextNoteMeta = plugin.findAdjacent(
+  const adjacentNoteMeta = plugin.findAdjacent(
     activeFileMeta.calendarSet,
     activeFile.path,
-    "forwards"
+    direction
   );
 
-  if (nextNoteMeta) {
-    const file = app.vault.getAbstractFileByPath(nextNoteMeta.filePath);
+  if (adjacentNoteMeta) {
+    const file = app.vault.getAbstractFileByPath(adjacentNoteMeta.filePath);
     if (file && file instanceof TFile) {
       const leaf = app.workspace.getUnpinnedLeaf();
       await leaf.openFile(file, { active: true });
     }
+  } else {
+    const qualifier = direction === "forwards" ? "after" : "before";
+    new Notice(
+      `There's no ${
+        displayConfigs[activeFileMeta.granularity].periodicity
+      } note ${qualifier} this`
+    );
   }
 }
 
-async function openPrevNote(
+async function openAdjacentNote(
   app: App,
   plugin: PeriodicNotesPlugin,
-  _granularity: Granularity // TODO switch these commands to be generic?
+  direction: "forwards" | "backwards"
 ): Promise<void> {
   const activeFile = app.workspace.getActiveFile();
   if (!activeFile) return;
   const activeFileMeta = plugin.findInCache(activeFile.path);
   if (!activeFileMeta) return;
 
-  const prevNoteMeta = plugin.findAdjacent(
-    activeFileMeta.calendarSet,
-    activeFile.path,
-    "backwards"
-  );
+  const offset = direction === "forwards" ? 1 : -1;
+  const adjacentDate = activeFileMeta.date
+    .clone()
+    .add(offset, activeFileMeta.granularity);
 
-  if (prevNoteMeta) {
-    const file = app.vault.getAbstractFileByPath(prevNoteMeta.filePath);
-    if (file && file instanceof TFile) {
-      const leaf = app.workspace.getUnpinnedLeaf();
-      await leaf.openFile(file, { active: true });
-    }
-  }
+  plugin.openPeriodicNote(activeFileMeta.granularity, adjacentDate, false);
 }
 
 export function getCommands(
@@ -104,27 +103,50 @@ export function getCommands(
 
     {
       id: `next-${config.periodicity}-note`,
-      name: `Open next ${config.periodicity} note`,
+      name: `Jump forwards to closest ${config.periodicity} note`,
       checkCallback: (checking: boolean) => {
         const activeFile = app.workspace.getActiveFile();
         if (checking) {
           if (!activeFile) return false;
           return plugin.isPeriodic(activeFile.path, granularity);
         }
-        openNextNote(app, plugin, granularity);
+        jumpToAdjacentNote(app, plugin, "forwards");
       },
     },
-
     {
       id: `prev-${config.periodicity}-note`,
+      name: `Jump backwards to closest ${config.periodicity} note`,
+      checkCallback: (checking: boolean) => {
+        const activeFile = app.workspace.getActiveFile();
+        if (checking) {
+          if (!activeFile) return false;
+          return plugin.isPeriodic(activeFile.path, granularity);
+        }
+        openAdjacentNote(app, plugin, "backwards");
+      },
+    },
+    {
+      id: `open-next-${config.periodicity}-note`,
+      name: `Open next ${config.periodicity} note`,
+      checkCallback: (checking: boolean) => {
+        const activeFile = app.workspace.getActiveFile();
+        if (checking) {
+          if (!activeFile) return false;
+          return plugin.isPeriodic(activeFile.path, granularity);
+        }
+        openAdjacentNote(app, plugin, "forwards");
+      },
+    },
+    {
+      id: `open-prev-${config.periodicity}-note`,
       name: `Open previous ${config.periodicity} note`,
       checkCallback: (checking: boolean) => {
         const activeFile = app.workspace.getActiveFile();
         if (checking) {
           if (!activeFile) return false;
           return plugin.isPeriodic(activeFile.path, granularity);
         }
-        openPrevNote(app, plugin, granularity);
+        openAdjacentNote(app, plugin, "backwards");
       },
     },
   ];

src/styles.css

@@ -33,20 +33,11 @@ input.has-error {
   position: relative;
 }
 
-.periodic-notes-switcher-input-container input {
-  padding-left: 80px;
-}
-
-.mode-indicator {
-  text-transform: capitalize;
-  background-color: var(--background-primary);
-  color: white;
-  padding: 0px 10px;
+.related-notes-mode-indicator {
+  color: var(--text-muted);
   position: absolute;
-  top: 8px;
-  left: 10px;
-  border-radius: 6px;
-  display: inline-block;
+  top: 10px;
+  right: 10px;
   font-size: 70%;
 }
 
@@ -68,3 +59,8 @@ input.has-error {
   padding: 0.1em 0.5em;
   right: 36px;
 }
+
+.minimal-theme .related-notes-mode-indicator {
+  top: 12px;
+  right: 16px;
+}

src/switcher/relatedFilesSwitcher.ts

@@ -12,7 +12,9 @@ const DEFAULT_INSTRUCTIONS = [
 ];
 
 export class RelatedFilesSwitcher extends SuggestModal<DateNavigationItem> {
+  private inputLabel: HTMLElement;
   private includeFinerGranularities: boolean;
+
   constructor(
     readonly app: App,
     readonly plugin: PeriodicNotesPlugin,
@@ -25,6 +27,17 @@ export class RelatedFilesSwitcher extends SuggestModal<DateNavigationItem> {
     this.setInstructions(DEFAULT_INSTRUCTIONS);
     this.setPlaceholder(`Search notes related to ${selectedItem.label}...`);
 
+    this.inputEl.parentElement?.prepend(
+      createDiv("periodic-notes-switcher-input-container", (inputContainer) => {
+        inputContainer.appendChild(this.inputEl);
+        this.inputLabel = inputContainer.createDiv({
+          cls: "related-notes-mode-indicator",
+          text: "Expanded",
+        });
+        this.inputLabel.toggleVisibility(false);
+      })
+    );
+
     this.scope.register([], "Tab", (evt: KeyboardEvent) => {
       evt.preventDefault();
       this.close();
@@ -38,6 +51,9 @@ export class RelatedFilesSwitcher extends SuggestModal<DateNavigationItem> {
     this.scope.register(["Shift"], "8", (evt: KeyboardEvent) => {
       evt.preventDefault();
       this.includeFinerGranularities = !this.includeFinerGranularities;
+      this.inputLabel.style.visibility = this.includeFinerGranularities
+        ? "visible"
+        : "hidden";
       this.inputEl.dispatchEvent(new Event("input"));
     });
   }

src/switcher/switcher.ts

@@ -146,10 +146,16 @@ export class NLDNavigator extends SuggestModal<DateNavigationItem> {
       return [
         getSuggestion(`in ${timeDelta} days`, "day"),
         getSuggestion(`in ${timeDelta} weeks`, "day"),
-        getSuggestion(`in ${timeDelta} months`, "day"),
+        getSuggestion(`in ${timeDelta} weeks`, "week"),
+        getSuggestion(`in ${timeDelta} months`, "month"),
+        getSuggestion(`in ${timeDelta} years`, "day"),
+        getSuggestion(`in ${timeDelta} years`, "year"),
         getSuggestion(`${timeDelta} days ago`, "day"),
         getSuggestion(`${timeDelta} weeks ago`, "day"),
+        getSuggestion(`${timeDelta} weeks ago`, "week"),
         getSuggestion(`${timeDelta} months ago`, "month"),
+        getSuggestion(`${timeDelta} years ago`, "day"),
+        getSuggestion(`${timeDelta} years ago`, "year"),
       ]
         .filter((items) => activeGranularities.includes(items.granularity))
         .filter((item) => item.label.toLowerCase().startsWith(query));
@@ -165,6 +171,9 @@ export class NLDNavigator extends SuggestModal<DateNavigationItem> {
       getSuggestion("this month", "month"),
       getSuggestion("last month", "month"),
       getSuggestion("next month", "month"),
+      getSuggestion("this quarter", "quarter"),
+      getSuggestion("last quarter", "quarter"),
+      getSuggestion("next quarter", "quarter"),
       getSuggestion("this year", "year"),
       getSuggestion("last year", "year"),
       getSuggestion("next year", "year"),