pr review

Author: Vinzent03

package-lock.json

@@ -44,7 +44,7 @@
         "svelte-preprocess": "^6.0.3",
         "tslib": "^2.8.1",
         "typescript": "5.8.3",
-        "typescript-eslint": "^8.8.1"
+        "typescript-eslint": "^8.38.0"
     },
     "dependencies": {
         "@codemirror/commands": "^6.8.1",

package.json

@@ -27,7 +27,7 @@ export const DEFAULT_SETTINGS: ObsidianGitSettings = {
     showStatusBar: true,
     updateSubmodules: false,
     syncMethod: "merge",
-    resolutionMethod: "none",
+    mergeStrategy: "none",
     customMessageOnAutoBackup: false,
     autoBackupAfterFileChange: false,
     treeStructure: false,

src/constants.ts

@@ -5,7 +5,6 @@ import type {
     DiffFile,
     FileStatusResult,
     LogEntry,
-    ResolutionMethod,
     Status,
     TreeItem,
     UnstagedFile,

src/gitManager/gitManager.ts

@@ -478,7 +478,7 @@ export class IsomorphicGit extends GitManager {
                     theirs: branchInfo.tracking!,
                     abortOnConflict: false,
                     mergeDriver:
-                        this.plugin.settings.resolutionMethod !== "none"
+                        this.plugin.settings.mergeStrategy !== "none"
                             ? ({ contents }) => {
                                   const baseContent = contents[0];
                                   const ourContent = contents[1];
@@ -500,7 +500,7 @@ export class IsomorphicGit extends GitManager {
                                       if (item.conflict) {
                                           mergedText +=
                                               this.plugin.settings
-                                                  .resolutionMethod === "ours"
+                                                  .mergeStrategy === "ours"
                                                   ? item.conflict.a.join("")
                                                   : item.conflict.b.join("");
                                       }

src/gitManager/isomorphicGit.ts

@@ -602,9 +602,6 @@ export class SimpleGit extends GitManager {
                 this.plugin.log(
                     "No tracking branch found. Ignoring pull of main repo and updating submodules only."
                 );
-                this.plugin.displayMessage(
-                    "No tracking branch found. Ignoring pull of main repo and updating submodules only."
-                );
                 return;
             }
 
@@ -621,9 +618,9 @@ export class SimpleGit extends GitManager {
                     try {
                         const args = [branchInfo.tracking!];
 
-                        if (this.plugin.settings.resolutionMethod !== "none") {
+                        if (this.plugin.settings.mergeStrategy !== "none") {
                             args.push(
-                                `--strategy-option=${this.plugin.settings.resolutionMethod}`
+                                `--strategy-option=${this.plugin.settings.mergeStrategy}`
                             );
                         }
 
@@ -654,7 +651,6 @@ export class SimpleGit extends GitManager {
                             // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
                             `Sync failed (${this.plugin.settings.syncMethod}): ${"message" in err ? err.message : err}`
                         );
-                        err = true;
                     }
                 }
                 this.app.workspace.trigger("obsidian-git:head-change");

src/gitManager/simpleGit.ts

@@ -1074,6 +1074,11 @@ export default class ObsidianGit extends Plugin {
         }
     }
 
+    /** Used for internals
+     *  Returns whether the pull added a commit or not.
+     *
+     *  See {@link pullChangesFromRemote} for the command version.
+     */
     async pull(): Promise<false | number> {
         if (!(await this.remotesAreSet())) {
             return false;

src/main.ts

@@ -25,7 +25,7 @@ import type {
 import type ObsidianGit from "src/main";
 import type {
     ObsidianGitSettings,
-    ResolutionMethod,
+    MergeStrategy,
     ShowAuthorInHistoryView,
     SyncMethod,
 } from "src/types";
@@ -400,21 +400,21 @@ export class ObsidianGitSettingsTab extends PluginSettingTab {
                     });
 
             new Setting(containerEl)
-                .setName("Conflict resolution strategy")
+                .setName("Merge strategy on conflicts")
                 .setDesc(
-                    "Decide how to solve conflicts when pulling remote changes"
+                    "Decide how to solve conflicts when pulling remote changes. This can be used to favor your local changes or the remote changes automatically."
                 )
                 .addDropdown((dropdown) => {
-                    const options: Record<ResolutionMethod, string> = {
+                    const options: Record<MergeStrategy, string> = {
                         none: "None (git default)",
                         ours: "Our changes",
                         theirs: "Their changes",
                     };
                     dropdown.addOptions(options);
-                    dropdown.setValue(plugin.settings.resolutionMethod);
+                    dropdown.setValue(plugin.settings.mergeStrategy);
 
-                    dropdown.onChange(async (option: ResolutionMethod) => {
-                        plugin.settings.resolutionMethod = option;
+                    dropdown.onChange(async (option: MergeStrategy) => {
+                        plugin.settings.mergeStrategy = option;
                         await plugin.saveSettings();
                     });
                 });

src/setting/settings.ts

@@ -14,7 +14,7 @@ export interface ObsidianGitSettings {
     autoPullOnBoot: boolean;
     autoCommitOnlyStaged: boolean;
     syncMethod: SyncMethod;
-    resolutionMethod: ResolutionMethod;
+    mergeStrategy: MergeStrategy;
     /**
      * Whether to push on commit-and-sync
      */
@@ -81,7 +81,7 @@ export function mergeSettingsByPriority(
 
 export type SyncMethod = "rebase" | "merge" | "reset";
 
-export type ResolutionMethod = "none" | "ours" | "theirs";
+export type MergeStrategy = "none" | "ours" | "theirs";
 
 export type ShowAuthorInHistoryView = "full" | "initials" | "hide";