Add commit and push on close option

Author: whtiehack

main.js

@@ -1,4 +1,4 @@
-import { execFile } from "child_process";
+import { execFile, execFileSync } from "child_process";
 import { promises as fs } from "fs";
 import * as path from "path";
 
@@ -8,6 +8,15 @@ interface GitRunOptions {
 	args: string[];
 }
 
+function runGitSync({ cwd, gitPath, args }: GitRunOptions): string {
+	return execFileSync(gitPath, args, {
+		cwd,
+		windowsHide: true,
+		env: { ...process.env, GIT_TERMINAL_PROMPT: "0" },
+		encoding: "utf8",
+	});
+}
+
 function runGit({ cwd, gitPath, args }: GitRunOptions): Promise<string> {
 	return new Promise((resolve, reject) => {
 		execFile(
@@ -390,3 +399,33 @@ async function getCurrentBranch(cwd: string, gitPath: string): Promise<string> {
 	const stdout = await runGit({ cwd, gitPath, args: ["rev-parse", "--abbrev-ref", "HEAD"] });
 	return stdout.trim();
 }
+
+// Synchronous version for use during app close
+export function getChangedFilesSync(cwd: string, gitPath: string): string[] {
+	try {
+		const stdout = runGitSync({ cwd, gitPath, args: ["status", "--porcelain=v1", "-z"] });
+		if (!stdout) return [];
+		const parts = stdout.split("\0").filter(Boolean);
+		const files: string[] = [];
+		for (let i = 0; i < parts.length; i++) {
+			const entry = parts[i];
+			const statusCode = entry.slice(0, 2);
+			const filePath = entry.slice(3);
+			if (filePath) files.push(filePath);
+			if (statusCode.startsWith("R") || statusCode.startsWith("C")) i++;
+		}
+		return [...new Set(files)];
+	} catch {
+		return [];
+	}
+}
+
+export function commitAndPushSync(cwd: string, gitPath: string, message: string): void {
+	try {
+		runGitSync({ cwd, gitPath, args: ["add", "-A"] });
+		runGitSync({ cwd, gitPath, args: ["commit", "-m", message] });
+		runGitSync({ cwd, gitPath, args: ["push"] });
+	} catch {
+		// Ignore errors during close
+	}
+}

src/git.ts

@@ -17,6 +17,9 @@ type Translations = {
 	autoPullOnOpenName: string;
 	autoPullOnOpenDesc: string;
 
+	commitOnCloseName: string;
+	commitOnCloseDesc: string;
+
 	templateName: string;
 	templateDesc: string;
 
@@ -130,6 +133,9 @@ const en: Translations = {
 	autoPullOnOpenName: "Auto pull on open",
 	autoPullOnOpenDesc: "Pull from remote when Obsidian opens.",
 
+	commitOnCloseName: "Commit and push on close",
+	commitOnCloseDesc: "Commit all changes and push when Obsidian closes. Note: This may cause a brief delay when closing.",
+
 	templateName: "Commit message template",
 	templateDesc: "Variables: {{date}}, {{time}}, {{files}}, {{count}}",
 
@@ -239,6 +245,9 @@ const zhCN: Translations = {
 	autoPullOnOpenName: "打开时自动拉取",
 	autoPullOnOpenDesc: "打开 Obsidian 时自动从远程仓库拉取。",
 
+	commitOnCloseName: "关闭时提交并推送",
+	commitOnCloseDesc: "关闭 Obsidian 时自动提交所有更改并推送。注意：这可能导致关闭时短暂卡顿。",
+
 	templateName: "提交消息模板",
 	templateDesc: "变量: {{date}}, {{time}}, {{files}}, {{count}}",
 

src/i18n.ts

@@ -1,6 +1,6 @@
 import { EventRef, Menu, Notice, Platform, Plugin, TAbstractFile, TFile, FileSystemAdapter } from "obsidian";
 import { AutoGitSettings, AutoGitSettingTab, DEFAULT_SETTINGS } from "./settings";
-import { getChangedFiles, commitAll, push, pull, getFileStatuses, getConflictFiles, markConflictsResolved, revertAll, FileStatus } from "./git";
+import { getChangedFiles, commitAll, push, pull, getFileStatuses, getConflictFiles, markConflictsResolved, revertAll, FileStatus, getChangedFilesSync, commitAndPushSync } from "./git";
 import { renderTemplate } from "./template";
 import { t } from "./i18n";
 
@@ -17,6 +17,7 @@ export default class AutoGitPlugin extends Plugin {
 	private _hasConflicts = false;
 	private resolveConflictCommand: { id: string } | null = null;
 	private ribbonIconEl: HTMLElement | null = null;
+	private beforeUnloadHandler: (() => void) | null = null;
 
 	async onload() {
 		await this.loadSettings();
@@ -61,6 +62,33 @@ export default class AutoGitPlugin extends Plugin {
 			window.setTimeout(() => { void this.doPull(); }, 1000);
 		}
 
+		// Setup beforeunload handler for commit on close
+		if (!Platform.isMobileApp) {
+			this.beforeUnloadHandler = () => {
+				if (this.settings.commitOnClose) {
+					const cwd = this.getVaultPathSafe();
+					if (cwd) {
+						const changedFiles = getChangedFilesSync(cwd, this.settings.gitPath);
+						if (changedFiles.length > 0) {
+							const now = new Date();
+							const subject = renderTemplate(this.settings.commitTemplate, {
+								date: now.toISOString().slice(0, 10),
+								time: now.toTimeString().slice(0, 8),
+								files: changedFiles.slice(0, 5).join(", ") + (changedFiles.length > 5 ? "..." : ""),
+								count: String(changedFiles.length),
+							});
+							let message = subject;
+							if (this.settings.includeFileList) {
+								message += "\n\n" + changedFiles.join("\n");
+							}
+							commitAndPushSync(cwd, this.settings.gitPath, message);
+						}
+					}
+				}
+			};
+			window.addEventListener("beforeunload", this.beforeUnloadHandler);
+		}
+
 		// Check for existing conflicts on load
 		void this.checkConflicts();
 	}
@@ -76,6 +104,10 @@ export default class AutoGitPlugin extends Plugin {
 			this.ribbonIconEl.remove();
 			this.ribbonIconEl = null;
 		}
+		if (this.beforeUnloadHandler) {
+			window.removeEventListener("beforeunload", this.beforeUnloadHandler);
+			this.beforeUnloadHandler = null;
+		}
 	}
 
 	async loadSettings() {

src/main.ts

@@ -10,6 +10,7 @@ export interface AutoGitSettings {
 	includeFileList: boolean;
 	autoPush: boolean;
 	autoPullOnOpen: boolean;
+	commitOnClose: boolean;
 	gitPath: string;
 	ignoreObsidianDir: boolean;
 	showStatusBadge: boolean;
@@ -23,6 +24,7 @@ export const DEFAULT_SETTINGS: AutoGitSettings = {
 	includeFileList: true,
 	autoPush: false,
 	autoPullOnOpen: false,
+	commitOnClose: false,
 	gitPath: "git",
 	ignoreObsidianDir: true,
 	showStatusBadge: true,
@@ -70,6 +72,16 @@ export class AutoGitSettingTab extends PluginSettingTab {
 				})
 			);
 
+		new Setting(containerEl)
+			.setName(i18n.commitOnCloseName)
+			.setDesc(i18n.commitOnCloseDesc)
+			.addToggle((toggle) =>
+				toggle.setValue(this.plugin.settings.commitOnClose).onChange(async (value) => {
+					this.plugin.settings.commitOnClose = value;
+					await this.plugin.saveSettings();
+				})
+			);
+
 		// Container for auto-commit related settings (created after toggle for correct order)
 		let autoCommitSettings: HTMLDivElement;