PR feedback for merging frontmatter properties when inserting a template

refs: #1600, #1218, #1387

Author: Zachatoo

src/core/Templater.ts

@@ -4,6 +4,7 @@ import {
     MarkdownPostProcessorContext,
     MarkdownView,
     normalizePath,
+    stringifyYaml,
     TAbstractFile,
     TFile,
     TFolder,
@@ -14,7 +15,8 @@ import {
     get_active_file,
     get_folder_path_from_file_path,
     resolve_tfile,
-    merge_front_matter,
+    get_frontmatter_and_content,
+    merge_objects,
 } from "utils/Utils";
 import TemplaterPlugin from "main";
 import {
@@ -24,7 +26,6 @@ import {
 import { errorWrapper, errorWrapperSync, TemplaterError } from "utils/Error";
 import { Parser } from "./parser/Parser";
 import { log_error } from "utils/Log";
-import * as yaml from "js-yaml";
 
 export enum RunMode {
     CreateNewFromTemplate,
@@ -257,21 +258,23 @@ export class Templater {
             return;
         }
 
-        const front_matter_info = getFrontMatterInfo(output_content);
-        const frontmatter = yaml.load(front_matter_info.frontmatter);
-        await merge_front_matter(
-            this.plugin.app,
-            active_editor.file,
-            frontmatter
-        );
+        const { content, frontmatter } =
+            get_frontmatter_and_content(output_content);
 
         const editor = active_editor.editor;
         const doc = editor.getDoc();
         const oldSelections = doc.listSelections();
-        doc.replaceSelection(
-            output_content.slice(front_matter_info.contentStart)
-        );
+        doc.replaceSelection(content);
         if (active_view) {
+            // Merge frontmatter
+            if (
+                Object.keys(frontmatter).length > 0 &&
+                active_view instanceof MarkdownView &&
+                typeof active_view.metadataEditor?.insertProperties ===
+                    "function"
+            ) {
+                active_view.metadataEditor.insertProperties(frontmatter);
+            }
             // Wait for view to finish rendering properties widget
             await delay(100);
             // Save the file to ensure modifications saved to disk by the time `on_all_templates_executed` callback is executed
@@ -316,29 +319,22 @@ export class Templater {
             return;
         }
 
-        let existing_front_matter = null;
-        await delay(100); // Sometimes the front matter is not yet available if the file was just created
-        await this.plugin.app.fileManager.processFrontMatter(
-            file,
-            (front_matter) => {
-                existing_front_matter = front_matter;
+        const {
+            content: output_content_body,
+            frontmatter: output_frontmatter,
+        } = get_frontmatter_and_content(output_content);
+
+        await this.plugin.app.vault.process(file, (data) => {
+            let result = "";
+            const { content, frontmatter } = get_frontmatter_and_content(data);
+            merge_objects(frontmatter, output_frontmatter);
+            if (Object.keys(frontmatter).length > 0) {
+                result += `---\n${stringifyYaml(frontmatter)}---\n`;
             }
-        );
-
-        const front_matter_info = getFrontMatterInfo(output_content);
-        const frontmatter = yaml.load(front_matter_info.frontmatter);
-
-        if (existing_front_matter) {
-            // Bases can create frontmatter, merge this into the template frontmatter
-            await merge_front_matter(this.plugin.app, file, frontmatter);
-            await this.plugin.app.vault.append(
-                file,
-                output_content.slice(front_matter_info.contentStart)
-            );
-            output_content = await this.plugin.app.vault.read(file);
-        } else {
-            await this.plugin.app.vault.modify(file, output_content);
-        }
+            result += content + output_content_body;
+            output_content = result;
+            return result;
+        });
         // Set cursor to first line of editor (below properties)
         // https://github.com/SilentVoid13/Templater/issues/1231
         if (

src/core/functions/internal_functions/file/InternalModuleFile.ts

@@ -1,10 +1,8 @@
 import { InternalModule } from "../InternalModule";
 import { log_error } from "utils/Log";
-import * as yaml from "js-yaml";
 import {
     FileSystemAdapter,
     getAllTags,
-    getFrontMatterInfo,
     moment,
     normalizePath,
     parseLinktext,
@@ -15,7 +13,6 @@ import {
 } from "obsidian";
 import { TemplaterError } from "utils/Error";
 import { ModuleName } from "editor/TpDocumentation";
-import { merge_front_matter } from "utils/Utils";
 
 export const DEPTH_LIMIT = 10;
 
@@ -213,20 +210,14 @@ export class InternalModuleFile extends InternalModule {
                 }
             }
 
-            const active_file = this.plugin.app.workspace.getActiveFile();
-
             try {
                 const parsed_content =
                     await this.plugin.templater.parser.parse_commands(
                         inc_file_content,
                         this.plugin.templater.current_functions_object
                     );
-                const front_matter_info = getFrontMatterInfo(parsed_content);
-                const frontmatter = yaml.load(front_matter_info.frontmatter);
-                await merge_front_matter(this.plugin.app, active_file, frontmatter);
-
                 this.include_depth -= 1;
-                return parsed_content.slice(front_matter_info.contentStart);
+                return parsed_content;
             } catch (e) {
                 this.include_depth -= 1;
                 throw e;

src/types.ts

@@ -48,6 +48,12 @@ declare module "obsidian" {
         from: number;
         to: number;
     }
+
+    interface MarkdownView {
+        metadataEditor?: {
+            insertProperties?: (properties: Record<string, unknown>) => void;
+        };
+    }
 }
 
 export {};

src/utils/Utils.ts

@@ -1,11 +1,9 @@
 import {
     DocBlock,
     DocNode,
-    DocParamBlock,
     DocParamCollection,
     DocPlainText,
     DocSection,
-    ParserContext,
     TSDocParser,
 } from "@microsoft/tsdoc";
 
@@ -14,7 +12,9 @@ import { TJDocFile, TJDocFileArgument } from "./TJDocFile";
 import { TemplaterError } from "./Error";
 import {
     App,
+    getFrontMatterInfo,
     normalizePath,
+    parseYaml,
     TAbstractFile,
     TFile,
     TFolder,
@@ -241,49 +241,43 @@ export function append_bolded_label_with_value_to_parent(
     return para;
 }
 
-export async function merge_front_matter(
-    app: App,
-    file: TFile | null,
-    properties: Record<string, unknown>
-): Promise<void> {
-    if (!file || !is_object(properties)) {
-        return;
-    }
-    try {
-        await app.fileManager.processFrontMatter(file, (frontmatter) => {
-            for (const prop in properties) {
-                const currentValue = frontmatter[prop];
-                const newValue = properties[prop];
-
-                if (currentValue === undefined) {
-                    // If the property doesn't exist, add it
-                    frontmatter[prop] = newValue;
-                } else if (
-                    Array.isArray(currentValue) ||
-                    Array.isArray(newValue)
-                ) {
-                    // If either is an array, merge them
-                    frontmatter[prop] = Array.from(
-                        new Set([
-                            ...(currentValue
-                                ? Array.isArray(currentValue)
-                                    ? currentValue
-                                    : [currentValue]
-                                : []),
-                            ...(newValue
-                                ? Array.isArray(newValue)
-                                    ? newValue
-                                    : [newValue]
-                                : []),
-                        ])
-                    );
-                } else if (newValue !== currentValue && newValue != null) {
-                    // If they are different, update the value
-                    frontmatter[prop] = newValue;
+/**
+ * Merges two objects recursively. Target object will be modified.
+ * @param target The target object to merge into.
+ * @param source The source object to merge from.
+ */
+export function merge_objects(
+    target: Record<string, unknown>,
+    source: Record<string, unknown>
+) {
+    if (Object.keys(source).length === 0) return;
+    for (const key in source) {
+        if (source.hasOwnProperty(key)) {
+            if (target.hasOwnProperty(key)) {
+                const targetValue = target[key];
+                const sourceValue = source[key];
+                if (Array.isArray(targetValue) && Array.isArray(sourceValue)) {
+                    target[key] = targetValue.concat(sourceValue).unique();
+                } else if (is_object(targetValue) && is_object(sourceValue)) {
+                    merge_objects(targetValue, sourceValue);
+                } else {
+                    target[key] = sourceValue;
                 }
+            } else {
+                target[key] = source[key];
             }
-        });
-    } catch (error) {
-        console.error("Error in processing frontmatter: ", error);
+        }
+    }
+}
+
+export function get_frontmatter_and_content(content: string) {
+    let frontmatter: Record<string, unknown> = {};
+    const front_matter_info = getFrontMatterInfo(content);
+    if (front_matter_info.frontmatter) {
+        frontmatter = parseYaml(front_matter_info.frontmatter);
     }
+    return {
+        frontmatter,
+        content: content.slice(front_matter_info.contentStart),
+    };
 }