@mnaoumov/create-obsidian-plugin 1.1.0 → 1.3.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@mnaoumov/create-obsidian-plugin",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Create Obsidian plugin from modern templates.",
-  "homepage": "https://github.com/mnaoumov/create-obsidian-plugin#readme",
+  "homepage": "https://mnaoumov.dev/create-obsidian-plugin/",
   "bugs": "https://github.com/mnaoumov/create-obsidian-plugin/issues",
   "repository": {
     "type": "git",
@@ -27,6 +27,9 @@
   "scripts": {
     "build": "jiti scripts/build.ts",
     "commit": "jiti scripts/commit.ts",
+    "docs:build": "jiti scripts/docs-build.ts",
+    "docs:dev": "jiti scripts/docs-dev.ts",
+    "docs:preview": "jiti scripts/docs-preview.ts",
     "format": "jiti scripts/format.ts",
     "format:check": "jiti scripts/format-check.ts",
     "gate:case": "jiti scripts/gate-one-case.ts",
@@ -52,27 +55,33 @@
   "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": {
-    "@clack/core": "^1.4.3",
-    "@clack/prompts": "^1.7.0",
+    "@clack/core": "^1.5.1",
+    "@clack/prompts": "^1.8.1",
     "ejs": "^6.0.1",
     "semver": "^7.8.5"
   },
   "devDependencies": {
+    "@astrojs/markdown-satteri": "^0.4.6",
+    "@astrojs/starlight": "^0.42.8",
     "@commitlint/cli": "^21.2.2",
     "@commitlint/config-conventional": "^21.2.2",
     "@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",
+    "@mnaoumov/typescript-dev-toolkit": "^5.2.0",
+    "@resvg/resvg-js": "^2.6.2",
     "@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": "^5.0.5",
+    "astro": "^7.4.4",
     "better-typescript-lib": "^2.12.0",
     "cspell": "^10.1.1",
     "czg": "^1.14.0",
@@ -86,6 +95,8 @@
     "husky": "^9.1.7",
     "ignore": "^7.0.12",
     "jiti": "^2.7.0",
+    "satori": "^0.33.5",
+    "satteri": "^0.10.5",
     "typescript": "6.0.3",
     "typescript-eslint": "^8.68.0",
     "vitest": "^5.0.5",

package/src/main.ts

@@ -26,8 +26,8 @@ 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';
 
@@ -37,22 +37,21 @@ 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 {
@@ -72,11 +71,12 @@ import {
   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,
@@ -95,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. */
@@ -416,7 +417,8 @@ async function offerAnswersExport(answers: Answers, customTemplate: string | und
       writeFileSync(join(process.cwd(), answersFileName), formatAnswersJson(answers));
       log.success(`Wrote ${answersFileName}`);
       const overlayFlag = customTemplate ? ` --customTemplate=${customTemplate}` : '';
-      note(`npm create @mnaoumov/obsidian-plugin -- --yes --mode=create --answersFile=${answersFileName}${overlayFlag}`, 'Non-interactive command');
+      // `"--"` is quoted so the command works pasted into PowerShell, which swallows a bare `--`, as well as cmd and sh.
+      note(`npm create @mnaoumov/obsidian-plugin "--" --yes --mode=create --answersFile=${answersFileName}${overlayFlag}`, 'Non-interactive command');
     }
 
     choice = await ask();

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)/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/{cspell.json.ejs → (lint)/cspell.json.ejs}

@@ -53,6 +53,7 @@
     "svelte",
     "tailwindcss",
     "tidelift",
+    "toolkits",
     "tsbuildinfo",
     "tseslint",
     "tslib",

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)/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.

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

@@ -1,6 +1,6 @@
 name: Bug report
 description: Report a bug and help improve the plugin
-title: "[BUG] Short description of the bug"
+title: "[BUG] Don't forget to write a meaningful title"
 labels: bug
 assignees: <%= authorGitHubName %>
 body:
@@ -8,6 +8,12 @@ body:
     attributes:
       value: |
         ## Bug report
+
+        > [!WARNING]
+        >
+        > Both a video and a sample vault are required for bug reproduction. Incomplete, vague, or poorly described bug reports will be closed.
+        >
+        > The bug report and all attachments (screenshots, videos, sample vaults) must be in English. Exception: the bug is directly related to non-English language usage. Non-English bug reports will be closed.
   - type: textarea
     attributes:
       label: Description
@@ -16,44 +22,82 @@ body:
       required: true
   - type: textarea
     attributes:
-      label: Steps to Reproduce
+      label: Steps to reproduce
       description: Provide a step-by-step description.
-      value: |
+      placeholder: |
         1. Go to '...'
         2. Click on '...'
         3. Notice that '...'
-        ...
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Expected Behavior
+      label: Expected behavior
       description: What did you expect to happen?
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Actual Behavior
+      label: Actual behavior
       description: What actually happened? Include error messages if available.
     validations:
       required: true
-  - type: textarea
+  - type: input
+    id: plugin-version
     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]
+      label: Plugin version
+      description: ⚠️ Must be the latest version. If not, explain why above.
+      placeholder: 1.0.0
     validations:
       required: true
+  - type: input
+    id: obsidian-version
+    attributes:
+      label: Obsidian version
+      description: ⚠️ Must be the latest version. If not, explain why above.
+      placeholder: 1.3.2
+    validations:
+      required: true
+  - type: input
+    id: operating-system
+    attributes:
+      label: Operating system
+      placeholder: Windows 10
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: The plugin's Report a bug command fills this in. You can leave it empty.
   - 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
+      description: Attach a video and a sample vault.
+      placeholder: Drag and drop files here.
+  - type: dropdown
+    attributes:
+      label: Video
+      options:
+        - "Not attached. ⚠️ The bug report will be closed if the maintainer is unable to reproduce it without the attachment."
+        - "Attached"
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Sample vault
+      options:
+        - "Not attached. ⚠️ The bug report will be closed if the maintainer is unable to reproduce it without the attachment."
+        - "Attached"
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Bug isolation
+      description: Did you verify the bug in isolation from other plugins?
+      options:
+        - "No, only with other plugins enabled (provide details in the description field). ⚠️ Sample vault required or the bug report will be closed."
+        - "Yes, I could reproduce the bug in the vault with only this plugin enabled."
     validations:
       required: true
   - type: checkboxes
@@ -61,11 +105,5 @@ body:
       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
+        - label: I have checked the plugin's GitHub repository and haven't found any similar bugs
           required: true

package/templates/default/scripts/{markdownlint-cli2-config.ts_standalone.ejs → (lint)/(markdown)/markdownlint-cli2-config.ts_standalone.ejs}

@@ -8,9 +8,9 @@ import relativeLinksRule from 'markdownlint-rule-relative-links';
  * nothing else can refer to -- and an intersection is exactly where a reader wants to look one up.
  */
 interface MarkdownlintCli2Extras {
-  customRules?: unknown[];
-  globs?: string[];
-  ignores?: string[];
+  readonly customRules?: unknown[];
+  readonly globs?: string[];
+  readonly ignores?: string[];
 }
 
 export const config: MarkdownlintCli2Extras & Options = {

package/templates/default/scripts/{vitest-config.ts@post-config_solid.ejs → (test)/vitest-config.ts@post-config_solid.ejs}

@@ -3,39 +3,37 @@
  * The config above, narrowed to the one field this file writes through.
  */
 interface ConfigWithProjects {
-  test: ProjectsSection;
+  readonly test: ProjectsSection;
 }
 
 /**
  * The shape of a project entry this file reaches into, which vitest's own union type does not narrow to.
  */
 interface JsxProject {
+  // eslint-disable-next-line typescript-dev-toolkit/readonly-interface-members -- The Solid test configuration assigns the JSX transform to each project.
   oxc?: OxcSection;
 }
 
 /**
  * The JSX transform a test project is given.
- *
- * Deliberately not named `…Options`: the shared lint config requires every member of a `Params` /
- * `Options` / `Result` interface to be `readonly`, and this one is assigned to.
  */
 interface JsxRuntimeSpec {
-  importSource: string;
-  runtime: string;
+  readonly importSource: string;
+  readonly runtime: string;
 }
 
 /**
  * The `oxc` section of a project entry.
  */
 interface OxcSection {
-  jsx: JsxRuntimeSpec;
+  readonly jsx: JsxRuntimeSpec;
 }
 
 /**
  * The `test` section of the config above.
  */
 interface ProjectsSection {
-  projects: JsxProject[];
+  readonly projects: JsxProject[];
 }
 
 /*

package/templates/default/scripts/version.ts_standalone.ejs

@@ -21,7 +21,7 @@ interface PackageJson {
 }
 
 interface PackageLockJson {
-  packages?: Record<string, { version?: string }>;
+  readonly packages?: Record<string, { version?: string }>;
   version?: string;
 }
 
@@ -74,14 +74,14 @@ function checkRepoClean(): void {
 }
 
 function runScript(name: string): void {
-  const pkg = JSON.parse(readFileSync('package.json', 'utf-8')) as { scripts?: Record<string, string> };
+  const pkg = JSON.parse(readFileSync('package.json', 'utf-8')) as { readonly scripts?: Record<string, string> };
   if (pkg.scripts?.[name]) {
     execSync(`npm run ${name}`, { stdio: 'inherit' });
   }
 }
 
 function runScriptOptional(name: string): void {
-  const pkg = JSON.parse(readFileSync('package.json', 'utf-8')) as { scripts?: Record<string, string> };
+  const pkg = JSON.parse(readFileSync('package.json', 'utf-8')) as { readonly scripts?: Record<string, string> };
   if (pkg.scripts?.[name]) {
     execSync(`npm run ${name}`, { stdio: 'inherit' });
   }
@@ -162,7 +162,7 @@ function updateVersionInFilesForPlugin(version: string): void {
     });
   } else {
     const response = fetchSync('https://api.github.com/repos/obsidianmd/obsidian-releases/releases/latest');
-    const latestObsidianVersion = (JSON.parse(response) as { name?: string }).name;
+    const latestObsidianVersion = (JSON.parse(response) as { readonly name?: string }).name;
 
     editJson<Manifest>('manifest.json', (m) => {
       if (latestObsidianVersion) {

package/templates/default/src/{plugin.ts_all-in-one.ejs → (plugin)/(all-in-one)/plugin.ts_all-in-one.ejs}

@@ -1,5 +1,6 @@
 import type { Editor } from 'obsidian';
 
+<%- render('bug-report-import') -%>
 import { OpenDemoVaultCommandHandler } from '@mnaoumov/obsidian-lib/command-handlers/open-demo-vault-command-handler';
 import { PluginSettingsTabComponent } from '@mnaoumov/obsidian-lib/components/plugin-settings-tab-component';
 import { PluginDataHandler } from '@mnaoumov/obsidian-lib/data-handler';
@@ -52,6 +53,7 @@ export class Plugin extends PluginBase {
     // A new window. It is not registered automatically -- a demo vault without this command can only be
     // Reached by downloading the asset by hand. It hides itself on mobile, so no platform guard is needed.
     await this.commandHandlerComponent.registerCommandHandlers(() => [
+<%- render('bug-report-handler') -%>
       new OpenDemoVaultCommandHandler({
         app: this.app,
         pluginId: this.manifest.id,

package/templates/default/src/(plugin)/(all-in-one)/plugin.ts_all-in-one@bug-report-handler_has-bug-report-command.ejs

@@ -0,0 +1,7 @@
+      // `OpenBugReportCommandHandler` opens the bug form in `.github/ISSUE_TEMPLATE/` with the plugin version, the
+      // Obsidian version and the operating system already filled in, which is why it is registered only with the forms.
+      new OpenBugReportCommandHandler({
+        app: this.app,
+        gitHubRepo: '<%- authorGitHubName %>/obsidian-<%- pluginId %>',
+        pluginId: this.manifest.id
+      }),

package/templates/default/src/(plugin)/(all-in-one)/plugin.ts_all-in-one@bug-report-import_has-bug-report-command.ejs

@@ -0,0 +1 @@
+import { OpenBugReportCommandHandler } from '@mnaoumov/obsidian-lib/command-handlers/open-bug-report-command-handler';

package/templates/default/src/{plugin.ts_demo.ejs → (plugin)/(demo)/plugin.ts_demo.ejs}

@@ -8,6 +8,7 @@ import type {
   TAbstractFile
 } from 'obsidian';
 
+<%- render('bug-report-import') -%>
 import { OpenDemoVaultCommandHandler } from '@mnaoumov/obsidian-lib/command-handlers/open-demo-vault-command-handler';
 import { PluginSettingsTabComponent } from '@mnaoumov/obsidian-lib/components/plugin-settings-tab-component';
 import { PluginDataHandler } from '@mnaoumov/obsidian-lib/data-handler';
@@ -132,6 +133,7 @@ export class Plugin extends PluginBase {
     // A new window. It is not registered automatically -- a demo vault without this command can only be
     // Reached by downloading the asset by hand. It hides itself on mobile, so no platform guard is needed.
     await this.commandHandlerComponent.registerCommandHandlers(() => [
+<%- render('bug-report-handler') -%>
       new OpenDemoVaultCommandHandler({
         app: this.app,
         pluginId: this.manifest.id,

package/templates/default/src/(plugin)/(demo)/plugin.ts_demo@bug-report-handler_has-bug-report-command.ejs

@@ -0,0 +1,7 @@
+      // `OpenBugReportCommandHandler` opens the bug form in `.github/ISSUE_TEMPLATE/` with the plugin version, the
+      // Obsidian version and the operating system already filled in, which is why it is registered only with the forms.
+      new OpenBugReportCommandHandler({
+        app: this.app,
+        gitHubRepo: '<%- authorGitHubName %>/obsidian-<%- pluginId %>',
+        pluginId: this.manifest.id
+      }),

package/templates/default/src/(plugin)/(demo)/plugin.ts_demo@bug-report-import_has-bug-report-command.ejs

@@ -0,0 +1 @@
+import { OpenBugReportCommandHandler } from '@mnaoumov/obsidian-lib/command-handlers/open-bug-report-command-handler';

package/templates/default/src/{plugin-settings-component.ts_demo.ejs → (settings)/plugin-settings-component.ts_demo.ejs}

@@ -21,7 +21,9 @@ interface PluginSettingsComponentConstructorParams {
 }
 
 interface SerializedSettings {
+  // eslint-disable-next-line typescript-dev-toolkit/readonly-interface-members -- The save hook replaces the typed setting with its serialized value.
   typedDropdownSetting: string;
+  // eslint-disable-next-line typescript-dev-toolkit/readonly-interface-members -- The save hook replaces the typed setting with its serialized value.
   typedMultipleDropdownSetting: string[];
 }
 

package/templates/default/src/{plugin-settings-tab.ts_demo.ejs → (settings)/plugin-settings-tab.ts_demo.ejs}

@@ -155,8 +155,8 @@ export class PluginSettingsTab extends PluginSettingsTabBase<PluginSettings> {
     new SettingEx(this.containerEl)
       .setName('Number setting name')
       .setDesc('Number setting description.')
-      .addNumber((number) => {
-        this.bind({ propertyName: 'numberSetting', valueComponent: number });
+      .addNumber((numberComponent) => {
+        this.bind({ propertyName: 'numberSetting', valueComponent: numberComponent });
       });
 
     new SettingEx(this.containerEl)

package/templates/default/src/lit-elements/sample-lit-element.ts.ejs

@@ -49,6 +49,6 @@ declare global {
   // Lit's own pattern for a custom element: it is what lets `createEl('sample-lit-element')` type-check,
   // And return a `SampleLitElement` whose properties can be set directly.
   interface HTMLElementTagNameMap {
-    'sample-lit-element': SampleLitElement;
+    readonly 'sample-lit-element': SampleLitElement;
   }
 }

package/templates/default/src/modals/sample-suggest-modal.ts.ejs

@@ -6,8 +6,8 @@ import {
 } from 'obsidian';
 
 interface SampleItem {
-  icon: string;
-  name: string;
+  readonly icon: string;
+  readonly name: string;
 }
 
 const SAMPLE_ITEMS: readonly SampleItem[] = [

package/templates/default/src/plugin.test.ts_jest.ejs

@@ -1,4 +1,6 @@
+<%- render('bug-report-type-import') -%>
 import { Plugin as ObsidianPlugin } from 'obsidian';
+<%- render('bug-report-import') -%>
 
 import { Plugin } from './plugin.ts';
 
@@ -6,4 +8,5 @@ describe('<%= pluginShortName %>', () => {
   it('extends the Obsidian Plugin class', () => {
     expect(Plugin.prototype).toBeInstanceOf(ObsidianPlugin);
   });
+<%- render('bug-report-test') -%>
 });

package/templates/default/src/plugin.test.ts_jest@bug-report-import_has-bug-report-command.ejs

@@ -0,0 +1,4 @@
+import {
+  App,
+  Plugin as PluginHost
+} from 'obsidian-test-mocks/obsidian';

package/templates/default/src/plugin.test.ts_jest@bug-report-test_has-bug-report-command.ejs

@@ -0,0 +1,16 @@
+
+  // The plugin's own `onload` runs here, so this proves the command is registered, not only imported.
+  it('registers the Report a bug command', async () => {
+    const manifest: PluginManifest = {
+      author: 'test',
+      description: 'test',
+      id: 'test-plugin',
+      minAppVersion: '0.0.0',
+      name: 'Test Plugin',
+      version: '0.0.0'
+    };
+    const plugin = new Plugin(App.createConfigured__().asOriginalType__(), manifest);
+    await plugin.onload();
+    expect(PluginHost.fromOriginalType2__(plugin).commands__.has('report-bug')).toBe(true);
+    plugin.unload();
+  });

package/templates/default/src/plugin.test.ts_jest@bug-report-type-import_has-bug-report-command.ejs

@@ -0,0 +1,2 @@
+import type { PluginManifest } from 'obsidian';
+

package/templates/default/src/plugin.test.ts_vitest.ejs

@@ -1,4 +1,6 @@
+<%- render('bug-report-type-import') -%>
 import { Plugin as ObsidianPlugin } from 'obsidian';
+<%- render('bug-report-import') -%>
 import {
   describe,
   expect,
@@ -11,4 +13,5 @@ describe('<%= pluginShortName %>', () => {
   it('extends the Obsidian Plugin class', () => {
     expect(Plugin.prototype).toBeInstanceOf(ObsidianPlugin);
   });
+<%- render('bug-report-test') -%>
 });

package/templates/default/src/plugin.test.ts_vitest@bug-report-import_has-bug-report-command.ejs

@@ -0,0 +1,4 @@
+import {
+  App,
+  Plugin as PluginHost
+} from 'obsidian-test-mocks/obsidian';