feat: specify source control refresh timer

#199
denolehov · Sep 7, 2022 · a1ecb1b · a1ecb1b
1 parent 82b2c1a
commit a1ecb1b
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 9 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -25,6 +25,7 @@ export const DEFAULT_SETTINGS: ObsidianGitSettings = {
     changedFilesInStatusBar: false,
     username: "",
     showedMobileNotice: false,
+    refreshSourceControlTimer: 7000,
 };
 
 export const GIT_VIEW_CONFIG = {

diff --git a/src/main.ts b/src/main.ts
@@ -40,15 +40,7 @@ export default class ObsidianGit extends Plugin {
     createEvent: EventRef;
     renameEvent: EventRef;
 
-    debRefresh = debounce(
-        () => {
-            if (this.settings.refreshSourceControl) {
-                this.refresh();
-            }
-        },
-        7000,
-        true
-    );
+    debRefresh: Debouncer<undefined, void>;
 
     setState(state: PluginState): void {
         this.state = state;
@@ -103,6 +95,7 @@ export default class ObsidianGit extends Plugin {
             defaultMod: true,
         });
 
+        this.setRefreshDebouncer();
 
         this.addCommand({
             id: 'edit-gitignore',
@@ -331,6 +324,19 @@ export default class ObsidianGit extends Plugin {
 
     }
 
+    setRefreshDebouncer(): void {
+        this.debRefresh?.cancel();
+        this.debRefresh = debounce(
+            () => {
+                if (this.settings.refreshSourceControl) {
+                    this.refresh();
+                }
+            },
+            this.settings.refreshSourceControlTimer,
+            true
+        );
+    }
+
     async showNotices(): Promise<void> {
         const length = 10000;
         if (this.manifest.id === "obsidian-git" && Platform.isDesktopApp && !this.settings.showedMobileNotice) {

diff --git a/src/settings.ts b/src/settings.ts
@@ -331,6 +331,20 @@ export class ObsidianGitSettingsTab extends PluginSettingTab {
                     })
             );
 
+        new Setting(containerEl)
+            .setName("Source Control View refresh interval")
+            .setDesc("Milliseconds two wait after file change before refreshing the Source Control View")
+            .addText((toggle) =>
+                toggle
+                    .setValue(plugin.settings.refreshSourceControlTimer.toString())
+                    .setPlaceholder("7000")
+                    .onChange((value) => {
+                        plugin.settings.refreshSourceControlTimer = Math.max(parseInt(value), 500);
+                        plugin.saveSettings();
+                        plugin.setRefreshDebouncer();
+                    })
+            );
+
         new Setting(containerEl)
             .setName("Disable notifications")
             .setDesc(

diff --git a/src/types.ts b/src/types.ts
@@ -31,6 +31,7 @@ export interface ObsidianGitSettings {
     refreshSourceControl: boolean;
     basePath: string;
     showedMobileNotice: boolean;
+    refreshSourceControlTimer: number;
 }
 
 export type SyncMethod = 'rebase' | 'merge' | 'reset';