@delorenj/pjangler 1.5.11 → 1.5.12

package/templates/commonproject/template/{% if is_obsidian_plugin %}package.json{% endif %}.jinja

@@ -0,0 +1,28 @@
+{
+	"name": {{ project_slug | tojson }},
+	"version": "1.0.0",
+	"description": {{ plugin_description | tojson }},
+	"main": "main.js",
+	"type": "module",
+	"private": true,
+	"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": "UNLICENSED",
+	"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/commonproject/template/{% if is_obsidian_plugin %}src{% endif %}/main.ts.jinja

@@ -0,0 +1,105 @@
+import {
+	Editor,
+	MarkdownView,
+	MarkdownFileInfo,
+	Modal,
+	Notice,
+	Plugin,
+} from 'obsidian';
+import {
+	DEFAULT_SETTINGS,
+	{{ plugin_class }}Settings,
+	{{ plugin_class }}SettingTab,
+} from './settings';
+
+export default class {{ plugin_class }}Plugin extends Plugin {
+	settings!: {{ plugin_class }}Settings;
+
+	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 {{ plugin_class }}Modal(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 {{ plugin_class }}Modal(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 {{ plugin_class }}SettingTab(this.app, this));
+
+		// Register global DOM events, workspace events and intervals through
+		// this.registerDomEvent / this.registerEvent / this.registerInterval:
+		// Obsidian then removes them when the plugin is disabled.
+	}
+
+	onunload() {}
+
+	async loadSettings() {
+		this.settings = Object.assign(
+			{},
+			DEFAULT_SETTINGS,
+			(await this.loadData()) as Partial<{{ plugin_class }}Settings>,
+		);
+	}
+
+	async saveSettings() {
+		await this.saveData(this.settings);
+	}
+}
+
+class {{ plugin_class }}Modal extends Modal {
+	onOpen() {
+		const { contentEl } = this;
+		contentEl.setText('Woah!');
+	}
+
+	onClose() {
+		const { contentEl } = this;
+		contentEl.empty();
+	}
+}

package/templates/commonproject/template/{% if is_obsidian_plugin %}src{% endif %}/settings.ts.jinja

@@ -0,0 +1,38 @@
+import { App, PluginSettingTab, Setting } from 'obsidian';
+import {{ plugin_class }}Plugin from './main';
+
+export interface {{ plugin_class }}Settings {
+	exampleSetting: string;
+}
+
+export const DEFAULT_SETTINGS: {{ plugin_class }}Settings = {
+	exampleSetting: 'default',
+};
+
+export class {{ plugin_class }}SettingTab extends PluginSettingTab {
+	plugin: {{ plugin_class }}Plugin;
+
+	constructor(app: App, plugin: {{ plugin_class }}Plugin) {
+		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.exampleSetting)
+					.onChange(async (value) => {
+						this.plugin.settings.exampleSetting = value;
+						await this.plugin.saveSettings();
+					}),
+			);
+	}
+}

package/templates/commonproject/template/{% if is_obsidian_plugin %}styles.css{% endif %}

@@ -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/commonproject/template/{% if is_obsidian_plugin %}tsconfig.json{% endif %}

@@ -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/commonproject/template/{% if is_obsidian_plugin %}version-bump.mjs{% endif %}

@@ -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/commonproject/template/{% if is_obsidian_plugin %}versions.json{% endif %}

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