@mnaoumov/create-obsidian-plugin 1.0.2 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mnaoumov/create-obsidian-plugin",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Create Obsidian plugin from modern templates.",
   "homepage": "https://github.com/mnaoumov/create-obsidian-plugin#readme",
   "bugs": "https://github.com/mnaoumov/create-obsidian-plugin/issues",
@@ -21,7 +21,8 @@
     "CHANGELOG.md",
     "LICENSE",
     "README.md",
-    "package.json"
+    "package.json",
+    "upstreams.json"
   ],
   "scripts": {
     "build": "jiti scripts/build.ts",
@@ -32,11 +33,16 @@
     "lint": "jiti scripts/lint.ts",
     "lint:fix": "jiti scripts/lint-fix.ts",
     "prepare": "jiti scripts/prepare.ts",
-    "prepublishOnly": "npm run verify:upstream-links && npm run verify:tarball",
+    "prepublishOnly": "npm run verify:upstream-links && npm run verify:official-sample && npm run verify:tarball",
     "render:case": "jiti scripts/render-one-case.ts",
     "spellcheck": "jiti scripts/spellcheck.ts",
+    "sync:docs-showcase": "jiti scripts/sync-docs-showcase.ts",
+    "sync:obsidian": "jiti scripts/sync-obsidian.ts",
+    "sync:official-sample": "jiti scripts/sync-official-sample.ts",
+    "sync:upstreams": "sync-upstreams",
     "test": "jiti scripts/test.ts",
     "verify:answer-space": "jiti scripts/verify-answer-space.ts",
+    "verify:official-sample": "jiti scripts/verify-official-sample.ts",
     "verify:plugin-drift": "jiti scripts/verify-plugin-drift.ts",
     "verify:projects": "jiti scripts/verify-generated-projects.ts",
     "verify:rendering": "jiti scripts/verify-rendering.ts",
@@ -46,6 +52,8 @@
   "overrides": {
     "eslint": "$eslint",
     "eslint-plugin-import": "npm:eslint-plugin-import-x@^4.17.1",
+    "katex": "^0.18.2",
+    "re2js": "^2.9.1",
     "typescript": "$typescript"
   },
   "dependencies": {
@@ -60,12 +68,13 @@
     "@commitlint/types": "^21.2.0",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
     "@eslint/js": "^10.0.1",
+    "@mnaoumov/typescript-dev-toolkit": "^5.2.0",
     "@stylistic/eslint-plugin": "^5.10.0",
     "@total-typescript/ts-reset": "^0.6.1",
     "@tsconfig/strictest": "^2.0.8",
     "@types/ejs": "^3.1.5",
     "@types/semver": "^7.8.0",
-    "@vitest/coverage-v8": "^4.1.11",
+    "@vitest/coverage-v8": "^5.0.5",
     "better-typescript-lib": "^2.12.0",
     "cspell": "^10.1.1",
     "czg": "^1.14.0",
@@ -77,10 +86,11 @@
     "eslint-plugin-perfectionist": "^5.10.1",
     "globals": "^17.11.0",
     "husky": "^9.1.7",
+    "ignore": "^7.0.12",
     "jiti": "^2.7.0",
     "typescript": "6.0.3",
     "typescript-eslint": "^8.68.0",
-    "vitest": "^4.1.11",
+    "vitest": "^5.0.5",
     "yaml": "^2.9.0"
   }
 }

package/src/main.ts

@@ -26,9 +26,10 @@ import type {
   Answers,
   GeneratorConfig,
   PackageJson
-} from './answers.ts';
-import type { CliArgs } from './cli-args.ts';
+} from './answers/answers.ts';
+import type { CliArgs } from './answers/cli-args.ts';
 import type { Overlay } from './overlay.ts';
