refactor: simplify get-document-format

Author: ycnmhd

src/obsidian/commands/helpers/export-document/eject-document.ts

@@ -1,6 +1,6 @@
 import { onPluginError } from 'src/lib/store/on-plugin-error';
 import { mapDocumentToText } from 'src/obsidian/commands/helpers/export-document/map-document-to-text';
-import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
 import { LineageView } from 'src/view/view';
 import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/commands/commands/helpers/save-node-content';
 import { setViewType } from 'src/stores/settings/actions/set-view-type';
@@ -22,7 +22,7 @@ export const ejectDocument = async (view: LineageView) => {
             return;
         }
         const fileData = await view.plugin.app.vault.read(file);
-        const format = getDocumentFormat(view);
+        const format = getPersistedDocumentFormat(view);
         const text = mapDocumentToText(fileData, format);
         await view.plugin.app.vault.modify(file, text);
         toggleObsidianViewType(view.plugin, view.leaf, 'markdown');

src/obsidian/commands/helpers/export-document/export-document.ts

@@ -2,7 +2,7 @@ import { createNewFile } from 'src/obsidian/events/workspace/effects/create-new-
 import { openFile } from 'src/obsidian/events/workspace/effects/open-file';
 import { onPluginError } from 'src/lib/store/on-plugin-error';
 import { mapDocumentToText } from 'src/obsidian/commands/helpers/export-document/map-document-to-text';
-import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
 import { LineageView } from 'src/view/view';
 import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/commands/commands/helpers/save-node-content';
 
@@ -22,7 +22,7 @@ export const exportDocument = async (view: LineageView) => {
             return;
         }
         const fileData = await view.plugin.app.vault.read(file);
