@mnaoumov/create-obsidian-plugin 1.0.1 → 1.1.0

package/templates/official-sample/files/package.json.vendored

@@ -0,0 +1,27 @@
+{
+	"name": "obsidian-sample-plugin",
+	"version": "1.0.0",
+	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+	"main": "main.js",
+	"type": "module",
+	"scripts": {
+		"dev": "node esbuild.config.mjs",
+		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
+		"version": "node version-bump.mjs && git add manifest.json versions.json",
+		"lint": "eslint ."
+	},
+	"keywords": [],
+	"license": "0-BSD",
+	"devDependencies": {
+		"@eslint/js": "^9.39.4",
+		"@types/node": "^22.15.17",
+		"esbuild": "0.25.5",
+		"eslint": "^9.39.4",
+		"eslint-plugin-obsidianmd": "^0.4.0",
+		"globals": "^17.6.0",
+		"jiti": "^2.6.1",
+		"obsidian": "latest",
+		"typescript": "^5.8.3",
+		"typescript-eslint": "^8.59.1"
+	}
+}

package/templates/official-sample/files/src/main.ts.vendored

@@ -0,0 +1,114 @@
+import {
+	Editor,
+	MarkdownView,
+	MarkdownFileInfo,
+	Modal,
+	Notice,
+	Plugin,
+} from 'obsidian';
+import {
+	DEFAULT_SETTINGS,
+	MyPluginSettings,
+	SampleSettingTab,
+} from './settings';
+
+// Remember to rename these classes and interfaces!
+
+export default class MyPlugin extends Plugin {
+	settings!: MyPluginSettings;
+
+	async onload() {
+		await this.loadSettings();
+
+		// This creates an icon in the left ribbon.
+		this.addRibbonIcon('dice', 'Sample', (_evt: MouseEvent) => {
+			// Called when the user clicks the icon.
+			new Notice('This is a notice!');
+		});
+
+		// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
+		const statusBarItemEl = this.addStatusBarItem();
+		statusBarItemEl.setText('Status bar text');
+
+		// This adds a simple command that can be triggered anywhere
+		this.addCommand({
+			id: 'open-modal-simple',
+			name: 'Open modal (simple)',
+			callback: () => {
+				new SampleModal(this.app).open();
+			},
+		});
+		// This adds an editor command that can perform some operation on the current editor instance
+		this.addCommand({
+			id: 'replace-selected',
+			name: 'Replace selected content',
+			editorCallback: (
+				editor: Editor,
+				_ctx: MarkdownView | MarkdownFileInfo,
+			) => {
+				editor.replaceSelection('Sample editor command');
+			},
+		});
+		// This adds a complex command that can check whether the current state of the app allows execution of the command
+		this.addCommand({
+			id: 'open-modal-complex',
+			name: 'Open modal (complex)',
+			checkCallback: (checking: boolean) => {
+				// Conditions to check
+				const markdownView =
+					this.app.workspace.getActiveViewOfType(MarkdownView);
+				if (markdownView) {
+					// If checking is true, we're simply "checking" if the command can be run.
+					// If checking is false, then we want to actually perform the operation.
+					if (!checking) {
+						new SampleModal(this.app).open();
+					}
+
+					// This command will only show up in Command Palette when the check function returns true
+					return true;
+				}
+				return false;
+			},
+		});
+
+		// This adds a settings tab so the user can configure various aspects of the plugin
+		this.addSettingTab(new SampleSettingTab(this.app, this));
+
+		// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
+		// Using this function will automatically remove the event listener when this plugin is disabled.
+		this.registerDomEvent(activeDocument, 'click', (_evt: MouseEvent) => {
+			new Notice('Click');
+		});
+
+		// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
+		this.registerInterval(
+			window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000),
+		);
+	}
+
+	onunload() {}
+
+	async loadSettings() {
+		this.settings = Object.assign(
+			{},
+			DEFAULT_SETTINGS,
+			(await this.loadData()) as Partial<MyPluginSettings>,
+		);
+	}
+
+	async saveSettings() {
+		await this.saveData(this.settings);
+	}
+}
+
+class SampleModal extends Modal {
+	onOpen() {
+		const { contentEl } = this;
+		contentEl.setText('Woah!');
+	}
+
+	onClose() {
+		const { contentEl } = this;
+		contentEl.empty();
+	}
+}

