implement #405

Author: mProjectsCode

exampleVault/Buttons/Button Example.md

@@ -188,6 +188,7 @@ actions:
     folderPath: templates
     fileName: asdasd
     openNote: false
+    openIfAlreadyExists: true
 
 ```
 

packages/core/src/api/InternalAPI.ts

@@ -247,6 +247,8 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 	 */
 	abstract createFile(folderPath: string, fileName: string, extension: string, open?: boolean): Promise<string>;
 
+	abstract existsFilePath(filePath: string): Promise<boolean>;
+
 	abstract createContextMenu(items: ContextMenuItemDefinition[]): IContextMenu;
 
 	abstract evaluateTemplaterTemplate(templateFilePath: string, targetFilePath: string): Promise<string>;

packages/core/src/config/ButtonConfig.ts

@@ -56,6 +56,7 @@ export interface TemplaterCreateNoteButtonAction {
 	folderPath?: string;
 	fileName?: string;
 	openNote?: boolean;
+	openIfAlreadyExists?: boolean;
 }
 
 export interface UpdateMetadataButtonAction {
@@ -70,6 +71,7 @@ export interface CreateNoteButtonAction {
 	folderPath?: string;
 	fileName: string;
 	openNote?: boolean;
+	openIfAlreadyExists?: boolean;
 }
 
 export interface ReplaceInNoteButtonAction {

packages/core/src/config/ButtonConfigValidators.ts

@@ -88,6 +88,11 @@ export const V_TemplaterCreateNoteButtonAction = schemaForType<TemplaterCreateNo
 		folderPath: stringValidator('templaterCreateNote', 'folderPath', 'folder path').optional(),
 		fileName: stringValidator('templaterCreateNote', 'fileName', 'file name').optional(),
 		openNote: booleanValidator('templaterCreateNote', 'openNote', 'value for whether to open the note').optional(),
+		openIfAlreadyExists: booleanValidator(
+			'templaterCreateNote',
+			'openIfAlreadyExists',
+			'value for whether to open the note if it already exists',
+		).optional(),
 	}),
 );
 export const V_UpdateMetadataButtonAction = schemaForType<UpdateMetadataButtonAction>()(
@@ -112,6 +117,11 @@ export const V_CreateNoteButtonAction = schemaForType<CreateNoteButtonAction>()(
 		folderPath: stringValidator('createNote', 'folderPath', 'folder path').optional(),
 		fileName: stringValidator('createNote', 'fileName', 'file name'),
 		openNote: booleanValidator('createNote', 'openNote', 'value for whether to open the note').optional(),
+		openIfAlreadyExists: booleanValidator(
+			'createNote',
+			'openIfAlreadyExists',
+			'value for whether to open the note if it already exists',
+		).optional(),
 	}),
 );
 

packages/core/src/fields/button/ButtonActionRunner.ts

@@ -21,7 +21,7 @@ import type { IPlugin } from 'packages/core/src/IPlugin';
 import { MDLinkParser } from 'packages/core/src/parsers/MarkdownLinkParser';
 import { ErrorLevel, MetaBindJsError, MetaBindParsingError } from 'packages/core/src/utils/errors/MetaBindErrors';
 import { parseLiteral } from 'packages/core/src/utils/Literal';
-import { expectType } from 'packages/core/src/utils/Utils';
+import { ensureFileExtension, expectType, joinPath } from 'packages/core/src/utils/Utils';
 
 export class ButtonActionRunner {
 	plugin: IPlugin;
@@ -108,6 +108,7 @@ export class ButtonActionRunner {
 				folderPath: '/',
 				fileName: '',
 				openNote: true,
+				openIfAlreadyExists: false,
 			} satisfies TemplaterCreateNoteButtonAction;
 		} else if (type === ButtonActionType.UPDATE_METADATA) {
 			return {
@@ -122,6 +123,7 @@ export class ButtonActionRunner {
 				folderPath: '/',
 				fileName: 'Untitled',
 				openNote: true,
+				openIfAlreadyExists: false,
 			} satisfies CreateNoteButtonAction;
 		} else if (type === ButtonActionType.REPLACE_IN_NOTE) {
 			return {
@@ -265,6 +267,15 @@ export class ButtonActionRunner {
 	}
 
 	async runTemplaterCreateNoteAction(action: TemplaterCreateNoteButtonAction): Promise<void> {
+		if (action.openIfAlreadyExists && action.fileName) {
+			const filePath = ensureFileExtension(joinPath(action.folderPath ?? '', action.fileName), 'md');
+			// if the file already exists, open it in the same tab
+			if (await this.plugin.internal.existsFilePath(filePath)) {
+				this.plugin.internal.openFile(filePath, '', false);
+				return;
+			}
+		}
+
 		await this.plugin.internal.createNoteWithTemplater(
 			action.templateFile,
 			action.folderPath,
@@ -302,6 +313,15 @@ export class ButtonActionRunner {
 	}
 
 	async runCreateNoteAction(action: CreateNoteButtonAction): Promise<void> {
+		if (action.openIfAlreadyExists) {
+			const filePath = ensureFileExtension(joinPath(action.folderPath ?? '', action.fileName), 'md');
+			// if the file already exists, open it in the same tab
+			if (await this.plugin.internal.existsFilePath(filePath)) {
+				this.plugin.internal.openFile(filePath, '', false);
+				return;
+			}
+		}
+
 		await this.plugin.internal.createFile(action.folderPath ?? '', action.fileName, 'md', action.openNote ?? false);
 	}
 

packages/core/src/modals/modalContents/buttonBuilder/CreateNoteActionSettings.svelte

@@ -36,3 +36,10 @@
 <SettingComponent name="Open Note" description="Whether to open the new note after this action ran.">
 	<Toggle bind:checked={action.openNote}></Toggle>
 </SettingComponent>
+
+<SettingComponent
+	name="Open If Note Already Exists"
+	description="Whether to open the note instead of creating a new one if the note already exists."
+>
+	<Toggle bind:checked={action.openIfAlreadyExists}></Toggle>
+</SettingComponent>

packages/core/src/modals/modalContents/buttonBuilder/TemplaterCreateNoteActionSettings.svelte

@@ -57,3 +57,10 @@
 <SettingComponent name="Open Note" description="Whether to open the new note after this action ran.">
 	<Toggle bind:checked={action.openNote}></Toggle>
 </SettingComponent>
+
+<SettingComponent
+	name="Open If Note Already Exists"
+	description="Whether to open the note instead of creating a new one if the note already exists."
+>
+	<Toggle bind:checked={action.openIfAlreadyExists}></Toggle>
+</SettingComponent>

packages/core/src/utils/Utils.ts

@@ -313,3 +313,37 @@ export function getFolderPathFromFilePath(filePath: string): string {
 	}
 	return filePath.substring(0, pathSeparator);
 }
+
+/**
+ * Joins the given paths together without duplicate slashes.
+ */
+export function joinPath(...paths: string[]): string {
+	let result = paths[0];
+	for (let i = 1; i < paths.length; i++) {
+		const endsWithSlash = result.endsWith('/');
+		const startsWithSlash = paths[i].startsWith('/');
+
+		if (endsWithSlash && startsWithSlash) {
+			result = result.substring(0, result.length - 1);
+		} else if (!endsWithSlash && !startsWithSlash) {
+			result += '/';
+		}
+
+		result += paths[i];
+	}
+
+	return result;
+}
+
+/**
+ * Ensures that the file path has the given extension.
+ */
+export function ensureFileExtension(filePath: string, extension: string): string {
+	extension = extension.startsWith('.') ? extension : '.' + extension;
+
+	if (filePath.endsWith(extension)) {
+		return filePath;
+	}
+
+	return filePath + extension;
+}

packages/obsidian/src/ObsidianInternalAPI.ts

@@ -215,6 +215,10 @@ export class ObsidianInternalAPI extends InternalAPI<MetaBindPlugin> {
 		return this.app.vault.adapter.write(filePath, content);
 	}
 
+	public existsFilePath(filePath: string): Promise<boolean> {
+		return this.app.vault.adapter.exists(filePath);
+	}
+
 	public createContextMenu(items: ContextMenuItemDefinition[]): IContextMenu {
 		const menu = new ObsidianContextMenu();
 		menu.setItems(items);

packages/publish/src/PublishInternalAPI.ts

@@ -142,6 +142,10 @@ export class PublishInternalAPI extends InternalAPI<MetaBindPublishPlugin> {
 		return Promise.resolve('');
 	}
 
+	public existsFilePath(filePath: string): Promise<boolean> {
+		return Promise.resolve(this.getAllFiles().contains(filePath));
+	}
+
 	public createContextMenu(_items: ContextMenuItemDefinition[]): IContextMenu {
 		throw new Error('not implemented');
 	}