Merge branch 'reply2za-master'

mProjectsCode · mProjectsCode · commit 83b3ac7aa84b · 2024-11-26T12:25:36.000+01:00
diff --git a/automation/build/esbuild.config.ts b/automation/build/esbuild.config.ts
@@ -1,7 +1,6 @@
 import builtins from 'builtin-modules';
 import esbuild from 'esbuild';
 import esbuildSvelte from 'esbuild-svelte';
-import { sveltePreprocess } from 'svelte-preprocess';
 import { getBuildBanner } from 'build/buildBanner';
 
 const banner = getBuildBanner('Release Build', version => version);
diff --git a/automation/build/esbuild.dev.config.ts b/automation/build/esbuild.dev.config.ts
@@ -1,7 +1,6 @@
 import esbuild from 'esbuild';
 import copy from 'esbuild-plugin-copy-watch';
 import esbuildSvelte from 'esbuild-svelte';
-import { sveltePreprocess } from 'svelte-preprocess';
 import manifest from '../../manifest.json' assert { type: 'json' };
 import { getBuildBanner } from 'build/buildBanner';
 
diff --git a/automation/build/esbuild.publish.config.ts b/automation/build/esbuild.publish.config.ts
@@ -2,7 +2,6 @@ import builtins from 'builtin-modules';
 import esbuild from 'esbuild';
 import esbuildSvelte from 'esbuild-svelte';
 import process from 'process';
-import { sveltePreprocess } from 'svelte-preprocess';
 import { getBuildBanner } from 'build/buildBanner';
 
 const banner = getBuildBanner('Publish Release Build', version => `Publish Release Build (based on ${version})`);
diff --git a/automation/build/esbuild.publish.dev.config.ts b/automation/build/esbuild.publish.dev.config.ts
@@ -2,7 +2,6 @@ import builtins from 'builtin-modules';
 import esbuild from 'esbuild';
 import esbuildSvelte from 'esbuild-svelte';
 import process from 'process';
-import { sveltePreprocess } from 'svelte-preprocess';
 import { getBuildBanner } from 'build/buildBanner';
 
 const banner = getBuildBanner('Publish Dev Build', _ => `Publish Dev Build`);
diff --git a/exampleVault/Buttons/Button Example.md b/exampleVault/Buttons/Button Example.md
@@ -25,6 +25,16 @@ action:
   command: obsidian-meta-bind-plugin:open-playground
 ```
 
+Custom templater commands
+
+```meta-bind-button
+style: default
+label: "Run a templater file"
+actions:
+  - type: runTemplaterFile
+    templateFile: "templates/templater/Say Hello Command.md"
+```
+
 And custom JS buttons as well
 
 ```meta-bind-button
@@ -209,6 +219,7 @@ actions:
 
 ```
 
+
 ### Modifying Front-matter
 
 ```meta-bind-button
