@mnaoumov/create-obsidian-plugin 0.0.0-stage → 1.0.1

package/templates/default/.gitattributes.ejs

@@ -0,0 +1,7 @@
+* text=auto eol=lf
+
+# Emitted for every project, not only the `wasm` answer, for the same reason `pnpm-workspace.yaml` is:
+# what a checkout may come to contain is not a property of the answers. `text=auto` above leaves a binary
+# to git's NUL-byte heuristic, and a `.wasm` that a line-ending conversion touches is corrupt in a way
+# nothing reports -- it stops being a module, and every bundler that reads it says so at build time.
+*.wasm binary

package/templates/default/.github/FUNDING.yml.ejs

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+<%= _fundingYmlKey %>: <%- _fundingYmlValue %>

package/templates/default/.github/ISSUE_TEMPLATE/bug_report.yml.ejs

@@ -0,0 +1,71 @@
+name: Bug report
+description: Report a bug and help improve the plugin
+title: "[BUG] Short description of the bug"
+labels: bug
+assignees: <%= authorGitHubName %>
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Bug report
+  - type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of the bug. Include any relevant details.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Provide a step-by-step description.
+      value: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Notice that '...'
+        ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Actual Behavior
+      description: What actually happened? Include error messages if available.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Environment Information
+      description: Environment Information
+      value: |
+        - **Plugin Version**: [e.g., 1.0.0]
+        - **Obsidian Version**: [e.g., v1.3.2]
+        - **Operating System**: [e.g., Windows 10]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Attachments
+      description: Required for bug reproduction
+      value: |
+        - Please attach a video showing the bug. It is not mandatory, but might be very helpful to speed up the bug fix
+        - Please attach a sample vault where the bug can be reproduced. It is not mandatory, but might be very helpful to speed up the bug fix
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Confirmations
+      description: Ensure the following conditions are met
+      options:
+        - label: I attached a video showing the bug, or it is not necessary
+          required: true
+        - label: I attached a sample vault where the bug can be reproduced, or it is not necessary
+          required: true
+        - label: I have tested the bug with the latest version of the plugin
+          required: true
+        - label: I have checked GitHub for existing bugs
+          required: true

package/templates/default/.github/ISSUE_TEMPLATE/config.yml.ejs

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/templates/default/.github/ISSUE_TEMPLATE/feature_request.yml.ejs

@@ -0,0 +1,61 @@
+name: Feature request
+description: Request a feature and help improve the plugin
+title: "[FR] Short description of the feature"
+labels: enhancement
+assignees: <%= authorGitHubName %>
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Feature Request
+  - type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of the feature request. Include any relevant details.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Details
+      description: Provide a step-by-step description.
+      value: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Notice that '...'
+        ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Desired Behavior
+      description: What do you want to happen?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: What actually happens?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Attachments
+      description: Required for feature investigation
+      value: |
+        - Please attach a video showing the current behavior. It is not mandatory, but might be very helpful to speed up the feature implementation
+        - Please attach a sample vault where the desired Feature Request could be applied. It is not mandatory, but might be very helpful to speed up the feature implementation
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Confirmations
+      description: Ensure the following conditions are met
+      options:
+        - label: I attached a video showing the current behavior, or it is not necessary
+          required: true
+        - label: I attached a sample vault where the desired Feature Request could be applied, or it is not necessary
+          required: true
+        - label: I have tested the absence of the requested feature with the latest version of the plugin
+          required: true
+        - label: I have checked GitHub for existing Feature Requests
+          required: true

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

