obsidian-reminder: Instructions file for Claude Code

obsidian-reminder

A plugin that adds reminder functionality to Obsidian's TODO lists. Built with TypeScript + Svelte 4, bundled with esbuild.

Language

Write all repository artifacts — code comments, commit messages, documentation — in English.

Commands

Prefer mise tasks (they just wrap npm scripts under the hood).

mise	Underlying command (npm script)	Purpose
mise run main:init	npm install	Install dependencies
mise run main:build	npm run build (node esbuild.config.mjs production)	Run a production-equivalent build once
mise run dev	npm run dev (node esbuild.config.mjs watch)	Start a persistent development watch build
mise run main:test	npm run test (jest)	Run the full test suite
mise run main:lint:fix	npm run lint:fix	eslint --fix + tsc --noEmit + svelte-check
mise run pre-commit	main:lint:fix → main:test	Pre-commit checks
mise run docs	npm run dev in docs/	Run the documentation site (VuePress) locally

esbuild.config.mjs uses esbuild's context API: with no arguments it runs a development build once and exits, with watch the process stays resident and automatically rebuilds on every file change, and with production it runs a production-equivalent build (minified, no sourcemap) once and exits.

To run a single test, call jest directly.

npx jest src/model/format/reminder-default.test.ts
npx jest -t "parse - link dates to daily notes"

Architecture

The entry point is src/main.ts (ReminderPlugin). src/ is organized into three layers.

• src/model/ — Domain logic with no dependency on the Obsidian API: Reminder/Reminders (model/reminder.ts), date/time handling via DateTime/Time (model/time.ts), and the reminder-syntax parsers for Markdown (model/format/). Most jest unit tests live here, because it never imports the obsidian module and so needs nothing else in place.
• src/plugin/ — The plugin body, which depends on the Obsidian API. Bundles file watching, notifications, settings, and command registration (plugin/index.ts is the export entry point).
• src/ui/ — Svelte components (ui/*.svelte) and the TS that supports them (e.g. calendar calculations). The Obsidian Modal/View code in src/plugin/ui/ mounts the Svelte components.