npm - @mnaoumov/create-obsidian-plugin - Versions diffs - 1.1.0 → 1.3.0 - Mend

@@ -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();
+  });

@@ -16,7 +16,7 @@ const UNSET_APP: unknown = undefined;
 export const AppContext = createContext<App>(UNSET_APP as App);
 export interface SamplePreactComponentProps {
-  startCount: number;
+  readonly startCount: number;
 }
 export function SamplePreactComponent(props: SamplePreactComponentProps): JSX.Element {

@@ -16,7 +16,7 @@ const UNSET_APP: unknown = undefined;
 export const AppContext = createContext<App>(UNSET_APP as App);
 export interface SamplePreactComponentProps {
-  startCount: number;
+  readonly startCount: number;
 }
 export function SamplePreactComponent(props: SamplePreactComponentProps): JSX.Element {

@@ -4,7 +4,7 @@ import { useApp } from '@mnaoumov/obsidian-lib/react/app-context';
 import { useState } from 'react';
 export interface SampleReactComponentProps {
-  startCount: number;
+  readonly startCount: number;
 }
 export function SampleReactComponent(props: SampleReactComponentProps): JSX.Element {

@@ -16,7 +16,7 @@ const UNSET_APP: unknown = undefined;
 export const AppContext = createContext<App>(UNSET_APP as App);
 export interface SampleReactComponentProps {
-  startCount: number;
+  readonly startCount: number;
 }
 export function SampleReactComponent(props: SampleReactComponentProps): JSX.Element {

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

@@ -5,7 +5,7 @@
  * See available library css classes: https://github.com/mnaoumov/obsidian-lib/blob/main/src/css-class.ts
  */
-.<%= pluginId %>.obsidian-dev-utils {
+.<%= pluginId %>.obsidian-lib {
   /* Override library styles */
 }

@@ -1,7 +1,7 @@
 export interface SampleSvelteComponentExports {
-  increment: () => void;
+  readonly increment: () => void;
 }
 export interface SampleSvelteComponentProps {
-  startCount: number;
+  readonly startCount: number;
 }

@@ -1,3 +1,4 @@
+import { appendCodeBlock } from '@mnaoumov/obsidian-lib/html-element';
 import { ItemView } from 'obsidian';
 export const SAMPLE_VIEW_TYPE = '<%= pluginShortName %>-SampleView';
@@ -14,7 +15,7 @@ export class SampleView extends ItemView {
   public override onOpen(): Promise<void> {
     const container = this.contentEl;
     container.empty();
-    container.createEl('h4', { text: '<%= pluginName %>' });
+    appendCodeBlock(container.createEl('h4'), '<%= pluginName %>');
     const vaultName = this.app.vault.getName();
     container.createEl('p', { text: `Vault: ${vaultName}` });

@@ -101,8 +101,8 @@ export function registerDocsEntries(plugin: Plugin, entries: readonly DocsEntry[
       callback: async () => {
         const context = new HostContext(plugin, entry, editorExtensions, children);
         try {
-          const module = await entry.load();
-          await module.run(context);
+          const $module = await entry.load();
+          await $module.run(context);
         } catch (error) {
           console.error(`Docs snippet "${entry.name}" (${entry.source}) threw`, error);
           showDocsNotice(entry, `${entry.name} threw: ${error instanceof Error ? error.message : String(error)}. The developer console has the details.`);

@@ -1,28 +0,0 @@
-# <%= 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 %>/)

@@ -1,12 +0,0 @@
-## 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-lib/guides/debugging/).

@@ -1,5 +0,0 @@
-# Scratch note
-A note for [01 Sample commands](<../../01 Sample commands.md>) to write into, so the walkthrough has somewhere to run an editor command without touching anything you care about.
-It is gitignored: whatever the buttons leave here stays out of the repository.

@mnaoumov/create-obsidian-plugin 1.1.0 → 1.3.0