@delorenj/pjangler 1.5.11 → 1.5.13

package/templates/commonproject/template/.mise/{% if is_obsidian_plugin %}tasks{% endif %}/plugin/link

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+#MISE description="Symlink this plugin into an Obsidian vault: plugin:link [vault] (default: $OBSIDIAN_VAULT)"
+#MISE tools={node="24"}
+# Obsidian loads a plugin from <vault>/.obsidian/plugins/<manifest id>/, reading
+# main.js, manifest.json and styles.css. Linking the repo there means every
+# `npm run dev` rebuild is live after a plugin reload (or instantly with the
+# Hot-Reload community plugin). Replaces only a symlink it can recognise as a
+# link; a real directory at the destination is left alone.
+set -euo pipefail
+
+root="${MISE_CONFIG_ROOT:-$(pwd)}"
+vault="${1:-${OBSIDIAN_VAULT:-}}"
+[ -n "$vault" ] || { echo "plugin:link: pass the vault path or set OBSIDIAN_VAULT" >&2; exit 2; }
+[ -d "$vault/.obsidian" ] || { echo "plugin:link: $vault is not an Obsidian vault (no .obsidian/)" >&2; exit 2; }
+
+id="$(node -p 'JSON.parse(require("fs").readFileSync(process.argv[1], "utf8")).id' "$root/manifest.json")"
+[ -n "$id" ] || { echo "plugin:link: manifest.json has no id" >&2; exit 1; }
+
+dest="$vault/.obsidian/plugins/$id"
+if [ -e "$dest" ] && [ ! -L "$dest" ]; then
+  echo "plugin:link: $dest already exists and is not a symlink; remove it first" >&2
+  exit 1
+fi
+mkdir -p "$vault/.obsidian/plugins"
+ln -sfn "$root" "$dest"
+echo "linked $dest -> $root"
+[ -f "$root/main.js" ] || echo "plugin:link: no main.js yet; run npm run dev (or npm run build)" >&2

package/templates/commonproject/template/AGENTS.md.jinja

@@ -5,3 +5,70 @@
 ## Overview
 
 __TODO__