package/templates/official-sample/files/src/settings.ts.vendored

@@ -0,0 +1,38 @@
+import { App, PluginSettingTab, Setting } from 'obsidian';
+import MyPlugin from './main';
+
+export interface MyPluginSettings {
+	mySetting: string;
+}
+
+export const DEFAULT_SETTINGS: MyPluginSettings = {
+	mySetting: 'default',
+};
+
+export class SampleSettingTab extends PluginSettingTab {
+	plugin: MyPlugin;
+
+	constructor(app: App, plugin: MyPlugin) {
+		super(app, plugin);
+		this.plugin = plugin;
+	}
+
+	display(): void {
+		const { containerEl } = this;
+
+		containerEl.empty();
+
+		new Setting(containerEl)
+			.setName('Settings #1')
+			.setDesc("It's a secret")
+			.addText((text) =>
+				text
+					.setPlaceholder('Enter your secret')
+					.setValue(this.plugin.settings.mySetting)
+					.onChange(async (value) => {
+						this.plugin.settings.mySetting = value;
+						await this.plugin.saveSettings();
+					}),
+			);
+	}
+}

package/templates/official-sample/files/styles.css.vendored

@@ -0,0 +1,8 @@
+/*
+
+This CSS file will be included with your plugin, and
+available in the app when your plugin is enabled.
+
+If your plugin does not need CSS, delete this file.
+
+*/

package/templates/official-sample/files/tsconfig.json.vendored

@@ -0,0 +1,19 @@
+{
+	"compilerOptions": {
+		"inlineSourceMap": true,
+		"inlineSources": true,
+		"module": "ESNext",
+		"target": "ES2021",
+		"strict": true,
+		"noImplicitReturns": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedIndexedAccess": true,
+		"moduleResolution": "node",
+		"isolatedModules": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true,
+		"allowSyntheticDefaultImports": true,
+		"lib": ["ES2021", "DOM"]
+	},
+	"include": ["src/**/*.ts"]
+}

package/templates/official-sample/files/version-bump.mjs.vendored

@@ -0,0 +1,17 @@
+import { readFileSync, writeFileSync } from 'fs';
+
+const targetVersion = process.env.npm_package_version;
+
+// read minAppVersion from manifest.json and bump version to target version
+const manifest = JSON.parse(readFileSync('manifest.json', 'utf8'));
+const { minAppVersion } = manifest;
+manifest.version = targetVersion;
+writeFileSync('manifest.json', JSON.stringify(manifest, null, '\t'));
+
+// update versions.json with target version and minAppVersion from manifest.json
+// but only if the target version is not already in versions.json
+const versions = JSON.parse(readFileSync('versions.json', 'utf8'));
+if (!(targetVersion in versions)) {
+	versions[targetVersion] = minAppVersion;
+	writeFileSync('versions.json', JSON.stringify(versions, null, '\t'));
+}

package/templates/official-sample/files/versions.json.vendored

@@ -0,0 +1,3 @@
+{
+	"1.0.0": "1.0.0"
+}

package/upstreams.json

@@ -0,0 +1,35 @@
+{
+  "verify": "npm run lint && npm test",
+  "upstreams": [
+    {
+      "name": "obsidian-sample-plugin",
+      "repo": "obsidianmd/obsidian-sample-plugin",
+      "ref": "master",
+      "commit": "07ceb81d1fb3384af611ebf665a1ec42a7e5926d",
+      "paths": [
+        "**"
+      ],
+      "handler": "npm run sync:official-sample",
+      "verify": "npm run lint && npm test && npm run build && npm run verify:official-sample"
+    },
+    {
+      "name": "obsidian-developer-docs",
+      "repo": "obsidianmd/obsidian-developer-docs",
+      "ref": "main",
+      "commit": "1c26772ac13d6e9870c865936d389fdfe694e742",
+      "paths": [
+        "en/**/*.md",
+        "LICENSE"
+      ],
+      "handler": "npm run sync:docs-showcase",
+      "verify": "npm run lint && npm test && npm run gate:case -- preset=docs-showcase"
+    },
+    {
+      "name": "obsidian",
+      "npm": "obsidian",
+      "version": "1.14.4",
+      "handler": "npm run sync:obsidian",
+      "verify": "npm run lint && npm test && npm run gate:case -- preset=docs-showcase"
+    }
+  ]
+}

