refactor: rename store action types

Author: ycnmhd

src/lang/snapshot-action-lang.ts

@@ -27,69 +27,69 @@ export const snapshotActionLang: Partial<
         (snapshot: Snapshot) => { label: string; icon: typeof FileEdit }
     >
 > = {
-    'DOCUMENT/SET_NODE_CONTENT': (snapshot) => ({
+    'document/update-node-content': (snapshot) => ({
         label:
             lang.modals_snapshots_updated_node +
             snapshot.context.affectedSection,
         icon: FileEdit,
     }),
-    'DOCUMENT/INSERT_NODE': (snapshot) => ({
+    'document/add-node': (snapshot) => ({
         label:
             lang.modals_snapshots_created_node +
             snapshot.context.affectedSection,
         icon: FilePlus,
     }),
-    'DOCUMENT/DROP_NODE': (snapshot) => ({
+    'document/drop-node': (snapshot) => ({
         label:
             lang.modals_snapshots_dropped_node +
             snapshot.context.affectedSection,
         icon: FileOutput,
     }),
-    'DOCUMENT/LOAD_FILE': () => ({
+    'document/file/load-from-disk': () => ({
         label: lang.modals_snapshots_document_loaded,
         icon: FileUp,
     }),
-    'DOCUMENT/DELETE_NODE': (snapshot) => ({
+    'document/delete-node': (snapshot) => ({
         label:
             lang.modals_snapshots_deleted_section +
             snapshot.context.affectedSection,
         icon: FileMinus,
     }),
-    'DOCUMENT/MOVE_NODE': (snapshot) => ({
+    'document/move-node': (snapshot) => ({
         label:
             lang.modals_snapshots_moved_node + snapshot.context.affectedSection,
         icon: FileOutput,
     }),
-    'DOCUMENT/MERGE_NODE': (snapshot) => ({
+    'document/merge-node': (snapshot) => ({
         label:
             lang.modals_snapshots_merged_node +
             snapshot.context.affectedSection,
         icon: Merge,
     }),
-    'DOCUMENT/FORMAT_HEADINGS': () => ({
+    'document/format-headings': () => ({
         label: lang.modals_snapshots_formatted_headings,
         icon: Heading1,
     }),
-    'DOCUMENT/CUT_NODE': (snapshot) => ({
+    'document/cut-node': (snapshot) => ({
         label:
             lang.modals_snapshots_cut_section +
             snapshot.context.affectedSection,
         icon: Scissors,
     }),
-    'DOCUMENT/PASTE_NODE': (snapshot) => ({
+    'document/paste-node': (snapshot) => ({
         label:
             lang.modals_snapshots_pasted_section +
             snapshot.context.affectedSection,
         icon: ClipboardPaste,
     }),
-    'DOCUMENT/EXTRACT_BRANCH': (snapshot) => ({
+    'document/extract-node': (snapshot) => ({
         label:
             lang.modals_snapshots_extracted_node +
             snapshot.context.affectedSection,
         icon: FileSymlink,
         iconHtml: customIcons.cards.svg,
     }),
-    'DOCUMENT/SPLIT_NODE': (snapshot) => ({
+    'document/split-node': (snapshot) => ({
         label:
             lang.modals_snapshots_split_node + snapshot.context.affectedSection,
         icon: Split,

src/lib/tree-utils/find/find-next-active-node.ts

@@ -9,9 +9,9 @@ export const findNextActiveNode = (
     node: string,
     action: DeleteNodeAction | JumpToNodeAction,
 ) => {
-    if (action.type === 'DOCUMENT/DELETE_NODE') {
+    if (action.type === 'document/delete-node') {
         return findNextNodeAfterDeletion(columns, node);
-    } else if (action.type === 'DOCUMENT/JUMP_TO_NODE') {
+    } else if (action.type === 'view/set-active-node/keyboard-jump') {
         return findNodeToJumpTo(columns, node, action.payload.target);
     }
 };

src/main.ts

@@ -2,10 +2,7 @@ import { Plugin, WorkspaceLeaf } from 'obsidian';
 import { LINEAGE_VIEW_TYPE, LineageView } from './view/view';
 import { createSetViewState } from 'src/obsidian/patches/create-set-view-state';
 import { around } from 'monkey-around';
-import {
-    SettingsActions,
-    settingsReducer,
-} from 'src/stores/settings/settings-reducer';
+import { settingsReducer } from 'src/stores/settings/settings-reducer';
 import { deepMerge } from 'src/helpers/deep-merge';
 import { DEFAULT_SETTINGS } from 'src/stores/settings/default-settings';
 import { Store } from 'src/lib/store/store';
@@ -37,6 +34,7 @@ import {
 } from 'src/workers/worker-instances';
 import { onVaultEvent } from 'src/stores/plugin/subscriptions/on-vault-event';
 import { onWorkspaceEvent } from 'src/stores/plugin/subscriptions/on-workspace-event';
+import { SettingsActions } from 'src/stores/settings/settings-store-actions';
 
 export type SettingsStore = Store<Settings, SettingsActions>;
 export type PluginStore = Store<PluginState, PluginStoreActions>;

src/obsidian/commands/add-commands.ts

@@ -53,7 +53,7 @@ const createCommands = (plugin: Lineage) => {
                 return Boolean(getActiveLineageView(plugin));
             }
             plugin.settings.dispatch({
-                type: 'VIEW/SCROLLING/TOGGLE_SCROLLING_MODE',
+                type: 'settings/view/toggle-horizontal-scrolling-mode',
             });
         },
     });
@@ -66,7 +66,7 @@ const createCommands = (plugin: Lineage) => {
                 return Boolean(getActiveLineageView(plugin));
             }
             plugin.settings.dispatch({
-                type: 'settings/view/scrolling/toggle-vertical-scrolling-mode',
+                type: 'settings/view/toggle-vertical-scrolling-mode',
             });
         },
     });
@@ -222,7 +222,7 @@ const createCommands = (plugin: Lineage) => {
                 return Boolean(view);
             }
             plugin.settings.dispatch({
-                type: 'VIEW/TOGGLE_MINIMAP',
+                type: 'settings/view/toggle-minimap',
             });
         },
     });

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

@@ -55,7 +55,7 @@ export const extractBranch = async (view: LineageView) => {
         await openFileInLineage(view.plugin, newFile, format, 'split');
 
         view.documentStore.dispatch({
-            type: 'DOCUMENT/EXTRACT_BRANCH',
+            type: 'document/extract-node',
             payload: {
                 nodeId: branch.nodeId,
                 documentName: newFile.basename,

src/obsidian/helpers/inline-editor/inline-editor.ts

@@ -224,7 +224,7 @@ export class InlineEditor {
         const content = this.getContent();
         const viewState = this.view.viewStore.getValue();
         this.view.documentStore.dispatch({
-            type: 'DOCUMENT/SET_NODE_CONTENT',
+            type: 'document/update-node-content',
             payload: {
                 nodeId: nodeId,
                 content: content,

src/stores/document/default-document-state.ts

@@ -10,7 +10,6 @@ export const defaultDocumentState = (): DocumentState => ({
         section_id: {},
     },
     file: {
-        path: null,
         frontmatter: '',
     },
     history: {

src/stores/document/document-reducer.ts

@@ -20,7 +20,6 @@ import {
     DocumentStoreAction,
     UndoableAction,
 } from 'src/stores/document/document-store-actions';
-import { defaultDocumentState } from 'src/stores/document/default-document-state';
 import { formatHeadings } from 'src/stores/document/reducers/content/format-content/format-headings';
 import { pasteNode } from 'src/stores/document/reducers/clipboard/paste-node/paste-node';
 import { updateSectionsDictionary } from 'src/stores/document/reducers/state/update-sections-dictionary';
@@ -45,18 +44,18 @@ const updateDocumentState = (
     let affectedNodeId: null | string = null;
     let affectedNodeContent: Content[string] | null = null;
     let affectedNodes: string[] | undefined = undefined;
-    if (action.type === 'DOCUMENT/SET_NODE_CONTENT') {
+    if (action.type === 'document/update-node-content') {
         const update = setNodeContent(state.document.content, action);
         if (!update) return NO_UPDATE;
         newActiveNodeId = action.payload.nodeId;
-    } else if (action.type === 'DOCUMENT/INSERT_NODE') {
+    } else if (action.type === 'document/add-node') {
         newActiveNodeId = insertNode(
             state.document,
             action.payload.position,
             action.payload.activeNodeId,
             action.payload.content,
         );
-    } else if (action.type === 'DOCUMENT/DELETE_NODE') {
+    } else if (action.type === 'document/delete-node') {
         affectedNodeContent =
             state.document.content[action.payload.activeNodeId];
         newActiveNodeId = deleteNode(
@@ -65,7 +64,7 @@ const updateDocumentState = (
             action.payload.selectedNodes,
         );
         affectedNodeId = action.payload.activeNodeId;
-    } else if (action.type === 'DOCUMENT/EXTRACT_BRANCH') {
+    } else if (action.type === 'document/extract-node') {
         affectedNodeContent = state.document.content[action.payload.nodeId];
         const update = setNodeContent(state.document.content, {
             payload: {
@@ -76,18 +75,18 @@ const updateDocumentState = (
         if (!update) return NO_UPDATE;
         removeExtractedBranch(state.document, action);
         newActiveNodeId = action.payload.nodeId;
-    } else if (action.type === 'DOCUMENT/SPLIT_NODE') {
+    } else if (action.type === 'document/split-node') {
         affectedNodeId = action.payload.target;
         affectedNodeContent = state.document.content[affectedNodeId];
         newActiveNodeId = splitNode(state.document, action);
-    } else if (action.type === 'DOCUMENT/DROP_NODE') {
+    } else if (action.type === 'document/drop-node') {
         dropNode(state.document, action);
         newActiveNodeId = action.payload.droppedNodeId;
-    } else if (action.type === 'DOCUMENT/MOVE_NODE') {
+    } else if (action.type === 'document/move-node') {
         moveNode(state.document, action);
         newActiveNodeId = action.payload.activeNodeId;
         affectedNodeId = newActiveNodeId;
-    } else if (action.type === 'DOCUMENT/MERGE_NODE') {
+    } else if (action.type === 'document/merge-node') {
         affectedNodeContent =
             state.document.content[action.payload.activeNodeId];
         newActiveNodeId = mergeNode(state.document, action);
@@ -96,7 +95,7 @@ const updateDocumentState = (
         sortDirectChildNodes(state.document, action.payload);
         newActiveNodeId = action.payload.id;
         affectedNodeId = newActiveNodeId;
-    } else if (action.type === 'DOCUMENT/LOAD_FILE') {
+    } else if (action.type === 'document/file/load-from-disk') {
         if (action.payload.__test_document__) {
             newActiveNodeId = loadDocumentFromJSON(
                 state,
@@ -105,41 +104,34 @@ const updateDocumentState = (
         } else {
             newActiveNodeId = loadDocumentFromFile(state, action);
         }
-    } else if (action.type === 'RESET_STORE') {
-        const newState = defaultDocumentState();
-        state.document = newState.document;
-        state.history = newState.history;
-        state.file = newState.file;
-    } else if (action.type === 'HISTORY/SELECT_SNAPSHOT') {
+    } else if (action.type === 'document/history/select-snapshot') {
         selectSnapshot(state.document, state.history, action);
         state.history = { ...state.history };
-    } else if (action.type === 'HISTORY/APPLY_PREVIOUS_SNAPSHOT') {
+    } else if (action.type === 'document/history/select-previous-snapshot') {
         undoAction(state.document, state.history);
         state.history = { ...state.history };
-    } else if (action.type === 'HISTORY/APPLY_NEXT_SNAPSHOT') {
+    } else if (action.type === 'document/history/select-next-snapshot') {
         redoAction(state.document, state.history);
         state.history = { ...state.history };
-    } else if (action.type === 'FS/SET_FILE_PATH') {
-        state.file.path = action.payload.path;
-    } else if (action.type === 'DOCUMENT/FORMAT_HEADINGS') {
+    } else if (action.type === 'document/format-headings') {
         formatHeadings(state.document.content, state.sections);
         newActiveNodeId = getIdOfSection(
             state.sections,
             state.history.context.activeSection,
         );
-    } else if (action.type === 'DOCUMENT/PASTE_NODE') {
+    } else if (action.type === 'document/paste-node') {
         const result = pasteNode(state.document, action);
         newActiveNodeId = result.nextNode;
         affectedNodes = result.rootNodes;
-    } else if (action.type === 'DOCUMENT/CUT_NODE') {
+    } else if (action.type === 'document/cut-node') {
         affectedNodeContent = state.document.content[action.payload.nodeId];
         newActiveNodeId = deleteNode(
             state.document,
             action.payload.nodeId,
             action.payload.selectedNodes,
         );
         affectedNodeId = action.payload.nodeId;
-    } else if (action.type === 'FILE/UPDATE_FRONTMATTER') {
+    } else if (action.type === 'document/file/update-frontmatter') {
         state.file.frontmatter = action.payload.frontmatter;
         return;
     } else if (action.type === 'document/pinned-nodes/pin') {
@@ -158,7 +150,7 @@ const updateDocumentState = (
             action.payload.sections,
         );
         return;
-    } else if (action.type === 'META/REFRESH_GROUP_PARENT_IDS') {
+    } else if (action.type === 'document/meta/refresh-group-parent-ids') {
         refreshGroupParentIds(state.document.columns, state.meta);
         return;
     }
@@ -175,7 +167,7 @@ const updateDocumentState = (
     }
 
     // if file was modified externally, try to maintain active section
-    if (action.type === 'DOCUMENT/LOAD_FILE') {
+    if (action.type === 'document/file/load-from-disk') {
         const activeSection = action.payload.activeSection;
         if (activeSection) {
             const id = state.sections.section_id[activeSection];

src/stores/document/document-state-type.ts

@@ -19,7 +19,7 @@ export type DocumentState = {
     document: LineageDocument;
     sections: Sections;
     file: {
-        path: string | null;
+        // path: string | null;
         frontmatter: string;
     };
     meta: DocumentMeta;

src/stores/document/document-store-actions.ts

@@ -27,23 +27,14 @@ export type SavedDocument = {
     position: NodePosition | null;
     frontmatter: string;
 };
-type ResetStoreAction = { type: 'RESET_STORE' };
-type SetFilePathAction = {
-    type: 'FS/SET_FILE_PATH';
-    payload: {
-        path: string | null;
-    };
-};
 
 export type DocumentStoreAction = DocumentAction | HistoryAction;
 
 export type DocumentAction =
     | LoadDocumentAction
     | CreateNodeAction
-    | ResetStoreAction
     | SetNodeContentAction
     | DropAction
-    | SetFilePathAction
     | DeleteNodeAction
     | MoveNodeAction
     | MergeNodeAction
@@ -52,7 +43,7 @@ export type DocumentAction =
     | ExtractNodeAction
     | SplitNodeAction
     | {
-          type: 'FILE/UPDATE_FRONTMATTER';
+          type: 'document/file/update-frontmatter';
           payload: {
               frontmatter: string;
           };
@@ -86,7 +77,7 @@ export type CopyNodeAction = {
 };
 
 export type CutNodeAction = {
-    type: 'DOCUMENT/CUT_NODE';
+    type: 'document/cut-node';
     payload: {
         nodeId: string;
         selectedNodes?: Set<string>;