+{%- if is_obsidian_plugin %}
+
+## Obsidian community plugin
+
+This project is an Obsidian community plugin, scaffolded from the canonical
+[obsidian-sample-plugin](https://github.com/obsidianmd/obsidian-sample-plugin).
+TypeScript in `src/` is bundled by esbuild into `main.js`, which Obsidian loads.
+
+- Package manager: **npm** (`package.json` scripts, `package-lock.json`). Never bun or pnpm.
+- Bundler: **esbuild** (`esbuild.config.mjs`). Types come from the `obsidian` package.
+- Release artifacts: `main.js`, `manifest.json`, and `styles.css` (optional).
+
+### Commands
+
+```bash
+npm install          # dev dependencies, pinned by the committed package-lock.json
+npm run dev          # watch build -> main.js (inline sourcemaps)
+npm run build        # type-check, then production build
+npm run lint         # eslint with eslint-plugin-obsidianmd
+mise run plugin:link # symlink this repo into $OBSIDIAN_VAULT/.obsidian/plugins/<id>
+```
+
+Reload Obsidian (or use the Hot-Reload plugin) and enable the plugin under
+**Settings → Community plugins**.
+
+### Layout
+
+- `src/main.ts` stays small: plugin lifecycle (`onload`/`onunload`) and registration only.
+- Feature logic goes in focused modules under `src/` (`settings.ts`, `commands/`, `ui/`, `utils/`).
+- Never commit `node_modules/`, `main.js`, `*.map`, or the vault's `data.json`.
+- Bundle every runtime dependency into `main.js`; keep dependencies small and browser-compatible.
+
+### Manifest rules (`manifest.json`)
+
+- `id` is stable API: never change it after release. It must not contain "obsidian",
+  and for local development it must match the plugin folder name in the vault.
+- `version` is SemVer `x.y.z`; keep `minAppVersion` accurate when you use newer APIs.
+- `isDesktopOnly` must be `true` if you use Node or Electron APIs.
+- Canonical checks: https://github.com/obsidianmd/obsidian-releases/blob/master/.github/workflows/validate-plugin-entry.yml
+
+### Versioning and releases
+
+- `npm version patch|minor|major` is the release step. It bumps `package.json`, and
+  `version-bump.mjs` syncs `manifest.json` and `versions.json` (plugin version → minimum
+  app version). It commits, then tags the bare version: no leading `v`, because `.npmrc`
+  sets `tag-version-prefix=""`.
+- `mise run version:bump` keeps the same three files in step without committing or tagging.
+- Push the tag. `.github/workflows/release.yml` drafts the GitHub release with `main.js`,
+  `manifest.json` and `styles.css` attached.
+- The community catalog requires a public repo and a LICENSE; pick one before submitting.
+
+### Plugin conventions
+
+- Add commands with `this.addCommand(...)` and stable IDs; never rename a released ID.
+- Persist settings with `this.loadData()` / `this.saveData()`, with defaults in `settings.ts`.
+- Register every DOM event, workspace event, and interval through `this.register*`,
+  so the plugin unloads without leaking listeners.
+- Keep `onload` light: defer heavy work, debounce vault events, batch disk access.
+- Stay inside the vault, make no network calls without a user-visible reason, and never
+  fetch or eval remote code. These are Obsidian's developer policies, and review enforces them.
+- UI copy uses sentence case, short imperative labels, and **Settings → Community plugins**
+  style arrow navigation.
+
+References: [API docs](https://docs.obsidian.md) ·
+[Plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines) ·
+[Developer policies](https://docs.obsidian.md/Developer+policies)
+{%- endif %}

package/templates/commonproject/template/{% if is_obsidian_plugin %}.editorconfig{% endif %}

@@ -0,0 +1,15 @@
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+quote_type = single
+tab_width = 4
+
+# YAML forbids tab indentation (workflows, .copier-answers.yml, BMAD config).
+[*.{yml,yaml}]
+indent_style = space

package/templates/commonproject/template/{% if is_obsidian_plugin %}.npmrc{% endif %}

@@ -0,0 +1 @@
+tag-version-prefix=""

package/templates/commonproject/template/{% if is_obsidian_plugin %}esbuild.config.mjs{% endif %}

@@ -0,0 +1,49 @@
+import esbuild from 'esbuild';
+import process from 'process';
+import { builtinModules } from 'node:module';
+
+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';
+
+const context = await esbuild.context({
+	banner: {
+		js: banner,
+	},
+	entryPoints: ['src/main.ts'],
+	bundle: true,
+	external: [
+		'obsidian',
+		'electron',
+		'@codemirror/autocomplete',
+		'@codemirror/collab',
+		'@codemirror/commands',
+		'@codemirror/language',
+		'@codemirror/lint',
+		'@codemirror/search',
+		'@codemirror/state',
+		'@codemirror/view',
+		'@lezer/common',
+		'@lezer/highlight',
+		'@lezer/lr',
+		...builtinModules,
+	],
+	format: 'cjs',
+	target: 'es2021',
+	logLevel: 'info',
+	sourcemap: prod ? false : 'inline',
+	treeShaking: true,
+	outfile: 'main.js',
+	minify: prod,
+});
+
+if (prod) {
+	await context.rebuild();
+	process.exit(0);
+} else {
+	await context.watch();
+}

package/templates/commonproject/template/{% if is_obsidian_plugin %}eslint.config.mts{% endif %}

@@ -0,0 +1,38 @@
+import obsidianmd from 'eslint-plugin-obsidianmd';
+import globals from 'globals';
+import { globalIgnores, defineConfig } from 'eslint/config';
+
+export default defineConfig(
+	globalIgnores([
+		'node_modules',
+		'dist',
+		'esbuild.config.mjs',
+		'version-bump.mjs',
+		'versions.json',
+		'main.js',
+		'package.json',
+		'package-lock.json',
+		'tsconfig.json',
+		// CommonProject tooling: agent CLI roots, .mise, .github, the BMAD
+		// method tree and Hermes role dirs. None of it ships in the plugin.
+		'.*',
+		'_bmad',
+		'_bmad-output',
+		'agents',
+	]),
+	{
+		languageOptions: {
+			globals: {
+				...globals.browser,
+			},
+			parserOptions: {
+				projectService: {
+					allowDefaultProject: ['eslint.config.mts', 'manifest.json'],
+				},
+				tsconfigRootDir: import.meta.dirname,
+				extraFileExtensions: ['.json'],
+			},
+		},
+	},
+	...obsidianmd.configs.recommended,
+);

package/templates/commonproject/template/{% if is_obsidian_plugin %}manifest.json{% endif %}.jinja

@@ -0,0 +1,9 @@
+{
+	"id": {{ plugin_id | tojson }},
+	"name": {{ plugin_name | tojson }},
+	"version": "1.0.0",
+	"minAppVersion": "1.0.0",
+	"description": {{ plugin_description | tojson }},
+	"author": {{ plugin_author | tojson }},
+	"isDesktopOnly": false
+}