feat: rewrite the plugin to use a single cache that other plugins can fetch from via an exposed API rather than using daily-notes-interface

Author: liamcain

.DS_Store

@@ -2,12 +2,33 @@ module.exports = {
   root: true,
   parser: "@typescript-eslint/parser",
   plugins: ["@typescript-eslint"],
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+  ],
   rules: {
-    "@typescript-eslint/no-unused-vars": [
-      2,
-      { args: "all", argsIgnorePattern: "^_" },
+    "@typescript-eslint/no-unused-vars": [2, { args: "all", argsIgnorePattern: "^_" }],
+    "no-control-regex": 0,
+    "import/no-unresolved": 0,
+    "import/order": [
+      "error",
+      {
+        groups: [
+          "external", // Built-in types are first
+          "internal",
+          ["sibling", "parent"], // Then sibling and parent types. They can be mingled together
+          "index", // Then the index file
+          "object",
+          // Then the rest: internal and external type
+        ],
+        "newlines-between": "always",
+        alphabetize: {
+          order: "asc",
+          caseInsensitive: true,
+        },
+      },
     ],
-    "no-control-regex": 0
   },
 };

.eslintrc.js

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-berry.cjs

.yarnrc.yml

@@ -0,0 +1,56 @@
+import esbuild from "esbuild";
+import process from "process";
+import builtins from "builtin-modules";
+import sveltePlugin from "esbuild-svelte";
+import sveltePreprocess from "svelte-preprocess";
+
+const banner = `/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+`;
+
+const prod = process.argv[2] === "production";
+
+esbuild
+  .build({
+    banner: {
+      js: banner,
+    },
+    minify: prod ? true : false,
+    entryPoints: ["src/index.ts"],
+    bundle: true,
+    external: [
+      "obsidian",
+      "electron",
+      "codemirror",
+      "@codemirror/closebrackets",
+      "@codemirror/commands",
+      "@codemirror/fold",
+      "@codemirror/gutter",
+      "@codemirror/history",
+      "@codemirror/language",
+      "@codemirror/rangeset",
+      "@codemirror/rectangular-selection",
+      "@codemirror/search",
+      "@codemirror/state",
+      "@codemirror/stream-parser",
+      "@codemirror/text",
+      "@codemirror/view",
+      ...builtins,
+    ],
+    format: "cjs",
+    watch: !prod,
+    target: "es2016",
+    plugins: [
+      sveltePlugin({
+        compilerOptions: { css: true },
+        preprocess: sveltePreprocess(),
+      }),
+    ],
+    logLevel: "info",
+    sourcemap: prod ? false : "inline",
+    treeShaking: true,
+    outfile: "main.js",
+  })
+  .catch(() => process.exit(1));

esbuild.config.mjs

@@ -6,41 +6,44 @@
   "main": "main.js",
   "license": "MIT",
   "scripts": {
-    "lint": "eslint . --ext .ts",
-    "build": "npm run lint && rollup -c",
+    "lint": "svelte-check && eslint . --ext .ts",
+    "lint:fix": "svelte-check && eslint . --ext .ts --fix",
+    "dev": "node esbuild.config.mjs",
+    "build": "yarn run lint && node esbuild.config.mjs production",
+    "release": "standard-version",
     "test": "jest --passWithNoTests",
     "test:watch": "yarn test -- --watch"
   },