package/templates/default/dprint.json_dev-utils.ejs

@@ -1,10 +0,0 @@
-{
-  "extends": "./node_modules/obsidian-dev-utils/dist/templates/dprint.json",
-  "excludes": [
-    "dist",
-    "**/node_modules",
-    "**/*-lock.json",
-    "**/*.md",
-    "demo-vault"
-  ]
-}

package/templates/default/jest.config.ts@lint-root-dir_dev-utils.ejs

@@ -1 +0,0 @@
-        // eslint-disable-next-line unicorn/name-replacements -- `rootDir` is TypeScript's own compiler-option name.

package/templates/default/scripts/build.ts@bundler_cli-bundler@lint-build-styles_dev-utils.ejs

@@ -1 +0,0 @@
-// eslint-disable-next-line import-x/no-unassigned-import -- Importing the module RUNS the style build; there is nothing to bind.

package/templates/default/scripts/build.ts@bundler_esbuild@dev-utils-pre-build_tailwind.ejs

@@ -1,2 +0,0 @@
-<%- render('lint-build-styles') -%>
-import './build-styles.ts';

package/templates/default/scripts/build.ts@bundler_esbuild@lint-build-styles_dev-utils.ejs

@@ -1 +0,0 @@
-// eslint-disable-next-line import-x/no-unassigned-import -- Importing the module RUNS the style build; there is nothing to bind.

package/templates/default/scripts/build.ts@bundler_esbuild@preset_dev-utils.ejs

@@ -1,7 +0,0 @@
-import { build } from 'obsidian-dev-utils/script-utils/bundlers/esbuild';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-
-<%- render('dev-utils-pre-build') -%>
-import { customEsbuildPlugins } from './esbuild-plugins.ts';
-
-await wrapCliTask(() => build({ customEsbuildPlugins }));

package/templates/default/scripts/commit.ts_dev-utils.ejs

@@ -1,3 +0,0 @@
-import { exec } from 'obsidian-dev-utils/script-utils/exec';
-
-await exec('czg');

package/templates/default/scripts/dev.ts@bundler_esbuild@dev-utils-pre-build_tailwind.ejs

@@ -1,2 +0,0 @@
-<%- render('lint-build-styles') -%>
-import './build-styles.ts';

package/templates/default/scripts/dev.ts@bundler_esbuild@lint-build-styles_dev-utils.ejs

@@ -1 +0,0 @@
-// eslint-disable-next-line import-x/no-unassigned-import -- Importing the module RUNS the style build; there is nothing to bind.

package/templates/default/scripts/dev.ts@bundler_esbuild@preset_dev-utils.ejs

@@ -1,7 +0,0 @@
-import { dev } from 'obsidian-dev-utils/script-utils/bundlers/esbuild';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-
-<%- render('dev-utils-pre-build') -%>
-import { customEsbuildPlugins } from './esbuild-plugins.ts';
-
-await wrapCliTask(() => dev({ customEsbuildPlugins }));

package/templates/default/scripts/esbuild-plugins.ts.ejs

@@ -1,20 +0,0 @@
-import type { Plugin } from 'esbuild';
-<%- render('dev-utils-import') -%>
-
-/**
- * The esbuild plugins obsidian-dev-utils' own build does not already register.
- *
- * `build()` and `dev()` spread `customEsbuildPlugins` into their plugin list, which is the whole seam.
- * They ship a svelte wrapper and a sass plugin built in -- which is exactly why svelte and SCSS work on
- * these presets untouched -- but nothing for Vue, so `esbuild-plugin-vue3` was installed and never
- * wired in, and any project reaching a `.vue` file from its module graph failed with "No loader is
- * configured for `.vue` files".
- *
- * Shared by `build.ts` and `dev.ts` rather than written into each: one list, one place to add to.
- */
-<%# Each per-answer partial ends its entry with a comma so two of them concatenate into a valid list. -%>
-<%# The LAST one's comma is then a trailing comma, which the shared ESLint config rejects, so it is -%>
-<%# stripped here rather than by making every partial know whether it is last. -%>
-<%# With no entry at all the list is `[]` on one line, which is how the formatter writes an empty array. -%>
-<% const devUtilsPlugins = render('dev-utils-plugin').replace(/,(?<Trailing>\s*)$/, '$<Trailing>'); -%>
-export const customEsbuildPlugins: Plugin[] = [<%- devUtilsPlugins === '' ? '' : `\n${devUtilsPlugins}` -%>];