diff --git a/exampleVault/templates/templater/Say Hello Command.md b/exampleVault/templates/templater/Say Hello Command.md
@@ -0,0 +1,3 @@
+<%* 
+new Notice("Hello!");
+-%>
diff --git a/packages/core/src/config/ButtonConfig.ts b/packages/core/src/config/ButtonConfig.ts
@@ -26,6 +26,7 @@ export enum ButtonActionType {
 	INPUT = 'input',
 	SLEEP = 'sleep',
 	TEMPLATER_CREATE_NOTE = 'templaterCreateNote',
+	RUN_TEMPLATER_FILE = 'runTemplaterFile',
 	UPDATE_METADATA = 'updateMetadata',
 	CREATE_NOTE = 'createNote',
 	REPLACE_IN_NOTE = 'replaceInNote',
@@ -71,6 +72,11 @@ export interface TemplaterCreateNoteButtonAction {
 	openIfAlreadyExists?: boolean;
 }
 
+export interface RunTemplaterFileButtonAction {
+	type: ButtonActionType.RUN_TEMPLATER_FILE;
+	templateFile: string;
+}
+
 export interface UpdateMetadataButtonAction {
 	type: ButtonActionType.UPDATE_METADATA;
 	bindTarget: string;
@@ -132,7 +138,8 @@ export type ButtonAction =
 	| ReplaceSelfButtonAction
 	| RegexpReplaceInNoteButtonAction
 	| InsertIntoNoteButtonAction
-	| InlineJSButtonAction;
+	| InlineJSButtonAction
+	| RunTemplaterFileButtonAction;
 
 export interface ButtonConfig {
 	/**
@@ -228,4 +235,5 @@ export interface ButtonActionMap {
 	[ButtonActionType.REGEXP_REPLACE_IN_NOTE]: RegexpReplaceInNoteButtonAction;
 	[ButtonActionType.INSERT_INTO_NOTE]: InsertIntoNoteButtonAction;
 	[ButtonActionType.INLINE_JS]: InlineJSButtonAction;
+	[ButtonActionType.RUN_TEMPLATER_FILE]: RunTemplaterFileButtonAction;
 }
diff --git a/packages/core/src/config/validators/ButtonConfigValidators.ts b/packages/core/src/config/validators/ButtonConfigValidators.ts
@@ -11,6 +11,7 @@ import type {
 	RegexpReplaceInNoteButtonAction,
 	ReplaceInNoteButtonAction,
 	ReplaceSelfButtonAction,
+	RunTemplaterFileButtonAction,
 	SleepButtonAction,
 	TemplaterCreateNoteButtonAction,
 	UpdateMetadataButtonAction,
@@ -95,6 +96,14 @@ export const V_TemplaterCreateNoteButtonAction = schemaForType<TemplaterCreateNo
 		).optional(),
 	}),
 );
+
+export const V_RunTemplaterFileButtonAction = schemaForType<RunTemplaterFileButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.RUN_TEMPLATER_FILE),
+		templateFile: actionFieldString('runTemplaterFile', 'templateFile', 'template file path'),
+	}),
+);
+
 export const V_UpdateMetadataButtonAction = schemaForType<UpdateMetadataButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.UPDATE_METADATA),
@@ -187,6 +196,7 @@ export const V_ButtonAction = schemaForType<ButtonAction>()(
 		V_RegexpReplaceInNoteButtonAction,
 		V_InsertIntoNoteButtonAction,
 		V_InlineJSButtonAction,
+		V_RunTemplaterFileButtonAction,
 	]),
 );
 
diff --git a/packages/core/src/fields/button/ButtonActionRunner.ts b/packages/core/src/fields/button/ButtonActionRunner.ts
@@ -17,6 +17,7 @@ import { OpenButtonActionConfig } from 'packages/core/src/fields/button/actions/
 import { RegexpReplaceInNoteButtonActionConfig } from 'packages/core/src/fields/button/actions/RegexpReplaceInNoteButtonActionConfig';
 import { ReplaceInNoteButtonActionConfig } from 'packages/core/src/fields/button/actions/ReplaceInNoteButtonActionConfig';
 import { ReplaceSelfButtonActionConfig } from 'packages/core/src/fields/button/actions/ReplaceSelfButtonActionConfig';
+import { RunTemplaterFileButtonActionConfig } from 'packages/core/src/fields/button/actions/RunTemplaterFileButtonActionConfig';
 import { SleepButtonActionConfig } from 'packages/core/src/fields/button/actions/SleepButtonActionConfig';
 import { TemplaterCreateNoteButtonActionConfig } from 'packages/core/src/fields/button/actions/TemplaterCreateNoteButtonActionConfig';
 import { UpdateMetadataButtonActionConfig } from 'packages/core/src/fields/button/actions/UpdateMetadataButtonActionConfig';
@@ -49,6 +50,7 @@ export class ButtonActionRunner {
 			[ButtonActionType.REGEXP_REPLACE_IN_NOTE]: new RegexpReplaceInNoteButtonActionConfig(plugin),
 			[ButtonActionType.INSERT_INTO_NOTE]: new InsertIntoNoteButtonActionConfig(plugin),
 			[ButtonActionType.INLINE_JS]: new InlineJSButtonActionConfig(plugin),
+			[ButtonActionType.RUN_TEMPLATER_FILE]: new RunTemplaterFileButtonActionConfig(plugin),
 		};
 	}
 
diff --git a/packages/core/src/fields/button/actions/RunTemplaterFileButtonActionConfig.ts b/packages/core/src/fields/button/actions/RunTemplaterFileButtonActionConfig.ts
@@ -0,0 +1,37 @@
+import type {
+	ButtonClickContext,
+	ButtonConfig,
+	ButtonContext,
+	RunTemplaterFileButtonAction,
+} from 'packages/core/src/config/ButtonConfig';
+import { ButtonActionType } from 'packages/core/src/config/ButtonConfig';
+import { AbstractButtonActionConfig } from 'packages/core/src/fields/button/AbstractButtonActionConfig';
+import type { IPlugin } from 'packages/core/src/IPlugin';
+
+export class RunTemplaterFileButtonActionConfig extends AbstractButtonActionConfig<RunTemplaterFileButtonAction> {
+	constructor(plugin: IPlugin) {
+		super(ButtonActionType.RUN_TEMPLATER_FILE, plugin);
+	}
+
+	async run(
+		_config: ButtonConfig | undefined,
+		action: RunTemplaterFileButtonAction,
+		_filePath: string,
+		_context: ButtonContext,
+		_click: ButtonClickContext,
+	): Promise<void> {
+		const templateFilePath = this.plugin.api.buttonActionRunner.resolveFilePath(action.templateFile);
+		void (await this.plugin.internal.evaluateTemplaterTemplate(templateFilePath, templateFilePath));
+	}
+
+	create(): Required<RunTemplaterFileButtonAction> {
+		return {
+			type: ButtonActionType.RUN_TEMPLATER_FILE,
+			templateFile: '',
+		};
+	}
+
+	getActionLabel(): string {
+		return 'Run a templater file';
+	}
+}
diff --git a/packages/core/src/modals/modalContents/buttonBuilder/ButtonBuilderModalComponent.svelte b/packages/core/src/modals/modalContents/buttonBuilder/ButtonBuilderModalComponent.svelte
@@ -7,6 +7,7 @@
 	import type { ButtonBuilderModal } from 'packages/core/src/modals/modalContents/buttonBuilder/ButtonBuilderModal';
 	import CommandActionSettings from 'packages/core/src/modals/modalContents/buttonBuilder/CommandActionSettings.svelte';
 	import CreateNoteActionSettings from 'packages/core/src/modals/modalContents/buttonBuilder/CreateNoteActionSettings.svelte';
+	import RunTemplaterFileActionSettings from 'packages/core/src/modals/modalContents/buttonBuilder/RunTemplaterFileActionSettings.svelte';
 	import InlineJsActionSettings from 'packages/core/src/modals/modalContents/buttonBuilder/InlineJsActionSettings.svelte';
 	import InputActionSettings from 'packages/core/src/modals/modalContents/buttonBuilder/InputActionSettings.svelte';
 	import InsertIntoNoteActionSettings from 'packages/core/src/modals/modalContents/buttonBuilder/InsertIntoNoteActionSettings.svelte';
@@ -229,6 +230,10 @@ Add action of type
 		<CreateNoteActionSettings action={action} plugin={plugin}></CreateNoteActionSettings>
 	{/if}
 
+	{#if action.type === ButtonActionType.RUN_TEMPLATER_FILE}
+		<RunTemplaterFileActionSettings action={action} plugin={plugin}></RunTemplaterFileActionSettings>
+	{/if}
+
 	{#if action.type === ButtonActionType.REPLACE_IN_NOTE}
 		<ReplaceInNoteActionSettings action={action} plugin={plugin}></ReplaceInNoteActionSettings>
 	{/if}
diff --git a/packages/core/src/modals/modalContents/buttonBuilder/RunTemplaterFileActionSettings.svelte b/packages/core/src/modals/modalContents/buttonBuilder/RunTemplaterFileActionSettings.svelte
@@ -0,0 +1,20 @@
+<script lang="ts">
+	import type { RunTemplaterFileButtonAction } from 'packages/core/src/config/ButtonConfig';
+	import type { IPlugin } from 'packages/core/src/IPlugin';
+	import SettingComponent from 'packages/core/src/utils/components/SettingComponent.svelte';
+
+	const {
+		plugin,
+		action,
+	}: {
+		plugin: IPlugin;
+		action: RunTemplaterFileButtonAction;
+	} = $props();
+</script>
+
+<SettingComponent
+	name="File path: {action.templateFile || 'default'}"
+	description="The path from the vault to the templater file."
+>
+	<input type="text" bind:value={action.templateFile} placeholder="some path" />
+</SettingComponent>
diff --git a/tests/fields/Button.test.ts b/tests/fields/Button.test.ts
@@ -253,6 +253,16 @@ const buttonActionTests: Record<ButtonActionType, () => void> = {
 			}).not.toThrow();
 		});
 	},
+	[ButtonActionType.RUN_TEMPLATER_FILE]: () => {
+		test('does not throw', () => {
+			expect(async () => {
+				await simplifiedRunAction({
+					type: ButtonActionType.RUN_TEMPLATER_FILE,
+					templateFile: 'test',
+				});
+			}).not.toThrow();
+		});
+	},
 };
 
 describe('Button', () => {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<%*`
	`2`	`+new Notice("Hello!");`
	`3`	`+-%>`