-        const format = getDocumentFormat(view);
+        const format = getPersistedDocumentFormat(view);
         const output = mapDocumentToText(fileData, format);
         const newFile = await createNewFile(
             view.plugin,

src/obsidian/commands/helpers/extract-branch/extract-branch.ts

@@ -6,7 +6,7 @@ import invariant from 'tiny-invariant';
 import { openFileInLineage } from 'src/obsidian/events/workspace/effects/open-file-in-lineage';
 import { getFileNameOfExtractedBranch } from 'src/obsidian/commands/helpers/extract-branch/helpers/get-file-name-of-extracted-branch/get-file-name-of-extracted-branch';
 import { onPluginError } from 'src/lib/store/on-plugin-error';
-import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
 import { branchToOutline } from 'src/lib/data-conversion/branch-to-x/branch-to-outline';
 import { branchToHtmlElement } from 'src/lib/data-conversion/branch-to-x/branch-to-html-element';
 import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/commands/commands/helpers/save-node-content';
@@ -34,7 +34,7 @@ export const extractBranch = async (view: LineageView) => {
             'copy',
         );
 
-        const format = getDocumentFormat(view);
+        const format = getPersistedDocumentFormat(view);
         const text =
             format === 'outline'
                 ? branchToOutline([branch])

src/obsidian/events/workspace/helpers/get-or-detect-document-format.ts

@@ -2,12 +2,15 @@ import { LineageView } from 'src/view/view';
 import invariant from 'tiny-invariant';
 import { LineageDocumentFormat } from 'src/stores/settings/settings-type';
 
-export const getDocumentFormat = (view: LineageView): LineageDocumentFormat => {
+export const getPersistedDocumentFormat = (
+    view: LineageView,
+    fail = true,
+): LineageDocumentFormat => {
     invariant(view.file);
     const format =
         view.plugin.settings.getValue().documents[view.file.path]
             ?.documentFormat;
 
-    invariant(format);
+    if (fail) invariant(format);
     return format;
 };

…workspace/helpers/get-document-format.ts …helpers/get-persisted-document-format.tssrc/obsidian/events/workspace/helpers/get-document-format.ts renamed to src/obsidian/events/workspace/helpers/get-persisted-document-format.ts src/obsidian/events/workspace/helpers/get-document-format.ts renamed to src/obsidian/events/workspace/helpers/get-persisted-document-format.ts

@@ -3,7 +3,7 @@ import {
     MenuItemObject,
     renderContextMenu,
 } from 'src/obsidian/context-menu/render-context-menu';
-import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
 import { lang } from 'src/lang/lang';
 import { setDocumentFormat } from 'src/stores/settings/actions/set-document-format';
 import { exportDocument } from 'src/obsidian/commands/helpers/export-document/export-document';
@@ -15,7 +15,7 @@ export const showViewContextMenu = (event: MouseEvent, view: LineageView) => {
     const file = view.file;
     if (!file) return;
 
-    const format = getDocumentFormat(view);
+    const format = getPersistedDocumentFormat(view);
     const isOutline = format === 'outline';
     const isHtmlElement = format === 'html-element';
     const isHtmlComments = format === 'sections';

src/obsidian/events/workspace/helpers/maybe-get-document-format.ts

@@ -1,4 +1,4 @@
-import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
 import { mapBranchesToText } from 'src/view/actions/keyboard-shortcuts/helpers/commands/commands/helpers/clipboard/map-branches-to-text';
 import { LineageView } from 'src/view/view';
 import { getActiveNodes } from 'src/view/actions/keyboard-shortcuts/helpers/commands/commands/helpers/clipboard/get-active-nodes';
@@ -12,7 +12,7 @@ export const copyActiveBranchesToClipboard = async (
     const text = mapBranchesToText(
         view.documentStore.getValue().document,
         nodes,
-        formatted ? getDocumentFormat(view) : 'unformatted-text',
+        formatted ? getPersistedDocumentFormat(view) : 'unformatted-text',
     );
     await navigator.clipboard.writeText(text);
 };

src/view/actions/context-menu/view-context-menu/show-view-context-menu.ts

@@ -1,7 +1,7 @@
 <script lang="ts">
     import { getView } from '../../../../../../../context';
     import { ActiveStatus } from 'src/view/components/container/column/components/group/components/active-status.enum';
-    import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+    import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
     import {
         findSectionPosition
     } from 'src/view/components/container/column/components/group/components/card/components/card-buttons/helpers/find-section-position';
@@ -27,7 +27,7 @@
     const openFile = async () => {
         if (!view.file) return;
 
-        const format = getDocumentFormat(view);
+        const format = getPersistedDocumentFormat(view);
         const i =
             format === 'sections'
                 ? findSectionPosition(view, nodeId)

src/view/actions/keyboard-shortcuts/helpers/commands/commands/helpers/clipboard/copy-active-branches-to-clipboard.ts

@@ -31,10 +31,8 @@ import invariant from 'tiny-invariant';
 import { customIcons } from 'src/helpers/load-custom-icons';
 
 import { setViewType } from 'src/stores/settings/actions/set-view-type';
-import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { getPersistedDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-persisted-document-format';
 import { stringifyDocument } from 'src/view/helpers/stringify-document';
-import { getOrDetectDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-or-detect-document-format';
-import { maybeGetDocumentFormat } from 'src/obsidian/events/workspace/helpers/maybe-get-document-format';
 import { setDocumentFormat } from 'src/stores/settings/actions/set-document-format';
 import { toggleObsidianViewType } from 'src/obsidian/events/workspace/effects/toggle-obsidian-view-type';
 import { DocumentSearch } from 'src/stores/view/subscriptions/effects/document-search/document-search';
@@ -50,6 +48,8 @@ import { DebouncedMinimapEffects } from 'src/stores/minimap/subscriptions/effect
 import { updateFrontmatter } from 'src/stores/view/subscriptions/actions/document/update-frontmatter';
 import { loadFullDocument } from 'src/stores/view/subscriptions/actions/document/load-full-document';
 import { refreshActiveViewOfDocument } from 'src/stores/plugin/actions/refresh-active-view-of-document';
+import { detectDocumentFormat } from 'src/lib/format-detection/detect-document-format';
+import { LineageDocumentFormat } from 'src/stores/settings/settings-type';
 
 export const LINEAGE_VIEW_TYPE = 'lineage';
 
@@ -191,7 +191,7 @@ export class LineageView extends TextFileView {
         const state = clone(this.documentStore.getValue());
         const data: string =
             state.file.frontmatter +
-            stringifyDocument(state.document, getDocumentFormat(this));
+            stringifyDocument(state.document, getPersistedDocumentFormat(this));
         if (data !== this.data) {
             if (data.trim().length === 0) {
                 throw new Error(lang.error_save_empty_data);
@@ -211,7 +211,7 @@ export class LineageView extends TextFileView {
         } else {
             this.createStore();
         }
-        this.loadDocumentToStore();
+        this.loadDocumentToStore('view-mount');
         if (!this.inlineEditor) {
             this.inlineEditor = new InlineEditor(this);
             await this.inlineEditor.onload();
@@ -250,13 +250,13 @@ export class LineageView extends TextFileView {
             ].documentStore;
     };
 
-    private loadDocumentToStore = () => {
+    private loadDocumentToStore = (event?: 'view-mount') => {
         const { body, frontmatter } = extractFrontmatter(this.data);
 
         const documentState = this.documentStore.getValue();
         const viewState = this.viewStore.getValue();
-        const isEmptyStore = documentState.history.items.length === 0;
-        const format = getOrDetectDocumentFormat(this, body);
+        const format = this.getDocumentFormat(body);
+        const emptyStore = documentState.history.items.length === 0;
         const existingBody = stringifyDocument(documentState.document, format);
 
         const bodyHasChanged = existingBody !== body;
@@ -269,19 +269,31 @@ export class LineageView extends TextFileView {
         const activeSection = activeNode
             ? documentState.sections.id_section[activeNode]
             : null;
-        if (bodyHasChanged && !isEditing) {
+        if (emptyStore || (bodyHasChanged && !isEditing)) {
             loadFullDocument(this, body, frontmatter, format, activeSection);
-            if (this.isActive && existingBody && !isEmptyStore) {
-                new Notice('Document changed externally');
+            if (this.isActive && event !== 'view-mount') {
+                new Notice('Document updated externally');
             }
         } else if (frontmatterHasChanged) {
             updateFrontmatter(this, frontmatter);
         }
-        if (isEmptyStore && !maybeGetDocumentFormat(this)) {
-            setDocumentFormat(this.plugin, this.file!.path, format);
-        }
     };
 
+    private getDocumentFormat(body: string) {
+        let format: LineageDocumentFormat;
+        format = getPersistedDocumentFormat(this, false);
+        if (format) {
+            return format;
+        }
+
+        format =
+            detectDocumentFormat(body) ||
+            this.plugin.settings.getValue().general.defaultDocumentFormat;
+
+        setDocumentFormat(this.plugin, this.file!.path, format);
+        return format;
+    }
+
     private debouncedLoadDocumentToStore = debounce(
         this.loadDocumentToStore,
         250,