O_O checklist - no js styles; atomic file operations

Author: mProjectsCode

exampleVault/Examples.md

@@ -1,5 +1,5 @@
 ---
-slider1: 7
+slider1: 8
 suggest: test
 toggle1: false
 Domestic_tasks:
@@ -13,7 +13,7 @@ inlineSelect: 1
 nested:
   object: test
 number1: 2
-number2: 14
+number2: 16
 time: 
 ---
 

packages/core/src/api/API.ts

@@ -145,7 +145,7 @@ export abstract class API<Plugin extends IPlugin> {
 			},
 		);
 
-		if (this.plugin.internal.isFilePathExcluded(filePath) && honorExcludedSetting) {
+		if (this.plugin.internal.file.isExcludedFromRendering(filePath) && honorExcludedSetting) {
 			return this.createExcludedMountable(filePath);
 		}
 
@@ -269,7 +269,7 @@ export abstract class API<Plugin extends IPlugin> {
 			},
 		);
 
-		if (this.plugin.internal.isFilePathExcluded(filePath) && honorExcludedSetting) {
+		if (this.plugin.internal.file.isExcludedFromRendering(filePath) && honorExcludedSetting) {
 			return this.createExcludedMountable(filePath);
 		}
 

packages/core/src/api/FileAPI.ts

@@ -0,0 +1,75 @@
+import type { IPlugin } from 'packages/core/src/IPlugin';
+
+export abstract class FileAPI<Plugin extends IPlugin> {
+	readonly plugin: Plugin;
+
+	constructor(plugin: Plugin) {
+		this.plugin = plugin;
+	}
+
+	public abstract read(filePath: string): Promise<string>;
+
+	public abstract write(filePath: string, content: string): Promise<void>;
+
+	// currently not used
+	// public abstract deleteFile(filePath: string): Promise<void>;
+
+	public abstract exists(filePath: string): Promise<boolean>;
+
+	public abstract atomicModify(filePath: string, modify: (content: string) => string): Promise<void>;
+
+	/**
+	 * Create a file in the given folder with the given name and extension.
+	 * If the name is already taken, a number will be appended to the name.
+	 *
+	 * @param folderPath the path to the folder
+	 * @param fileName the name of the file
+	 * @param extension the extension of the file
+	 * @param open
+	 *
+	 * @returns the path to the created file
+	 */
+	public abstract create(folderPath: string, fileName: string, extension: string, open?: boolean): Promise<string>;
+
+	/**
+	 * List all files by their path.
+	 */
+	public abstract getAllFiles(): string[];
+
+	/**
+	 * List all folders by their path.
+	 */
+	public abstract getAllFolders(): string[];
+
+	/**
+	 * Open a specific file.
+	 *
+	 * @param filePath
+	 * @param callingFilePath
+	 * @param newTab
+	 */
+	public abstract open(filePath: string, callingFilePath: string, newTab: boolean): void;
+
+	/**
+	 * Resolves a file name to a file path.
+	 *
+	 * @param name
+	 * @param relativeTo
+	 */
+	public abstract getPathByName(name: string, relativeTo?: string): string | undefined;
+
+	/**
+	 * Checks if a file path has been excluded in the settings.
+	 *
+	 * @param filePath
+	 */
+	public isExcludedFromRendering(filePath: string): boolean {
+		for (const excludedFolder of this.plugin.settings.excludedFolders) {
+			if (filePath.startsWith(excludedFolder)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+}

packages/core/src/api/InternalAPI.ts

@@ -1,5 +1,6 @@
 import type { Moment } from 'moment';
 import type { LifecycleHook } from 'packages/core/src/api/API';
+import type { FileAPI } from 'packages/core/src/api/FileAPI';
 import DatePickerInput from 'packages/core/src/fields/inputFields/fields/DatePicker/DatePicker.svelte';
 import type { DatePickerIPF } from 'packages/core/src/fields/inputFields/fields/DatePicker/DatePickerIPF';
 import type {
@@ -57,10 +58,12 @@ export interface TextPromptModalOptions extends ModalOptions {
 }
 
 export abstract class InternalAPI<Plugin extends IPlugin> {
-	plugin: Plugin;
+	readonly plugin: Plugin;
+	readonly file: FileAPI<Plugin>;
 
-	constructor(plugin: Plugin) {
+	constructor(plugin: Plugin, fileAPI: FileAPI<Plugin>) {
 		this.plugin = plugin;
+		this.file = fileAPI;
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -147,23 +150,6 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 	 */
 	abstract createJsRenderer(container: HTMLElement, filePath: string, code: string, hidden: boolean): IJsRenderer;
 
-	/**
-	 * Open a specific file.
-	 *
-	 * @param filePath
-	 * @param callingFilePath
-	 * @param newTab
-	 */
-	abstract openFile(filePath: string, callingFilePath: string, newTab: boolean): void;
-
-	/**
-	 * Resolves a file name to a file path.
-	 *
-	 * @param name
-	 * @param relativeTo
-	 */
-	abstract getFilePathByName(name: string, relativeTo?: string): string | undefined;
-
 	/**
 	 * Shows a notice to the user.
 	 *
@@ -190,16 +176,6 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 	 */
 	abstract imagePathToUri(imagePath: string): string;
 
-	/**
-	 * List all files by their path.
-	 */
-	abstract getAllFiles(): string[];
-
-	/**
-	 * List all folders by their path.
-	 */
-	abstract getAllFolders(): string[];
-
 	/**
 	 * List all commands.
 	 */
@@ -225,30 +201,6 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 	 */
 	abstract createFuzzySearch(): IFuzzySearch;
 
-	/**
-	 * Read a files content.
-	 *
-	 * @param filePath
-	 */
-	abstract readFilePath(filePath: string): Promise<string>;
-
-	abstract writeFilePath(filePath: string, content: string): Promise<void>;
-
-	/**
-	 * Create a file in the given folder with the given name and extension.
-	 * If the name is already taken, a number will be appended to the name.
-	 *
-	 * @param folderPath the path to the folder
-	 * @param fileName the name of the file
-	 * @param extension the extension of the file
-	 * @param open
-	 *
-	 * @returns the path to the created file
-	 */
-	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>;
@@ -381,19 +333,4 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 			},
 		});
 	}
-
-	/**
-	 * Checks if a file path has been excluded in the settings.
-	 *
-	 * @param filePath
-	 */
-	isFilePathExcluded(filePath: string): boolean {
-		for (const excludedFolder of this.plugin.settings.excludedFolders) {
-			if (filePath.startsWith(excludedFolder)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
 }

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

@@ -32,7 +32,7 @@ export class ButtonActionRunner {
 
 	resolveFilePath(filePath: string, relativeFilePath?: string | undefined): string {
 		const targetFilePath = MDLinkParser.isLink(filePath) ? MDLinkParser.parseLink(filePath).target : filePath;
-		const resolvedFilePath = this.plugin.internal.getFilePathByName(targetFilePath, relativeFilePath);
+		const resolvedFilePath = this.plugin.internal.file.getPathByName(targetFilePath, relativeFilePath);
 		if (resolvedFilePath === undefined) {
 			throw new MetaBindParsingError({
 				errorLevel: ErrorLevel.ERROR,
@@ -270,8 +270,8 @@ export class ButtonActionRunner {
 		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);
+			if (await this.plugin.internal.file.exists(filePath)) {
+				this.plugin.internal.file.open(filePath, '', false);
 				return;
 			}
 		}
@@ -316,39 +316,44 @@ export class ButtonActionRunner {
 		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);
+			if (await this.plugin.internal.file.exists(filePath)) {
+				this.plugin.internal.file.open(filePath, '', false);
 				return;
 			}
 		}
 
-		await this.plugin.internal.createFile(action.folderPath ?? '', action.fileName, 'md', action.openNote ?? false);
+		await this.plugin.internal.file.create(
+			action.folderPath ?? '',
+			action.fileName,
+			'md',
+			action.openNote ?? false,
+		);
 	}
 
 	async runReplaceInNoteAction(action: ReplaceInNoteButtonAction, filePath: string): Promise<void> {
 		if (action.fromLine > action.toLine) {
 			throw new Error('From line cannot be greater than to line');
 		}
 
-		const content = await this.plugin.internal.readFilePath(filePath);
-
-		let splitContent = content.split('\n');
-
-		if (action.fromLine < 0 || action.toLine > splitContent.length + 1) {
-			throw new Error('Line numbers out of bounds');
-		}
-
 		const replacement = action.templater
 			? await this.plugin.internal.evaluateTemplaterTemplate(this.resolveFilePath(action.replacement), filePath)
 			: action.replacement;
 
-		splitContent = [
-			...splitContent.slice(0, action.fromLine - 1),
-			replacement,
-			...splitContent.slice(action.toLine),
-		];
+		await this.plugin.internal.file.atomicModify(filePath, content => {
+			let splitContent = content.split('\n');
 
-		await this.plugin.internal.writeFilePath(filePath, splitContent.join('\n'));
+			if (action.fromLine < 0 || action.toLine > splitContent.length + 1) {
+				throw new Error('Line numbers out of bounds');
+			}
+
+			splitContent = [
+				...splitContent.slice(0, action.fromLine - 1),
+				replacement,
+				...splitContent.slice(action.toLine),
+			];
+
+			return splitContent.join('\n');
+		});
 	}
 
 	async runReplaceSelfAction(
@@ -368,59 +373,59 @@ export class ButtonActionRunner {
 			throw new Error('Position of the button in the note is invalid');
 		}
 
-		const content = await this.plugin.internal.readFilePath(filePath);
-
-		let splitContent = content.split('\n');
-
-		if (buttonContext.position.lineStart < 0 || buttonContext.position.lineEnd > splitContent.length + 1) {
-			throw new Error('Position of the button in the note is out of bounds');
-		}
+		const position = buttonContext.position;
 
 		const replacement = action.templater
 			? await this.plugin.internal.evaluateTemplaterTemplate(this.resolveFilePath(action.replacement), filePath)
 			: action.replacement;
 
-		splitContent = [
-			...splitContent.slice(0, buttonContext.position.lineStart),
-			replacement,
-			...splitContent.slice(buttonContext.position.lineEnd + 1),
-		];
+		await this.plugin.internal.file.atomicModify(filePath, content => {
+			let splitContent = content.split('\n');
 
-		await this.plugin.internal.writeFilePath(filePath, splitContent.join('\n'));
+			if (position.lineStart < 0 || position.lineEnd > splitContent.length + 1) {
+				throw new Error('Position of the button in the note is out of bounds');
+			}
+
+			splitContent = [
+				...splitContent.slice(0, position.lineStart),
+				replacement,
+				...splitContent.slice(position.lineEnd + 1),
+			];
+
+			return splitContent.join('\n');
+		});
 	}
 
 	async runRegexpReplaceInNoteAction(action: RegexpReplaceInNoteButtonAction, filePath: string): Promise<void> {
 		if (action.regexp === '') {
 			throw new Error('Regexp cannot be empty');
 		}
 
-		let content = await this.plugin.internal.readFilePath(filePath);
-
-		content = content.replace(new RegExp(action.regexp, action.regexpFlags ?? 'g'), action.replacement);
-
-		await this.plugin.internal.writeFilePath(filePath, content);
+		await this.plugin.internal.file.atomicModify(filePath, content => {
+			return content.replace(new RegExp(action.regexp, action.regexpFlags ?? 'g'), action.replacement);
+		});
 	}
 
 	async runInsertIntoNoteAction(action: InsertIntoNoteButtonAction, filePath: string): Promise<void> {
-		const content = await this.plugin.internal.readFilePath(filePath);
-
-		let splitContent = content.split('\n');
-
-		if (action.line < 1 || action.line > splitContent.length + 1) {
-			throw new Error('Line number out of bounds');
-		}
-
 		const insertString = action.templater
 			? await this.plugin.internal.evaluateTemplaterTemplate(this.resolveFilePath(action.value), filePath)
 			: action.value;
 
-		splitContent = [
-			...splitContent.slice(0, action.line - 1),
-			insertString,
-			...splitContent.slice(action.line - 1),
-		];
+		await this.plugin.internal.file.atomicModify(filePath, content => {
+			let splitContent = content.split('\n');
+
+			if (action.line < 1 || action.line > splitContent.length + 1) {
+				throw new Error('Line number out of bounds');
+			}
+
+			splitContent = [
+				...splitContent.slice(0, action.line - 1),
+				insertString,
+				...splitContent.slice(action.line - 1),
+			];
 
-		await this.plugin.internal.writeFilePath(filePath, splitContent.join('\n'));
+			return splitContent.join('\n');
+		});
 	}
 
 	async runInlineJsAction(