@mnaoumov/create-obsidian-plugin 1.0.2 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mnaoumov/create-obsidian-plugin",
-  "version": "1.0.2",
+  "version": "1.1.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",
@@ -60,12 +66,13 @@
     "@commitlint/types": "^21.2.0",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
     "@eslint/js": "^10.0.1",
+    "@mnaoumov/typescript-dev-toolkit": "^3.3.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 +84,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

@@ -29,6 +29,7 @@ import type {
 } from './answers.ts';
 import type { CliArgs } from './cli-args.ts';
 import type { Overlay } from './overlay.ts';
+import type { UpstreamSnapshot } from './upstream-snapshot.ts';
 
 import {
   formatAnswersJson,
@@ -53,10 +54,19 @@ import {
   validatePluginIdIsUnlisted
 } from './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
@@ -74,6 +84,10 @@ import {
   loadConfig,
   recordHashesOnDisk
 } from './templates.ts';
+import {
+  fetchUpstreamSnapshot,
+  readUpstream
+} from './upstream-snapshot.ts';
 import {
   fetchLatestObsidianVersion,
   fetchLatestVersion,
@@ -103,9 +117,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 +312,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 +437,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 +500,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 +610,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 +694,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 +717,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/.github/ISSUE_TEMPLATE/config.yml.ejs

@@ -1 +1,5 @@
 blank_issues_enabled: false
+contact_links:
+  - name: Questions and help
+    url: https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/discussions
+    about: Ask how to use the plugin or how to do something with it. Issues are for bug reports and feature requests.

package/templates/default/.github/workflows/attest-release-assets.yml.ejs

@@ -11,14 +11,4 @@ permissions:
 
 jobs:
   attest:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Download release assets
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: gh release download "${{ github.event.release.tag_name }}" --repo "${{ github.repository }}" --dir assets
-
-      - name: Generate artifact attestation
-        uses: actions/attest@v4
-        with:
-          subject-path: assets/*
+    uses: mnaoumov/obsidian-dev-toolkit/.github/workflows/obsidian-plugin-attest-release-assets.yml@<%= _toolkitWorkflowRef %>

package/templates/default/.github/workflows/ci.yml_framework.ejs

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+    branches: [<%= defaultBranch %>]
+  pull_request:
+    branches: [<%= defaultBranch %>]
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    # Installs the dependencies and runs `<%= packageManager %> run gate`.
+    uses: mnaoumov/obsidian-dev-toolkit/.github/workflows/obsidian-plugin-ci.yml@<%= _toolkitWorkflowRef %>
+<%- render('job-permissions') -%>
+    with:
+      package-manager: <%= packageManager %>
+<%- render('with') -%>

package/templates/default/.github/workflows/ci.yml_framework@job-permissions_measured-coverage-badge.ejs

@@ -0,0 +1,3 @@
+    # Publishing the coverage badge pushes it to the `badges` branch.
+    permissions:
+      contents: write

package/templates/default/.github/workflows/ci.yml_framework@with_measured-coverage-badge.ejs

@@ -0,0 +1 @@
+      coverage-badge: true

package/templates/default/.github/workflows/{ci.yml.ejs → ci.yml_standalone.ejs}

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v7
       - uses: actions/setup-node@v7
         with:
-          node-version: 24
+          node-version-file: .nvmrc
           cache: npm
       - run: npm ci
 <%- render('steps') -%>

package/templates/default/.github/workflows/release.yml_framework.ejs

@@ -0,0 +1,19 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+  id-token: write
+  attestations: write
+
+jobs:
+  release:
+    # Checks the tag is the manifest version, builds, archives `demo-vault/`, publishes the release and attests its
+    # Assets.
+    uses: mnaoumov/obsidian-dev-toolkit/.github/workflows/obsidian-plugin-release.yml@<%= _toolkitWorkflowRef %>
+    with:
+      package-manager: <%= packageManager %>

package/templates/default/.github/workflows/{release.yml.ejs → release.yml_standalone.ejs}

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v7
       - uses: actions/setup-node@v7
         with:
-          node-version: 24
+          node-version-file: .nvmrc
           cache: npm
       - run: npm ci
       - run: npm run build

package/templates/default/.gitignore_common.ejs

@@ -23,5 +23,6 @@ data.json
 
 # Build output
 dist
+coverage
 .env
 /tsconfig.tsbuildinfo

package/templates/default/.gitignore_wdio-obsidian.ejs

@@ -0,0 +1,2 @@
+# The Obsidian builds wdio-obsidian-service downloads for the end-to-end tests
+.obsidian-cache

package/templates/default/.nvmrc.ejs

@@ -0,0 +1 @@
+26

package/templates/default/.prettierignore.ejs

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

package/templates/default/.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/{CONTRIBUTING.md@demo-vault_dev-utils.ejs → 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/{README.md@demo-vault_dev-utils.ejs → 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.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.md@preset_dev-utils.ejs → README.md@preset_framework.ejs}

@@ -9,4 +9,4 @@ To show them, run the following command in the `DevTools Console`:
 window.DEBUG.enable('<%= pluginId %>');
 ```
 
-For more details, refer to the [documentation](https://mnaoumov.dev/obsidian-dev-utils/guides/debugging/).
+For more details, refer to the [documentation](https://mnaoumov.dev/obsidian-lib/guides/debugging/).

package/templates/default/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/biome.jsonc_framework@excludes_docs-showcase.ejs

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

package/templates/default/{biome.jsonc.ejs → 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/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,12 +42,14 @@
     "lintstagedrc",
     "lucide",
     "markdownlint",
-    "mnaoumov",
+    "nvmrc",
     "obsidianmd",
     "onload",
     "onunload",
     "postcss",
     "preact",
+    "rescanning",
+    "smol",
     "svelte",
     "tailwindcss",
     "tidelift",

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

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

package/templates/default/demo-vault/.gitignore.ejs

@@ -2,11 +2,11 @@
 .obsidian/workspace*.json
 .obsidian/hotkeys.json
 
-# Both plugins in this vault are injected at release time by obsidian-dev-utils: the freshly built plugin
-# Under test, and the obsidian-dev-utils-owned Demo Vault Helper, which installs, configures and enables
-# CodeScript Toolkit at runtime. Nothing plugin-related is committed.
+# Both plugins in this vault are injected at release time by obsidian-dev-toolkit: the freshly built plugin
+# Under test, and the obsidian-dev-toolkit-owned `Demo Vault Helper`, which installs, configures and enables
+# `CodeScript Toolkit` at runtime. Nothing plugin-related is committed.
 #
-# CodeScript Toolkit also lands here the first time you open this vault in Obsidian, which is where the
+# `CodeScript Toolkit` also lands here the first time you open this vault in Obsidian, which is where the
 # Demo-vault button suite picks it up from.
 .obsidian/plugins/*
 

package/templates/default/demo-vault/00 Start.md.ejs

@@ -15,7 +15,7 @@ caption: Run the Sample command
 require('/demoSetup.ts').runSampleCommand(app);
 ```
 
-A notice should have appeared in the top-right corner. That is the plugin's `Sample` command running — the same thing you get from **<%= pluginName %>: Sample** in the Command Palette (`Ctrl+P` / `Cmd+P`).
+A notice should have appeared in the top-right corner. That is the plugin's `Sample` command running — the same thing you get from **`<%- pluginName %>`: Sample** in the Command Palette (`Ctrl+P` / `Cmd+P`).
 
 Every button in this vault also states its **manual equivalent**, so you learn the real steps rather than depending on the buttons.
 

package/templates/default/demo-vault/01 Sample commands.md.ejs

@@ -1,6 +1,6 @@
 # Sample commands
 
-<%= pluginName %> adds the sample commands below to the Command Palette. They are the scaffolded samples the generator gives every new plugin — replace them with your own, and rewrite this note as you do.
+`<%- pluginName %>` adds the sample commands below to the Command Palette. They are the scaffolded samples the generator gives every new plugin — replace them with your own, and rewrite this note as you do.
 
 ## Sample
 
@@ -13,13 +13,13 @@ caption: Run Sample
 require('/demoSetup.ts').runSampleCommand(app);
 ```
 
-Manual equivalent: open the Command Palette (`Ctrl+P` / `Cmd+P`) and run **<%= pluginName %>: Sample**.
+Manual equivalent: open the Command Palette (`Ctrl+P` / `Cmd+P`) and run **`<%- pluginName %>`: Sample**.
 
 ## Sample editor
 
 An **editor** command: it only appears when a note is open for editing, and it acts on the cursor. This one inserts text where the cursor is.
 
-Editor commands need a live editor, and this vault opens notes in reading view — so the button below opens [Scratch note](<./Materials/01 Sample commands/Scratch note.md>) in Source mode first, puts the cursor at the end, and only then runs the command.
+Editor commands need a live editor, and this vault opens notes in reading view — so the button below opens the scratch note (`Materials/01 Sample commands/Scratch note.md`, created on first use) in Source mode first, puts the cursor at the end, and only then runs the command.
 
 ```code-button
 ---
@@ -28,7 +28,7 @@ caption: Run Sample editor on the scratch note
 await require('/demoSetup.ts').runSampleEditorCommandOnScratchNote(app);
 ```
 
-Manual equivalent: open `Scratch note`, switch it to Source mode (`Ctrl+E` / `Cmd+E`), place the cursor, and run **<%= pluginName %>: Sample editor**.
+Manual equivalent: open `Scratch note`, switch it to Source mode (`Ctrl+E` / `Cmd+E`), place the cursor, and run **`<%- pluginName %>`: Sample editor**.
 
 The scratch note is gitignored, so whatever you write in it stays out of your repository.
 

package/templates/default/demo-vault/02 Settings.md.ejs

@@ -1,8 +1,8 @@
 # Settings
 
-Every setting <%= pluginName %> stores, listed by the **key it is written under in `data.json`** rather than by its display label — that is what you see when you open the file, hit a sync conflict, or read a support thread.
+Every setting `<%- pluginName %>` stores, listed by the **key it is written under in `data.json`** rather than by its display label — that is what you see when you open the file, hit a sync conflict, or read a support thread.
 
-Find them in Obsidian under **Settings → Community plugins → <%= pluginName %>**.
+Find them in Obsidian under **Settings → Community plugins → `<%- pluginName %>`**.
 
 ## General
 

package/templates/default/demo-vault/03 WebAssembly.md.ejs

@@ -1,6 +1,6 @@
 # WebAssembly
 
-<%= pluginName %> ships a working WebAssembly module and a command that calls into it. WebAssembly is how a plugin uses code compiled from Rust, C, Go or AssemblyScript — and unlike a native Node binary it runs on mobile too, so it is the portable route.
+`<%- pluginName %>` ships a working WebAssembly module and a command that calls into it. WebAssembly is how a plugin uses code compiled from Rust, C, Go or AssemblyScript — and unlike a native Node binary it runs on mobile too, so it is the portable route.
 
 ```code-button
 ---
@@ -11,7 +11,7 @@ require('/demoSetup.ts').runSampleWasmAnswerCommand(app);
 
 A notice saying `WebAssembly says: 42` should have appeared. The number was not computed in JavaScript: the command loaded the module, called its exported `answer()` function, and showed what it returned.
 
-Manual equivalent: open the Command Palette (`Ctrl+P` / `Cmd+P`) and run **<%= pluginName %>: Sample WASM answer**.
+Manual equivalent: open the Command Palette (`Ctrl+P` / `Cmd+P`) and run **`<%- pluginName %>`: Sample WASM answer**.
 
 ## The module
 

package/templates/default/demo-vault/README.md.ejs

@@ -4,7 +4,7 @@ This is an [Obsidian](https://obsidian.md/) vault demonstrating features of the
 
 ## Opening this vault
 
-- **If you already have the plugin installed**, run the **<%= pluginName %>: Open demo vault** command — it downloads and opens the latest demo vault automatically.
+- **If you already have the plugin installed**, run the **`<%- pluginName %>`: Open demo vault** command — it downloads and opens the latest demo vault automatically.
 - **Otherwise**, download `<%= pluginId %>-demo-vault.zip` from the [plugin releases](https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>/releases), unzip it, and in Obsidian choose `Manage vaults...` → `Open folder as vault` → select the `<%= pluginId %>-demo-vault-<version>` folder it unzips into.
 
 On first open, Obsidian treats the vault as untrusted — choose **Trust author and enable plugins** (or enable Community plugins manually), then open [00 Start](<./00 Start.md>).

package/templates/default/demo-vault/_assets/CodeScriptToolkit/demoSetup.ts.ejs

@@ -3,11 +3,11 @@ import type {
   TFile
 } from 'obsidian';
 
+import { configureCommunityPlugin } from '@mnaoumov/obsidian-lib/community-plugins';
 import {
   MarkdownView,
   Notice
 } from 'obsidian';
-import { configureCommunityPlugin } from 'obsidian-dev-utils/obsidian/community-plugins';
 
 // Shared code for every `code-button` in this vault, so each note's button stays a one-liner instead of a
 // Block copy-pasted across notes.

package/templates/default/demo-vault/_assets/CodeScriptToolkit/startup.ts.ejs

@@ -1,13 +1,13 @@
-// Per-vault startup script, run by the universal Demo Vault Helper plugin (through CodeScript Toolkit's
-// `require`) once CodeScript Toolkit is installed and enabled. This is where a demo vault does its own
+// Per-vault startup script, run by the universal `Demo Vault Helper` plugin (through `CodeScript Toolkit`'s
+// `require`) once `CodeScript Toolkit` is installed and enabled. This is where a demo vault does its own
 // Startup setup. Here it just opens the landing note.
 
 import type { App } from 'obsidian';
 
 const START_NOTE_PATH = '00 Start.md';
 
-// CodeScript Toolkit calls the exported `invoke` on load (its `startupScriptPath` setting, which the Demo
-// Vault Helper points here). A top-level script with no `invoke` export throws
+// `CodeScript Toolkit` calls the exported `invoke` on load (its `startupScriptPath` setting, which the
+// `Demo Vault Helper` points here). A top-level script with no `invoke` export throws
 // `this.startupScript.invoke is not a function` the moment the vault loads.
 export async function invoke(app: App): Promise<void> {
   const startNote = app.vault.getFileByPath(START_NOTE_PATH);