+import type { UpstreamSnapshot } from './upstream-snapshot.ts';
 
 import {
   formatAnswersJson,
@@ -36,37 +37,46 @@ import {
   formatCreateScript,
   getScriptExtension,
   getShellForPlatform
-} from './answers-export.ts';
+} from './answers/answers-export.ts';
 import {
   CONFIG_FILE_NAME,
   Mode
-} from './answers.ts';
-import { assertNotCancelled } from './clack-utils.ts';
+} from './answers/answers.ts';
 import {
   getHelpText,
   parseCliArgs
-} from './cli-args.ts';
-import { findUnlistableManifestAnswers } from './directory-constraints.ts';
+} from './answers/cli-args.ts';
+import { findUnlistableManifestAnswers } from './directory/directory-constraints.ts';
 import {
   fetchCommunityPluginIds,
   makeUnlistedPluginIdValidator,
   validatePluginIdIsUnlisted
-} from './directory-registry.ts';
+} from './directory/directory-registry.ts';
 import { needsInitialFormat } from './features/formatter/index.ts';
+import { INITIAL_COMMIT_MESSAGE } from './features/git-hooks.ts';
 import {
   getInstallCommand,
   getRunCommand
 } from './features/package-manager/index.ts';
+import { isOfficialSamplePreset } from './features/preset/official-sample.ts';
+import {
+  copyOfficialSample,
+  getUpstreamsPath,
+  loadOfficialSampleSnapshot,
+  OFFICIAL_SAMPLE_PINNED_ANSWERS,
+  OFFICIAL_SAMPLE_UPSTREAM_NAME
+} from './official-sample.ts';
 import {
   loadOverlay,
   toRecordedOverlayPath
 } from './overlay.ts';
 import { createProjectFormatter } from './project-formatter.ts';