package/templates/default/scripts/esbuild-plugins.ts@dev-utils-import_vue.ejs

@@ -1,2 +0,0 @@
-
-import vuePlugin from 'esbuild-plugin-vue3';

package/templates/default/scripts/esbuild-plugins.ts@dev-utils-plugin_vue.ejs

@@ -1 +0,0 @@
-  vuePlugin(),

package/templates/default/scripts/esbuild-plugins.ts@dev-utils-plugin_wasm.ejs

@@ -1,13 +0,0 @@
-  // The obsidian-dev-utils `build()` owns the esbuild options, so the `.wasm` loader is set from inside a
-  // Plugin -- the one seam it exposes. Same decision as the standalone preset makes with a plain
-  // `loader` option, and for the same reason: `esbuild-plugin-wasm` emits a top-level `await`, which
-  // Esbuild supports only for `esm` output, and an Obsidian bundle is `cjs`.
-  {
-    name: 'wasm-binary-loader',
-    setup(build): void {
-      build.initialOptions.loader = {
-        ...build.initialOptions.loader,
-        '.wasm': 'binary'
-      };
-    }
-  },

package/templates/default/scripts/format-check.ts@tool_dprint@preset_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { format } from 'obsidian-dev-utils/script-utils/formatters/dprint';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => format({ paths, rewrite: false }));

package/templates/default/scripts/format.ts@tool_dprint@preset_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { format } from 'obsidian-dev-utils/script-utils/formatters/dprint';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => format({ paths }));

package/templates/default/scripts/lint-fix.ts@tool_eslint@preset_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { lint } from 'obsidian-dev-utils/script-utils/linters/eslint';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => lint({ paths, shouldFix: true }));

package/templates/default/scripts/lint-md-fix.ts_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { lint } from 'obsidian-dev-utils/script-utils/linters/markdownlint';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => lint({ paths, shouldFix: true }));

package/templates/default/scripts/lint-md.ts_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { lint } from 'obsidian-dev-utils/script-utils/linters/markdownlint';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => lint({ paths }));

package/templates/default/scripts/lint.ts@tool_eslint@preset_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { lint } from 'obsidian-dev-utils/script-utils/linters/eslint';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => lint({ paths }));

package/templates/default/scripts/prepare.ts_dev-utils.ejs

@@ -1,3 +0,0 @@
-import { execFromRoot } from 'obsidian-dev-utils/script-utils/root';
-
-await execFromRoot('husky');

package/templates/default/scripts/spellcheck.ts_dev-utils.ejs

@@ -1,7 +0,0 @@
-import process from 'node:process';
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { spellcheck } from 'obsidian-dev-utils/script-utils/linters/cspell';
-
-const [, , ...paths] = process.argv;
-
-await wrapCliTask(() => spellcheck({ paths }));

package/templates/default/scripts/test-watch.ts_dev-utils@tool_jest.ejs

@@ -1,13 +0,0 @@
-import { execSync } from 'node:child_process';
-import process from 'node:process';
-
-// Jest runs the suite as ESM (see `jest.config.ts`), and its ESM loader is built on `vm.SyntheticModule`,
-// which Node only exposes under `--experimental-vm-modules`. Without the flag every suite fails to load
-// with "Must use import to load ES Module". Appended so an inherited NODE_OPTIONS survives.
-const nodeOptions = `${process.env['NODE_OPTIONS'] ?? ''} --experimental-vm-modules`.trim();
-
-try {
-  execSync('jest --watch', { env: { ...process.env, NODE_OPTIONS: nodeOptions }, stdio: 'inherit' });
-} catch {
-  process.exit(1);
-}

package/templates/default/scripts/test-watch.ts_dev-utils@tool_vitest.ejs

@@ -1,8 +0,0 @@
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { testWatch } from 'obsidian-dev-utils/script-utils/test-runners/vitest';
-
-await wrapCliTask(() =>
-  testWatch({
-    projects: ['unit-tests']
-  })
-);