+  "standard-version": {
+    "t": ""
+  },
   "dependencies": {
-    "@popperjs/core": "2.9.1",
-    "obsidian": "0.12.16",
-    "obsidian-daily-notes-interface": "0.9.4",
-    "svelte": "3.35.0",
-    "tslib": "2.1.0"
+    "lodash": "4.17.21",
+    "obsidian": "0.13.30",
+    "svelte": "3.46.4",
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@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",
+    "@tsconfig/svelte": "3.0.0",
     "@types/jest": "26.0.20",
+    "@types/lodash": "4.14.179",
     "@types/moment": "2.13.0",
-    "@types/node": "14.14.34",
-    "@typescript-eslint/eslint-plugin": "4.17.0",
-    "@typescript-eslint/parser": "4.17.0",
-    "eslint": "7.22.0",
+    "@types/node": "17.0.22",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
+    "builtin-modules": "^3.2.0",
+    "esbuild": "0.14.28",
+    "esbuild-svelte": "0.6.3",
+    "eslint": "8.11.0",
+    "eslint-plugin-import": "^2.25.4",
     "jest": "26.6.3",
     "moment": "2.29.1",
-    "rollup": "2.41.2",
-    "rollup-plugin-svelte": "7.1.0",
-    "svelte-check": "1.2.5",
-    "svelte-preprocess": "4.6.9",
+    "standard-version": "^9.3.2",
+    "svelte-check": "2.4.6",
+    "svelte-preprocess": "4.10.4",
     "ts-jest": "26.5.3",
-    "typescript": "4.2.3"
-  },
-  "resolutions": {
-    "obsidian": "0.12.16"
+    "typescript": "^4.6.3"
   },
   "jest": {
     "moduleNameMapper": {

main.css

@@ -0,0 +1,128 @@
+import type { Moment } from "moment";
+import { App, Component, TAbstractFile, TFile, TFolder, Vault } from "obsidian";
+
+import { granularities, type Granularity, type PeriodicConfig } from "./types";
+
+import type PeriodicNotesPlugin from "./index";
+
+
+type MatchType = "filename" | "frontmatter";
+
+interface PeriodicNoteMatchMatchData {
+  /* where was the date found */
+  matchType: MatchType;
+  /* XXX: keep ZK matches in the cache, should this be separate from formats with HH:mm in them? */
+  /* just collect this for now, not 100% sure how it will be used. */
+  exact: boolean;
+}
+
+export interface PeriodicNoteCachedMetadata {
+  calendarSet: string;
+
+  filePath: string;
+  date: Moment;
+  granularity: Granularity;
+  canonicalDateStr: string;
+
+  /* "how" the match was made */
+  matchData: PeriodicNoteMatchMatchData;
+}
+
+function getCanonicalDateString(_granularity: Granularity, date: Moment): string {
+  // TODO support all granularities
+  return date.format("YYYY-MM-DD");
+}
+
+export class PeriodicNotesCache extends Component {
+  // Map the full filename to
+  public cachedFiles: Map<string, PeriodicNoteCachedMetadata>;
+
+  constructor(readonly app: App, readonly plugin: PeriodicNotesPlugin) {
+    super();
+    this.cachedFiles = new Map();
+  }
+
+  public initialize(): void {
+    console.info("[PERIODIC NOTES] initializing cache");
+    this.registerEvent(this.app.metadataCache.on("resolve", this.resolve, this));
+
+    for (const calendarSet of this.plugin.calendarSetManager.getCalendarSets()) {
+      for (const granularity of granularities) {
+        const config = calendarSet[granularity] as PeriodicConfig;
+        const rootFolder = this.app.vault.getAbstractFileByPath(
+          config.folder || "/"
+        ) as TFolder;
+        // TODO: memoize this
+        Vault.recurseChildren(rootFolder, (file: TAbstractFile) => {
+          if (file instanceof TFile) {
+            this.resolve(file);
+          }
+        });
+      }
+    }
+  }
+
+  private resolve(file: TFile): void {
+    // TODO: should I listen for create+rename instead? Rename would allow me to remove items from the cache
+    const manager = this.plugin.calendarSetManager;
+
+    // Check if file matches any calendar set
+    for (const calendarSet of manager.getCalendarSets()) {
+      for (const granularity of granularities) {
+        const format = manager.getFormat(granularity);
+        const date = window.moment(file.basename, format, true);
+        if (date.isValid()) {
+          this.cachedFiles.set(file.path, {
+            calendarSet: calendarSet.id,
+            filePath: file.path,
+            date,
+            granularity,
+            canonicalDateStr: getCanonicalDateString(granularity, date),
+            matchData: {
+              exact: true,
+              matchType: "filename",
+            },
+          });
+          return;
+        }
+      }
+    }
+  }
+
+  /**
+   *
+   * Get a periodic note from the cache
+   *
+   * @param calendarSet
+   * @param granularity
+   * @param date
+   */
+  public getPeriodicNote(
+    calendarSet: string,
+    granularity: Granularity,
+    date: Moment
+  ): TFile | null {
+    for (const [filePath, cacheData] of this.cachedFiles) {
+      if (cacheData.calendarSet !== calendarSet) continue;
+      if (cacheData.granularity !== granularity) continue;
+      if (!cacheData.date.isSame(date, granularity)) continue;
+
+      /**
+       * TODO handle the non-unique case.
+       */
+
+      return this.app.vault.getAbstractFileByPath(filePath) as TFile;
+    }
+
+    return null;
+  }
+
+  // XXX: is this good to expose?
+  public get(filePath: string): PeriodicNoteCachedMetadata | null {
+    return this.cachedFiles.get(filePath) ?? null;
+  }
+
+  public getCachedFiles(): Map<string, PeriodicNoteCachedMetadata> {
+    return Object.freeze(this.cachedFiles);
+  }
+}