+import { assertNotCancelled } from './prompts/clack-utils.ts';
 import {
   getDefaultAnswers,
   makePluginName,
   promptAnswers
-} from './prompts.ts';
+} from './prompts/prompts.ts';
 import {
   buildTemplate,
   copyTemplates,
@@ -74,6 +84,10 @@ import {
   loadConfig,
   recordHashesOnDisk
 } from './templates.ts';
+import {
+  fetchUpstreamSnapshot,
+  readUpstream
+} from './upstream-snapshot.ts';
 import {
   fetchLatestObsidianVersion,
   fetchLatestVersion,
@@ -81,21 +95,22 @@ import {
 } from './versions.ts';
 
 interface ExecError extends Error {
+  // eslint-disable-next-line typescript-dev-toolkit/readonly-interface-members -- The command wrapper attaches captured stderr to the thrown error.
   stderr: string;
 }
 
 interface ExecResult {
-  stderr: string;
-  stdout: string;
+  readonly stderr: string;
+  readonly stdout: string;
 }
 
 interface ResolvedExternalVersions {
-  minAppVersion: string;
-  resolvedVersions: ReadonlyMap<string, string>;
+  readonly minAppVersion: string;
+  readonly resolvedVersions: ReadonlyMap<string, string>;
 }
 
 interface SavedConfig {
-  answers?: Answers;
+  readonly answers?: Answers;
 }
 
 /** Where this process's own arguments start: `node` and the script path come first. */
@@ -103,9 +118,35 @@ const ARGV_OFFSET = 2;
 
 const JSON_INDENT_SPACES = 2;
 
+/** How much of a commit SHA a message names: git's own short form. */
+const SHORT_SHA_LENGTH = 7;
+
 /** Owner-writable, everyone-executable: a script the user must `chmod` before running is a poor hand-off. */
 const SCRIPT_MODE = 0o755;
 
+/**
+ * The answers with what the preset pins applied, refusing the two flags only one kind of preset reads.
+ *
+ * `--latest` picks which upstream tree the official sample copies, so on a template preset it would be dropped.
+ * `--customTemplate` layers over the built-in templates, and the official sample renders none.
+ */
+function applyPresetFlags(answers: Answers, cliArgs: CliArgs, hasOverlay: boolean): Answers {
+  if (!isOfficialSamplePreset(answers.preset)) {
+    if (cliArgs.latest) {
+      exitWithUsageError(`--latest picks which upstream tree preset=official-sample copies, and the preset is ${answers.preset}.
+Drop --latest, or pass --preset=official-sample.`);
+    }
+    return answers;
+  }
+
+  if (hasOverlay) {
+    exitWithUsageError(`--customTemplate layers over the built-in templates, and preset=official-sample renders none: it copies obsidianmd/obsidian-sample-plugin as it is.
+Drop --customTemplate, or choose another preset.`);
+  }
+
+  return { ...answers, ...OFFICIAL_SAMPLE_PINNED_ANSWERS };
+}
+
 /**
  * Refuses to scaffold a plugin the Community directory would not list, naming the flag that fixes it.
  *
@@ -272,6 +313,11 @@ function exitWithUsageError(message: string): never {
   process.exit(1);
 }
 
+function hasPrepareScript(targetDir: string): boolean {
+  const packageJson = JSON.parse(readFileSync(join(targetDir, 'package.json'), 'utf-8')) as PackageJson;
+  return Object.hasOwn(packageJson.scripts ?? {}, 'prepare');
+}
+
 /**
  * Loads the overlay or stops with the reason, the same stderr-then-exit shape as a rejected flag: an
  * overlay that does not load is a usage error, and it is found before any question is asked.
@@ -392,12 +438,41 @@ async function resolveExternalVersions(answers: Answers, overlay: null | Overlay
   return { minAppVersion, resolvedVersions };
 }
 
+/**
+ * The upstream tree the official sample copies: the snapshot this release vendored, or under `--latest` upstream's
+ * tree today. A failed fetch falls back to the snapshot with a warning, for the reason `resolveVersions()` falls back
+ * to `latest`: generating offline must still work.
+ */
+async function resolveOfficialSampleSnapshot(latest: boolean): Promise<UpstreamSnapshot> {
+  const vendored = loadOfficialSampleSnapshot();
+  if (!latest) {
+    return vendored;
+  }
+
+  const upstream = readUpstream(getUpstreamsPath(), OFFICIAL_SAMPLE_UPSTREAM_NAME);
+  const s = spinner();
+  s.start(`Fetching ${upstream.repo}@${upstream.ref}...`);
+  try {
+    const snapshot = await fetchUpstreamSnapshot(upstream.repo, upstream.ref);
+    s.stop(`Fetched ${upstream.repo} at ${snapshot.commit.slice(0, SHORT_SHA_LENGTH)}.`);
+    return snapshot;
+  } catch (error: unknown) {
+    s.stop(`Could not fetch ${upstream.repo}.`);
+    log.warn(`${error instanceof Error ? error.message : String(error)}\nUsing the snapshot this release vendored, ${vendored.commit.slice(0, SHORT_SHA_LENGTH)}.`);
+    return vendored;
+  }
+}
+
 async function runCreate(currentVersion: string, cliArgs: CliArgs): Promise<void> {
   const { answers: suppliedAnswers, customTemplate, useDefaults } = cliArgs;
   const overlay = customTemplate ? loadOverlayOrExit(resolvePath(customTemplate)) : null;
-  const answers = await ensurePluginIdIsUnlisted(
-    assertManifestAnswersAreListable(useDefaults ? getDefaultAnswers(suppliedAnswers) : await promptAnswers(suppliedAnswers)),
-    useDefaults
+  const answers = applyPresetFlags(
+    await ensurePluginIdIsUnlisted(
+      assertManifestAnswersAreListable(useDefaults ? getDefaultAnswers(suppliedAnswers) : await promptAnswers(suppliedAnswers)),
+      useDefaults
+    ),
+    cliArgs,
+    overlay !== null
   );
 
   // Not under `--yes`: that path is what an exported script itself runs, so offering to export from
@@ -426,15 +501,25 @@ Pass --force to scaffold into it anyway.`);
     }
   }
 
-  const { minAppVersion, resolvedVersions } = await resolveExternalVersions(answers, overlay);
+  let newConfig: GeneratorConfig;
+  if (isOfficialSamplePreset(answers.preset)) {
+    // Upstream's own versions and lockfile are the point, so nothing is resolved.
+    const snapshot = await resolveOfficialSampleSnapshot(cliArgs.latest);
+    const s = spinner();
+    s.start('Copying the official sample plugin...');
+    newConfig = copyOfficialSample(answers, targetDir, currentVersion, null, snapshot);
+    s.stop(`Copied obsidianmd/obsidian-sample-plugin at ${snapshot.commit.slice(0, SHORT_SHA_LENGTH)}.`);
+  } else {
+    const { minAppVersion, resolvedVersions } = await resolveExternalVersions(answers, overlay);
+    const s = spinner();
+    s.start('Scaffolding plugin...');
+    newConfig = copyTemplates(answers, targetDir, currentVersion, null, resolvedVersions, minAppVersion, overlay);
+    s.stop('Plugin scaffolded.');
+  }
 
-  const s = spinner();
-  s.start('Scaffolding plugin...');
-  const newConfig = copyTemplates(answers, targetDir, currentVersion, null, resolvedVersions, minAppVersion, overlay);
   const configPath = join(targetDir, CONFIG_FILE_NAME);
   const configWithAnswers = buildSavedConfig(newConfig, answers, overlay, targetDir);
   writeFileSync(configPath, `${JSON.stringify(configWithAnswers, null, JSON_INDENT_SPACES)}\n`);
-  s.stop('Plugin scaffolded.');
 
   // `--yes` installs nothing and so formats nothing, which leaves a prettier or biome project failing its own
   // `format:check` until `format` runs once. It stays out of the install on purpose -- a script may want to
@@ -526,11 +611,20 @@ async function runPostScaffold(targetDir: string, answers: Answers): Promise<boo
       // `init.defaultBranch` says, which need not be the branch the generated CI workflow triggers on --
       // A mismatch produces a repo whose CI never fires. Both come from the same answer.
       await execAsync(`git init -b ${answers.defaultBranch}`, targetDir);
+      // The install ran before there was a `.git`, so its `prepare` installed no hooks, and Yarn 2+ never runs a
+      // Root `prepare` on install at all. Running it here is what makes the hooks live from the first commit on.
+      if (isInstalled && hasPrepareScript(targetDir)) {
+        await execAsync(getRunCommand(pm, 'prepare'), targetDir);
+      }
       await execAsync('git add -A', targetDir);
-      await execAsync('git commit -m "Initial commit from create-obsidian-plugin"', targetDir);
+      // A conventional header, because the commit goes through the project's own `commit-msg` hook.
+      await execAsync(`git commit -m "${INITIAL_COMMIT_MESSAGE}"`, targetDir);
       s.stop('Git repository initialized with initial commit.');
-    } catch {
+    } catch (error: unknown) {
       s.stop('Failed to initialize git. Run `git init` manually.');
+      if (error instanceof Error && 'stderr' in error) {
+        log.error(String(error.stderr));
+      }
     }
   }
 
@@ -601,7 +695,8 @@ This project records it in ${CONFIG_FILE_NAME}. Pass --customTemplate=<dir> to p
     assertNotCancelled(shouldRePrompt);
 
     if (shouldRePrompt) {
-      answers = await promptAnswers(saved);
+      // The saved answers seed each prompt, and only this run's flags skip theirs.
+      answers = await promptAnswers(saved, suppliedAnswers);
     } else {
       answers = saved;
     }
@@ -623,6 +718,19 @@ Run without --yes to answer them again.`);
     answers = await ensurePluginIdIsUnlisted(answers, useDefaults);
   }
 
+  answers = applyPresetFlags(answers, cliArgs, overlay !== null);
+
+  if (isOfficialSamplePreset(answers.preset)) {
+    const snapshot = await resolveOfficialSampleSnapshot(cliArgs.latest);
+    const s = spinner();
+    s.start('Updating project files...');
+    const newConfig = copyOfficialSample(answers, targetDir, currentVersion, existingConfig, snapshot);
+    writeFileSync(configPath, `${JSON.stringify({ ...newConfig, answers }, null, JSON_INDENT_SPACES)}\n`);
+    s.stop(`Update complete: obsidianmd/obsidian-sample-plugin at ${snapshot.commit.slice(0, SHORT_SHA_LENGTH)}.`);
+    outro('Project updated successfully!');
+    return;
+  }
+
   // A project that has already released carries a `manifest.json` its own `npm run version` rewrote, so its
   // Hash no longer matches the recorded one and the updater skips it -- the freshly looked-up
   // `minAppVersion` only ever reaches a manifest nobody has touched.

package/templates/default/{parcel-transformer-inline-imports.cjs.ejs → (bundlers)/parcel-transformer-inline-imports.cjs.ejs}

@@ -6,7 +6,7 @@
  * new bundle root unconditionally, and has no option to inline one. The other bundlers each do:
  * rollup's `inlineDynamicImports`, vite's `rollupOptions.output.inlineDynamicImports`, webpack's
  * `asyncChunks: false`. This transformer is that option for Parcel, for the same reason
- * `parcel-resolver-obsidian.cjs` is its `external` list. obsidian-dev-utils is what needs it: it
+ * `parcel-resolver-obsidian.cjs` is its `external` list. obsidian-lib is what needs it: it
  * reaches its desktop-only modules through `await import(...)`.
  *
  * It runs before Parcel's own JavaScript transformer and rewrites `import('<literal>')` into a

package/templates/default/{CONTRIBUTING.md.ejs → (contributing)/CONTRIBUTING.md.ejs}

@@ -1,6 +1,7 @@
 # Contributing
 
 Contributions are welcome! Here's how to get started.
+<%- render('filing') -%>
 
 ## Prerequisites
 

package/templates/default/{CONTRIBUTING.md@demo-vault_dev-utils.ejs → (contributing)/CONTRIBUTING.md@demo-vault_framework.ejs}

@@ -7,7 +7,7 @@ When you add a user-facing feature, add or update its note in the same change.
 
 ### One-time setup before the button suite can run
 
-`npm run test:integration:demo-vault` opens a copy of `demo-vault/` in a real Obsidian and clicks every button in it. It needs the CodeScript Toolkit binary, which it copies out of your own `demo-vault/` to keep the run hermetic. Open `demo-vault/` in Obsidian once and let `demo-vault-helper` install CodeScript Toolkit; the installed copy is gitignored, so each machine does this for itself. Until then the suite fails with a message telling you exactly this.
+`npm run test:integration:demo-vault` opens a copy of `demo-vault/` in a real Obsidian and clicks every button in it. It needs the `CodeScript Toolkit` binary, which it copies out of your own `demo-vault/` to keep the run hermetic. Open `demo-vault/` in Obsidian once and let `demo-vault-helper` install `CodeScript Toolkit`; the installed copy is gitignored, so each machine does this for itself. Until then the suite fails with a message telling you exactly this.
 
 ### Checking the vault
 

package/templates/default/(contributing)/CONTRIBUTING.md@filing_bug-and-feature.ejs

@@ -0,0 +1,6 @@
+
+## Filing an issue (for AI agents and humans)
+
+Open issues through the [issue forms](https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/issues/new/choose), not as blank issues.
+
+Filing from the CLI or the API (`gh issue create --body`, or an AI agent filing for you) skips the form, and `gh issue create --template` cannot load an issue form. In that case, open the matching form in [`.github/ISSUE_TEMPLATE/`](https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/tree/HEAD/.github/ISSUE_TEMPLATE), copy every field as a `### <label>` heading in the form's order, and fill in each one. Always state the plugin version, the Obsidian version and your operating system.

package/templates/default/{.prettierignore.ejs → (format)/.prettierignore.ejs}

@@ -8,3 +8,4 @@ demo-vault
 
 # Markdown belongs to markdownlint.
 *.md
+<%- render('ignores') -%>

package/templates/default/(format)/.prettierignore@ignores_docs-showcase.ejs

@@ -0,0 +1,3 @@
+
+# The developer docs' code blocks, as the docs show them. See src/docs/README.md.
+src/docs

package/templates/default/(format)/biome.jsonc_framework.ejs

@@ -0,0 +1,16 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": ["./node_modules/@mnaoumov/typescript-dev-toolkit/assets/biome.json"],
+  "files": {
+    "includes": ["**", "!**/dist", "!**/coverage", "!**/node_modules", "!**/demo-vault", "!**/*-lock.json"<%- render('excludes') %>],
+  },
+  "linter": {
+    "rules": {
+      "complexity": {
+        // The shared ESLint config's `unicorn/class-reference-in-static-methods` asks for `this` in a static method,
+        // which this rule rejects. The sample code follows the shared config and the real plugins.
+        "noThisInStatic": "off",
+      },
+    },
+  },
+}

package/templates/default/(format)/biome.jsonc_framework@excludes_docs-showcase.ejs

@@ -0,0 +1 @@
+, "!src/docs"

package/templates/default/{biome.jsonc.ejs → (format)/biome.jsonc_standalone.ejs}

@@ -28,7 +28,7 @@
     }
   },
   "files": {
-    "includes": ["**", "!**/dist", "!**/node_modules", "!**/demo-vault", "!**/*-lock.json"]
+    "includes": ["**", "!**/dist", "!**/coverage", "!**/node_modules", "!**/demo-vault", "!**/*-lock.json"]
   },
   "overrides": [
     {

package/templates/default/(format)/dprint.json_framework.ejs

@@ -0,0 +1,10 @@
+{
+  "extends": "./node_modules/@mnaoumov/obsidian-dev-toolkit/dist/templates/dprint.json",
+  "excludes": [
+    "dist",
+    "**/node_modules",
+    "**/*-lock.json",
+    "**/*.md",
+    "demo-vault"<%- render('excludes') %>
+  ]
+}

package/templates/default/(format)/dprint.json_framework@excludes_docs-showcase.ejs

@@ -0,0 +1,2 @@
+,
+    "src/docs"

package/templates/default/{dprint.json_standalone.ejs → (format)/dprint.json_standalone.ejs}

@@ -6,6 +6,7 @@
     "exportDeclaration.forceMultiLine": "whenMultiple",
     "functionExpression.spaceAfterFunctionKeyword": true,
     "importDeclaration.forceMultiLine": "whenMultiple",
+    "jsx.quoteStyle": "preferDouble",
     "lineWidth": 1000,
     "quoteStyle": "alwaysSingle",
     "trailingCommas": "never"

package/templates/default/(format)/prettier.config.mjs_framework.ejs

@@ -0,0 +1,3 @@
+import { getPrettierConfig } from '@mnaoumov/typescript-dev-toolkit/formatters/prettier';
+
+export default { ...getPrettierConfig() };

package/templates/default/{cspell.json.ejs → (lint)/cspell.json.ejs}

@@ -2,6 +2,9 @@
   "version": "0.2",
   "ignorePaths": [
     "**/*.wasm",
+    ".create-obsidian-plugin.json",
+<%- render('ignore-paths') -%>
+    "coverage",
     "dist",
     "node_modules",
     "tsconfig.tsbuildinfo"
@@ -9,11 +12,14 @@
   "dictionaryDefinitions": [],
   "dictionaries": [],
   "words": [
-    <%- JSON.stringify(authorGitHubName) %>,
+<% _cspellIdentityWords.forEach((word) => { -%>
+    <%- JSON.stringify(word) %>,
+<% }); -%>
     "Invocables",
     "assemblyscript",
     "autoprefixer",
     "biomejs",
+    "churny",
     "codicon",
     "codemirror",
     "collab",
@@ -36,15 +42,18 @@
     "lintstagedrc",
     "lucide",
     "markdownlint",
-    "mnaoumov",
+    "nvmrc",
     "obsidianmd",
     "onload",
     "onunload",
     "postcss",
     "preact",
+    "rescanning",
+    "smol",
     "svelte",
     "tailwindcss",
     "tidelift",
+    "toolkits",
     "tsbuildinfo",
     "tseslint",
     "tslib",

package/templates/default/(lint)/cspell.json@ignore-paths_docs-showcase.ejs

@@ -0,0 +1 @@
+    "src/docs",

package/templates/default/{eslint.config.mts_standalone.ejs → (lint)/eslint.config.mts_standalone.ejs}

@@ -97,6 +97,15 @@ export default defineConfig(
       'obsidianmd/rule-custom-message': 'off'
     }
   },
+  {
+    files: typeScriptFiles,
+    rules: {
+      // The compiler already reports an undefined name, and `no-undef` cannot see ambient types and
+      // Globals a test framework declares (`describe`, `browser`, `WebdriverIO`), so typescript-eslint
+      // Advises turning it off for TypeScript.
+      'no-undef': 'off'
+    }
+  },
   {
     rules: {
       // `moment` is banned for bundle size, which does not apply here: Obsidian bundles it and

package/templates/default/{package.json@targets_parcel.ejs → (package)/package.json@targets_parcel-targets.ejs}

@@ -17,8 +17,6 @@
   false, which left every package a `require()` in `main.js` that nothing installs beside a plugin -- a
   build that exited 0 and a plugin that failed to load.
 
-  `packageExports` makes the resolver read package `exports`. Without it, a subpath such as
-  `svelte/internal/client` does not resolve once the package is bundled rather than required.
 -%>
   "targets": {
     "main": false,
@@ -31,6 +29,3 @@
       "sourceMap": false
     }
   },
-  "@parcel/resolver-default": {
-    "packageExports": true
-  },

package/templates/default/(package)/package.json@targets_parcel.ejs

@@ -0,0 +1,5 @@
+<%# `packageExports` makes the resolver read package `exports`. Without it, a subpath such as -%>
+<%# `svelte/internal/client` does not resolve once the package is bundled rather than required. -%>
+  "@parcel/resolver-default": {
+    "packageExports": true
+  },

package/templates/default/(readme)/README.md.ejs

@@ -0,0 +1,38 @@
+# <%= pluginName %>
+
+<%- _badges.join(' ') %>
+
+<%= pluginDescription %>
+<%- render('demo-vault') -%>
+
+## See also
+
+[My other Obsidian resources](https://github.com/mnaoumov/obsidian-resources)
+
+<!-- Before publishing, search the community plugin directory (https://community.obsidian.md/plugins) and GitHub for similar plugins. Replace the null form below with a table when candidates exist. Sort rows alphabetically by plugin display name; link listed plugins to the store and unlisted ones to their repository. Add (my plugin) or (maintained by me) after the link where applicable. -->
+<!-- Use these columns: Plugin | Features | How `<%= pluginName %>` differs. Keep cells short, with semicolon-separated fragments. Start each difference with the relationship to the other plugin, then what this one adds or omits. Use Supersedes for a retired or fully covered plugin, Extends for an active plugin it builds on, or a concrete relation such as Same goal as or Narrower than. -->
+<!-- Close a populated table with "Last searched for similar plugins on YYYY-MM-DD." When the search finds nothing, keep the sentence below and replace its date. The resources link stays first in either case. -->
+
+No similar plugin was found when this was last searched for, on YYYY-MM-DD.
+
+## Installation
+
+The plugin is not available in [the official Community Plugins repository](https://community.obsidian.md) yet.
+
+### Beta versions
+
+To install the latest beta release of this plugin (regardless if it is available in [the official Community Plugins repository](https://community.obsidian.md) or not), follow these steps:
+
+1. Ensure you have the [BRAT plugin](https://community.obsidian.md/plugins/obsidian42-brat) installed and enabled.
+2. Click [Install via BRAT](https://intradeus.github.io/http-protocol-redirector?r=obsidian://brat?plugin=https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>).
+3. An Obsidian pop-up window should appear. In the window, click the `Add plugin` button once and wait a few seconds for the plugin to install.
+<%- render('preset') -%>
+
+## Contributing
+
+Contributions are welcome — see [CONTRIBUTING](./CONTRIBUTING.md) to get set up.
+<%- render('support') -%>
+
+## License
+
+© [<%= authorName %>](https://github.com/<%= authorGitHubName %>/)

package/templates/default/{README.md@demo-vault_dev-utils.ejs → (readme)/README.md@demo-vault_framework.ejs}

@@ -7,6 +7,6 @@
 
 A copy of the vault ships with every release. You can access it via any of the following:
 
-1. Running the **<%= pluginName %>: Open demo vault** command.
+1. Running the **`<%- pluginName %>`: Open demo vault** command.
 2. Downloading `<%= pluginId %>-demo-vault.zip` from the [Releases](https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/releases). It unzips into a single `<%= pluginId %>-demo-vault-<version>` folder.
 3. Browsing its source in [`demo-vault/`](./demo-vault/README.md) in this repository.

package/templates/default/(readme)/README.md@preset_docs-showcase.ejs

@@ -0,0 +1,4 @@
+
+## Developer docs showcase
+
+Every code block of the [Obsidian developer docs](https://docs.obsidian.md) is a command of this plugin: open the command palette and type `Docs:`. [`src/docs/README.md`](./src/docs/README.md) lists every block, with its command or the reason it has none. Whatever a command shows, a Notice, a modal or a settings tab, links the docs page its code came from, and `Docs showcase: Open the docs page of a snippet` opens that page without running the snippet.

package/templates/default/(readme)/README.md@preset_framework.ejs

@@ -0,0 +1,6 @@
+
+## Debugging
+
+By default, debug messages for this plugin (id: `<%= pluginId %>`) are hidden.
+
+If you need to enable them refer to the [documentation](https://mnaoumov.dev/obsidian-lib/guides/debugging/).

package/templates/default/(readme)/README.md@support_bug-and-feature.ejs

@@ -0,0 +1,11 @@
+<% if (!_hasFunding) { -%>
+
+## Support
+<% } -%>
+
+### Filing an issue (for AI agents and humans)
+
+Open issues through the [issue forms](https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/issues/new/choose), not as blank issues.
+<%- render('bug-report') -%>
+
+Filing from the CLI or the API (`gh issue create --body`, or an AI agent filing for you) skips the form, and `gh issue create --template` cannot load an issue form. In that case, open the matching form in [`.github/ISSUE_TEMPLATE/`](https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/tree/HEAD/.github/ISSUE_TEMPLATE), copy every field as a `### <label>` heading in the form's order, and fill in each one. Always state the plugin version, the Obsidian version and your operating system.

package/templates/default/(readme)/README.md@support_bug-and-feature@bug-report_has-bug-report-command.ejs

@@ -0,0 +1,2 @@
+
+To report a bug from inside Obsidian, run the **`<%- pluginName %>`: Report a bug** command. It opens the bug form with the plugin version, the Obsidian version and your operating system already filled in.