package/templates/default/scripts/test.ts_dev-utils@tool_jest.ejs

@@ -1,13 +0,0 @@
-import { execSync } from 'node:child_process';
-import process from 'node:process';
-
-// Jest runs the suite as ESM (see `jest.config.ts`), and its ESM loader is built on `vm.SyntheticModule`,
-// which Node only exposes under `--experimental-vm-modules`. Without the flag every suite fails to load
-// with "Must use import to load ES Module". Appended so an inherited NODE_OPTIONS survives.
-const nodeOptions = `${process.env['NODE_OPTIONS'] ?? ''} --experimental-vm-modules`.trim();
-
-try {
-  execSync('jest', { env: { ...process.env, NODE_OPTIONS: nodeOptions }, stdio: 'inherit' });
-} catch {
-  process.exit(1);
-}

package/templates/default/scripts/test.ts_dev-utils@tool_vitest.ejs

@@ -1,8 +0,0 @@
-import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';
-import { test } from 'obsidian-dev-utils/script-utils/test-runners/vitest';
-
-await wrapCliTask(() =>
-  test({
-    projects: ['unit-tests']
-  })
-);

package/templates/default/scripts/vite.config.ts@lint-empty-out-dir_dev-utils.ejs

@@ -1 +0,0 @@
-    // eslint-disable-next-line unicorn/name-replacements -- `emptyOutDir` is vite's own option name.

package/templates/default/scripts/vite.config.ts@lint-out-dir_dev-utils.ejs

@@ -1 +0,0 @@
-    // eslint-disable-next-line unicorn/name-replacements -- `outDir` is vite's own option name.

package/templates/default/scripts/webpack.config.ts@lint-webpack-default_dev-utils.ejs

@@ -1 +0,0 @@
-// eslint-disable-next-line import-x/no-named-as-default -- The default export IS the `webpack` namespace; the same name is the point.

package/templates/default/src/main.ts@import_css-modules.ejs

@@ -1 +0,0 @@
-import './styles/main.module.css'; // Do not delete this line if you want to have a styles.css file in your build output.

package/templates/default/src/views/sample-preact-view.tsx_dev-utils.ejs

@@ -1,45 +0,0 @@
-import { ItemView } from 'obsidian';
-// eslint-disable-next-line import-x/no-deprecated -- Only the third `replaceNode` parameter is deprecated; the two-argument form this file uses is not.
-import { render } from 'preact';
-
-import type { SamplePreactComponentProps } from '../preact-components/sample-preact-component.tsx';
-
-import {
-  AppContext,
-  SamplePreactComponent
-} from '../preact-components/sample-preact-component.tsx';
-
-export const SAMPLE_PREACT_VIEW_TYPE = '<%= pluginId %>-SamplePreactView';
-
-export class SamplePreactView extends ItemView {
-  public override getDisplayText(): string {
-    return 'Sample Preact view';
-  }
-
-  public override getViewType(): string {
-    return SAMPLE_PREACT_VIEW_TYPE;
-  }
-
-  public override onClose(): Promise<void> {
-    // eslint-disable-next-line import-x/no-deprecated -- See the import: the two-argument form is not deprecated.
-    render(null, this.contentEl);
-    return super.onClose();
-  }
-
-  public override onOpen(): Promise<void> {
-    const START_COUNT = 10;
-    const props: SamplePreactComponentProps = {
-      startCount: START_COUNT
-    };
-
-    // eslint-disable-next-line import-x/no-deprecated -- See the import: the two-argument form is not deprecated.
-    render(
-      <AppContext.Provider value={this.app}>
-        <SamplePreactComponent {...props} />
-      </AppContext.Provider>,
-      this.contentEl
-    );
-
-    return super.onOpen();
-  }
-}

package/templates/default/tsconfig.json_dev-utils@compiler-options_preact.ejs

@@ -1,2 +0,0 @@
-    "jsx": "react-jsx",
-    "jsxImportSource": "preact",

package/templates/default/tsconfig.json_dev-utils@compiler-options_react.ejs

@@ -1 +0,0 @@
-    "jsx": "react-jsx",

package/templates/default/tsconfig.json_dev-utils@compiler-options_solid.ejs

@@ -1,2 +0,0 @@
-    "jsx": "preserve",
-    "jsxImportSource": "solid-js",