Add ribbon; unload commands; fix weekly note formats (#22)

* Add ribbon; unload commands; fix weekly note formats

* Minor style improvements

* bump version

* bump daily-notes-interface

Author: liamcain

manifest.json

@@ -2,7 +2,7 @@
   "id": "periodic-notes",
   "name": "Periodic Notes",
   "description": "Create/manage your daily, weekly, and monthly notes",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "author": "Liam Cain",
   "authorUrl": "https://github.com/liamcain/",
   "isDesktopOnly": false,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-periodic-notes",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "Create/manage daily, weekly, and monthly notes",
   "author": "liamcain",
   "main": "main.js",
@@ -14,30 +14,30 @@
   "dependencies": {
     "@popperjs/core": "2.6.0",
     "obsidian": "obsidianmd/obsidian-api#master",
-    "obsidian-daily-notes-interface": "0.7.3",
-    "svelte": "3.32.1",
-    "tslib": "2.0.3"
+    "obsidian-daily-notes-interface": "0.7.6",
+    "svelte": "3.35.0",
+    "tslib": "2.1.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "17.0.0",
-    "@rollup/plugin-node-resolve": "11.0.0",
-    "@rollup/plugin-typescript": "8.1.0",
+    "@rollup/plugin-commonjs": "17.1.0",
+    "@rollup/plugin-node-resolve": "11.2.0",
+    "@rollup/plugin-typescript": "8.2.0",
     "@testing-library/jest-dom": "5.11.9",
     "@tsconfig/svelte": "1.0.10",
     "@types/jest": "26.0.20",
     "@types/moment": "2.13.0",
-    "@types/node": "14.14.21",
-    "@typescript-eslint/eslint-plugin": "4.13.0",
-    "@typescript-eslint/parser": "4.13.0",
-    "eslint": "7.18.0",
+    "@types/node": "14.14.34",
+    "@typescript-eslint/eslint-plugin": "4.17.0",
+    "@typescript-eslint/parser": "4.17.0",
+    "eslint": "7.22.0",
     "jest": "26.6.3",
     "moment": "2.29.1",
-    "rollup": "2.38.4",
-    "rollup-plugin-svelte": "7.0.0",
-    "svelte-check": "1.1.32",
-    "svelte-preprocess": "4.6.6",
-    "ts-jest": "26.5.0",
-    "typescript": "4.1.3"
+    "rollup": "2.41.2",
+    "rollup-plugin-svelte": "7.1.0",
+    "svelte-check": "1.2.5",
+    "svelte-preprocess": "4.6.9",
+    "ts-jest": "26.5.3",
+    "typescript": "4.2.3"
   },
   "jest": {
     "moduleNameMapper": {

src/commands.ts

@@ -44,20 +44,20 @@ const periodConfigs: Record<IPeriodicity, IPeriodConfig> = {
   },
 };
 
-async function openPeriodicNote(
+export async function openPeriodicNote(
   periodicity: IPeriodicity,
   date: Moment,
   inNewSplit: boolean
 ): Promise<void> {
   const config = periodConfigs[periodicity];
   const startOfPeriod = date.clone().startOf(config.unitOfTime);
 
-  let allNotes;
+  let allNotes: Record<string, TFile>;
   try {
     allNotes = config.getAllNotes();
   } catch (err) {
-    console.error("failed to find your ${periodicity} notes folder", err);
-    new Notice("Failed to find your ${periodicity} notes folder");
+    console.error(`failed to find your ${periodicity} notes folder`, err);
+    new Notice(`Failed to find your ${periodicity} notes folder`);
     return;
   }
 

src/index.ts

@@ -1,7 +1,7 @@
 import type moment from "moment";
 import { App, Plugin } from "obsidian";
 
-import { getCommands } from "./commands";
+import { getCommands, openPeriodicNote } from "./commands";
 import { SETTINGS_UPDATED } from "./events";
 import {
   DEFAULT_SETTINGS,
@@ -11,6 +11,7 @@ import {
 } from "./settings";
 import {
   getLegacyWeeklyNoteSettings,
+  hasCoreDailyNotesPluginEnabled,
   hasLegacyWeeklyNoteSettings,
 } from "./utils";
 
@@ -25,26 +26,28 @@ export default class PeriodicNotesPlugin extends Plugin {
   public settings: ISettings;
   public isInitialLoad: boolean;
 
+  private ribbonEls: HTMLElement[];
+
   async onload(): Promise<void> {
+    this.ribbonEls = [];
+
     this.updateSettings = this.updateSettings.bind(this);
 
     await this.loadSettings();
     this.addSettingTab(new PeriodicNotesSettingsTab(this.app, this));
 
-    if (this.app.workspace.layoutReady) {
-      this.onLayoutReady();
-    } else {
-      this.app.workspace.on("layout-ready", this.onLayoutReady.bind(this));
-    }
+    this.app.workspace.onLayoutReady(this.onLayoutReady.bind(this));
   }
 
-  private onLayoutReady() {
+  onLayoutReady(): void {
     // If the user has Calendar Weekly Notes settings, migrate them automatically,
     // since the functionality will be deprecated.
     if (this.isInitialLoad && hasLegacyWeeklyNoteSettings()) {
       this.migrateWeeklySettings();
       this.settings.weekly.enabled = true;
     }
+
+    this.configureRibbonIcons();
     this.configureCommands();
   }
 
@@ -59,11 +62,37 @@ export default class PeriodicNotesPlugin extends Plugin {
     });
   }
 
+  private configureRibbonIcons() {
+    for (const ribbonEl of this.ribbonEls) {
+      ribbonEl.detach();
+    }
+
+    // Only show ribbon icon if daily notes plugin is disabled to avoid confusion
+    if (this.settings.daily.enabled && !hasCoreDailyNotesPluginEnabled()) {
+      this.ribbonEls.push(
+        this.addRibbonIcon("calendar-with-checkmark", "Open today's note", () =>
+          openPeriodicNote("daily", window.moment(), false)
+        )
+      );
+    }
+  }
+
   private configureCommands() {
-    // TODO: There's currently no way to unload the commands when any of these
-    // are toggled off
+    // Remove disabled commands
+    ["daily", "weekly", "monthly"]
+      .filter((periodicity) => !this.settings[periodicity].enabled)
+      .forEach((periodicity: IPeriodicity) => {
+        getCommands(periodicity).forEach((command) =>
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (this.app as any).commands.removeCommand(
+            `periodic-notes:${command.id}`
+          )
+        );
+      });
+
+    // register enabled commands
     ["daily", "weekly", "monthly"]
-      .filter((periodicity: IPeriodicity) => this.settings[periodicity].enabled)
+      .filter((periodicity) => this.settings[periodicity].enabled)
       .forEach((periodicity: IPeriodicity) => {
         getCommands(periodicity).forEach(this.addCommand.bind(this));
       });
@@ -93,6 +122,7 @@ export default class PeriodicNotesPlugin extends Plugin {
 
   private onSettingsUpdate(): void {
     this.configureCommands();
+    this.configureRibbonIcons();
 
     // Integrations (i.e. Calendar Plugin) can listen for changes to settings
     this.app.workspace.trigger(SETTINGS_UPDATED);

src/settings/index.ts

@@ -38,6 +38,7 @@ export class PeriodicNotesSettingsTab extends PluginSettingTab {
   }
 
   unload(): void {
+    super.unload();
     this.view?.$destroy();
   }
 

src/utils.ts

@@ -42,6 +42,12 @@ function getDailyNotesPlugin(): IDailyNotesPlugin {
   return internalPlugins.getPluginById("daily-notes")?.instance;
 }
 
+export function hasCoreDailyNotesPluginEnabled(): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const { internalPlugins } = <any>window.app;
+  return internalPlugins.getPluginById("daily-notes")?._loaded;
+}
+
 export function capitalize(text: string): string {
   return text.charAt(0).toUpperCase() + text.slice(1);
 }

styles.css

@@ -1,7 +1,9 @@
 .settings-banner {
-  background-color: var(--background-secondary-alt);
-  border-radius: 4px;
-  margin-bottom: 2em;
+  background-color: var(--background-primary-alt);
+  border-radius: 8px;
+  border: 1px solid var(--background-modifier-border);
+  margin-bottom: 1em;
+  margin-top: 1em;
   padding: 1.5em;
   text-align: left;
 }