@@ -0,0 +1,24 @@
+name: Attest Release Assets
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+  contents: read
+  attestations: write
+
+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/*

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

@@ -0,0 +1,20 @@
+name: CI
+
+on:
+  push:
+    branches: [<%= defaultBranch %>]
+  pull_request:
+    branches: [<%= defaultBranch %>]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 24
+          cache: npm
+      - run: npm ci
+<%- render('steps') -%>
+      - run: npm run build

package/templates/default/.github/workflows/ci.yml@steps_biome-linter.ejs

@@ -0,0 +1 @@
+      - run: npm run lint

package/templates/default/.github/workflows/ci.yml@steps_cspell.ejs

@@ -0,0 +1 @@
+      - run: npm run spellcheck

package/templates/default/.github/workflows/ci.yml@steps_dprint.ejs

@@ -0,0 +1 @@
+      - run: npm run format:check

package/templates/default/.github/workflows/ci.yml@steps_eslint.ejs

@@ -0,0 +1 @@
+      - run: npm run lint

package/templates/default/.github/workflows/ci.yml@steps_jest.ejs

@@ -0,0 +1 @@
+      - run: npm test

package/templates/default/.github/workflows/ci.yml@steps_markdownlint.ejs

@@ -0,0 +1 @@
+      - run: npm run lint:md

package/templates/default/.github/workflows/ci.yml@steps_prettier.ejs

@@ -0,0 +1 @@
+      - run: npm run format:check

package/templates/default/.github/workflows/ci.yml@steps_vitest.ejs

@@ -0,0 +1 @@
+      - run: npm test

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

@@ -0,0 +1,27 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 24
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+      - uses: softprops/action-gh-release@v3
+        with:
+          files: |
+            dist/build/main.js
+            dist/build/manifest.json
+            dist/build/styles.css

package/templates/default/.github/workflows/update-license-year.yml.ejs

@@ -0,0 +1,38 @@
+name: Update LICENSE Year
+
+# `obsidianmd/validate-license` compares the LICENSE copyright year against the current year at lint
+# time, so every repo it runs in turns red the moment the year rolls over. This bumps the end year on
+# 1 January so that never happens.
+
+on:
+  schedule:
+    - cron: '0 0 1 1 *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  update-year:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v6
+
+      - name: Bump the copyright end year
+        id: bump
+        run: |
+          YEAR="$(date -u +%Y)" perl -i -pe 's/^(\s*Copyright \([Cc]\) )(\d{4})(?:-\d{4})?( )/$1 . $2 . ($2 eq $ENV{YEAR} ? "" : "-$ENV{YEAR}") . $3/e' LICENSE
+          if git diff --quiet -- LICENSE; then
+            echo "changed=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Commit and push
+        if: steps.bump.outputs.changed == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git commit -m "chore: update LICENSE copyright year" -- LICENSE
+          git push

package/templates/default/.gitignore_common.ejs

@@ -0,0 +1,27 @@
+# vscode
+.vscode
+
+# Intellij
+*.iml
+.idea
+
+# npm
+node_modules
+
+# Don't include the compiled main.js file in the repo.
+# They should be uploaded to GitHub releases instead.
+main.js
+
+# Exclude sourcemaps
+*.map
+
+# obsidian
+data.json
+
+# Exclude macOS Finder (System Explorer) View States
+.DS_Store
+
+# Build output
+dist
+.env
+/tsconfig.tsbuildinfo

package/templates/default/.gitignore_scss.ejs

@@ -0,0 +1 @@
+styles.css

package/templates/default/.gitignore_tailwind.ejs

@@ -0,0 +1,3 @@
+
+# Compiled by `npm run build:styles` from src/styles/main.css
+src/styles/tailwind.generated.css

package/templates/default/.husky/commit-msg.ejs

@@ -0,0 +1 @@
+npx --no -- commitlint --edit "$1"

package/templates/default/.husky/pre-commit.ejs

@@ -0,0 +1 @@
+npx --no -- nano-staged

package/templates/default/.markdownlint-cli2.mjs.ejs

@@ -0,0 +1,4 @@
+import { createJiti } from 'jiti';
+const jiti = createJiti(import.meta.url);
+const { config } = await jiti.import('./scripts/markdownlint-cli2-config.ts');
+export default config;

package/templates/default/.nano-staged.mjs.ejs

@@ -0,0 +1,5 @@
+import { createJiti } from 'jiti';
+
+const jiti = createJiti(import.meta.url);
+const { config } = await jiti.import('./scripts/nano-staged-config.ts');
+export default config;

package/templates/default/.npmrc.ejs

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

package/templates/default/.parcelrc.ejs

@@ -0,0 +1,9 @@
+{
+  "extends": "@parcel/config-default",
+  "transformers": {
+<%- render('transformers') -%>
+    "*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}": ["./parcel-transformer-inline-imports.cjs", "..."]
+  },
+  "namers": ["./parcel-namer-obsidian.cjs", "..."],
+  "resolvers": ["./parcel-resolver-obsidian.cjs", "..."]
+}

package/templates/default/.parcelrc@transformers_svelte.ejs

@@ -0,0 +1 @@
+    "*.svelte": ["./parcel-transformer-svelte.cjs"],

package/templates/default/.prettierignore.ejs

@@ -0,0 +1,10 @@
+dist
+node_modules
+*-lock.json
+
+# The demo vault is documentation: its scripts show unusual module and `require` styles on purpose,
+# and its `.obsidian` files are compared byte-for-byte by the demo-vault coverage suite.
+demo-vault
+
+# Markdown belongs to markdownlint.
+*.md

package/templates/default/.typesafe-i18n.json.ejs

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://unpkg.com/typesafe-i18n/schema/typesafe-i18n.json",
+  "baseLocale": "en",
+  "adapter": "node"
+}

package/templates/default/CONTRIBUTING.md.ejs

@@ -0,0 +1,49 @@
+# Contributing
+
+Contributions are welcome! Here's how to get started.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) (latest LTS recommended)
+- npm (comes with Node.js)
+
+## Setup
+
+```bash
+git clone https://github.com/<%= authorGitHubName %>/obsidian-<%= pluginId %>.git
+cd obsidian-<%= pluginId %>
+npm install
+```
+
+## Development Workflow
+
+### Dev Mode
+
+```bash
+npm run dev
+```
+
+Copy `dist/main.js`, `dist/manifest.json`, and `dist/styles.css` to your vault's `.obsidian/plugins/<%= pluginId %>/` directory, or set the `OBSIDIAN_CONFIG_FOLDER` variable in `.env` to auto-copy on build.
+
+### Build
+
+```bash
+npm run build
+```
+
+### Available Scripts
+
+- `npm run dev` — Build in watch mode for development
+- `npm run build` — Production build
+- `npm run version` — Bump version and update `manifest.json` / `versions.json`
+<%- render('scripts') -%>
+<%- render('demo-vault') -%>
+
+## Configuration
+
+This project was scaffolded with [`create-obsidian-plugin`](https://github.com/mnaoumov/create-obsidian-plugin). Run `npx @mnaoumov/create-obsidian-plugin` again in the project directory to update configuration.
+
+## Pull Requests
+
+- Ensure the checks the project defines above still pass.
+- Use [Conventional Commits](https://www.conventionalcommits.org/) for your commit messages.

package/templates/default/CONTRIBUTING.md@demo-vault_dev-utils.ejs

@@ -0,0 +1,15 @@
+
+## Demo vault
+
+`demo-vault/` is this plugin's documentation: a real Obsidian vault whose notes explain each feature and demonstrate it with `code-button`s that run TypeScript through [CodeScript Toolkit](https://github.com/mnaoumov/obsidian-codescript-toolkit). `npm run version` archives it into the GitHub release, injecting the freshly built plugin and the `demo-vault-helper` bootstrap plugin into the archived copy — so nothing plugin-related is committed under `demo-vault/.obsidian/plugins/`.
+
+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.
+
+### Checking the vault
+
+- `npm run test:integration:no-app` — the coverage suite. Reads the notes without launching Obsidian and enforces the authoring rules: an `# H1` and a prose opener per note, Markdown links rather than wikilinks, no `[Docs]` line, every note reachable from `00 Start.md`.
+- `npm run test:integration:demo-vault` — the button suite. A button fails at click time, so this is the only gate that can catch a broken one.

package/templates/default/CONTRIBUTING.md@scripts_biome-formatter.ejs

@@ -0,0 +1 @@
+- `npm run format` — Format code

package/templates/default/CONTRIBUTING.md@scripts_biome-linter.ejs

@@ -0,0 +1 @@
+- `npm run lint` — Run linter

package/templates/default/CONTRIBUTING.md@scripts_conventional-commits.ejs

@@ -0,0 +1 @@
+- `npm run commit` — Commit with a guided Conventional Commits prompt

package/templates/default/CONTRIBUTING.md@scripts_cspell.ejs

@@ -0,0 +1 @@
+- `npm run spellcheck` — Check spelling

package/templates/default/CONTRIBUTING.md@scripts_dev-utils.ejs

@@ -0,0 +1 @@
+- `npm run gate` — Run every check the release runs (format, spelling, Markdown, build, lint, tests), before committing

package/templates/default/CONTRIBUTING.md@scripts_dprint.ejs

@@ -0,0 +1 @@
+- `npm run format` — Format code

package/templates/default/CONTRIBUTING.md@scripts_eslint.ejs

@@ -0,0 +1 @@
+- `npm run lint` — Run linter

package/templates/default/CONTRIBUTING.md@scripts_jest.ejs

@@ -0,0 +1 @@
+- `npm test` — Run tests (unit tests run against [`obsidian-test-mocks`](https://www.npmjs.com/package/obsidian-test-mocks); `.svelte` / `.vue` components are stubbed, so render them in an integration test instead)

package/templates/default/CONTRIBUTING.md@scripts_markdownlint.ejs

@@ -0,0 +1 @@
+- `npm run lint:md` — Lint Markdown files

package/templates/default/CONTRIBUTING.md@scripts_prettier.ejs

@@ -0,0 +1 @@
+- `npm run format` — Format code

package/templates/default/CONTRIBUTING.md@scripts_vitest.ejs

@@ -0,0 +1 @@
+- `npm test` — Run tests (unit tests run against [`obsidian-test-mocks`](https://www.npmjs.com/package/obsidian-test-mocks); `.svelte` / `.vue` components are stubbed, so render them in an integration test instead)

package/templates/default/LICENSE.ejs

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) <%= currentYear %> <%= authorName %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/default/README.md.ejs

@@ -0,0 +1,28 @@
+# <%= pluginName %>
+
+<%- _badges.join(' ') %>
+
+<%= pluginDescription %>
+<%- render('demo-vault') -%>
+
+## 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

@@ -0,0 +1,12 @@
+
+## Demo vault
+
+**The documentation is a demo vault.** Every feature has a note that explains what it does and why you would want it, with a button you can press to watch it happen.
+
+**[Start reading here](<./demo-vault/00 Start.md>)** — it is plain markdown, so it works on GitHub with nothing installed.
+
+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.
+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_dev-utils.ejs

@@ -0,0 +1,12 @@
+
+## Debugging
+
+By default, debug messages for this plugin are hidden.
+
+To show them, run the following command in the `DevTools Console`:
+
+```js
+window.DEBUG.enable('<%= pluginId %>');
+```
+
+For more details, refer to the [documentation](https://mnaoumov.dev/obsidian-dev-utils/guides/debugging/).

package/templates/default/README.md@support_has-funding.ejs

@@ -0,0 +1,8 @@
+
+## Support
+
+<!-- markdownlint-disable MD033 -->
+
+<a href="<%= fundingUrl %>" target="_blank">Support this plugin</a>
+
+<!-- markdownlint-enable MD033 -->

package/templates/default/babel.config.json.ejs

@@ -0,0 +1,8 @@
+<%# Parcel only, for Solid: its own JavaScript transformer compiles JSX as a React-style automatic runtime -%>
+<%# against `solid-js/jsx-runtime`, which exports no `jsx`, so Solid's JSX has to go through -%>
+<%# `babel-preset-solid` first. Parcel runs a project babel config ahead of its own transformer, which -%>
+<%# still strips the TypeScript. JSON rather than rollup's `babel.config.mjs` wrapper, because Parcel -%>
+<%# warns on every build that a JavaScript babel config can be neither watched nor cached. -%>
+{
+  "presets": ["babel-preset-solid"]
+}

package/templates/default/babel.config.mjs.ejs

@@ -0,0 +1,5 @@
+import { createJiti } from 'jiti';
+
+const jiti = createJiti(import.meta.url);
+const { config } = await jiti.import('./scripts/babel.config.ts');
+export default config;

package/templates/default/biome.jsonc.ejs

@@ -0,0 +1,47 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "preset": "recommended",
+      "complexity": {
+        // TypeScript's `noPropertyAccessFromIndexSignature` REQUIRES `process.env['BUILD']` and rejects
+        // the dotted form this rule asks for. The two tools disagree about the same line; the compiler
+        // wins, because its complaint is an error and this one is a preference.
+        "useLiteralKeys": "off"
+      }
+    }
+  },
+  "formatter": {
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingCommas": "none"
+    }
+  },
+  "json": {
+    "formatter": {
+      "trailingCommas": "none"
+    }
+  },
+  "files": {
+    "includes": ["**", "!**/dist", "!**/node_modules", "!**/demo-vault", "!**/*-lock.json"]
+  },
+  "overrides": [
+    {
+      // Biome reads a single-file component's `<script>` block but not its markup, so every binding the
+      // template uses looks unused to it.
+      "includes": ["**/*.svelte", "**/*.vue"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noUnusedVariables": "off"
+          }
+        }
+      }
+    }
+  ]
+}

package/templates/default/commitlint.config.ts.ejs

@@ -0,0 +1 @@
+export { config as default } from './scripts/commitlint-config.ts';