feat: add debug logging for git commands

- Add setGitDebug() to enable/disable logging
- Log git commands and results to console.debug
- Add debugLog setting with UI toggle
- Add i18n translations for debug log setting

Author: whtiehack

main.js

@@ -8,16 +8,41 @@ interface GitRunOptions {
 	args: string[];
 }
 
+let debugEnabled = false;
+
+export function setGitDebug(enabled: boolean): void {
+	debugEnabled = enabled;
+}
+
+function log(message: string, ...args: unknown[]): void {
+	if (!debugEnabled) return;
+	globalThis.console.debug(`[auto-git] ${message}`, ...args);
+}
+
+function logCmd(args: string[]): void {
+	if (!debugEnabled) return;
+	globalThis.console.debug(`[auto-git] > git ${args.join(" ")}`);
+}
+
 function runGitSync({ cwd, gitPath, args }: GitRunOptions): string {
-	return execFileSync(gitPath, args, {
-		cwd,
-		windowsHide: true,
-		env: { ...process.env, GIT_TERMINAL_PROMPT: "0" },
-		encoding: "utf8",
-	});
+	logCmd(args);
+	try {
+		const result = execFileSync(gitPath, args, {
+			cwd,
+			windowsHide: true,
+			env: { ...process.env, GIT_TERMINAL_PROMPT: "0" },
+			encoding: "utf8",
+		});
+		log("ok");
+		return result;
+	} catch (e) {
+		log("error:", (e as Error).message);
+		throw e;
+	}
 }
 
 function runGit({ cwd, gitPath, args }: GitRunOptions): Promise<string> {
+	logCmd(args);
 	return new Promise((resolve, reject) => {
 		execFile(
 			gitPath,
@@ -29,9 +54,11 @@ function runGit({ cwd, gitPath, args }: GitRunOptions): Promise<string> {
 			},
 			(err, stdout, stderr) => {
 				if (err) {
+					log("error:", stderr?.trim() || err.message);
 					reject(new Error(stderr?.trim() || err.message));
 					return;
 				}
+				log("ok");
 				resolve(stdout);
 			}
 		);

src/git.ts

@@ -30,6 +30,9 @@ type Translations = {
 	ignoreObsidianName: string;
 	ignoreObsidianDesc: string;
 
+	debugLogName: string;
+	debugLogDesc: string;
+
 	includeFileListName: string;
 	includeFileListDesc: string;
 
@@ -159,6 +162,9 @@ const en: Translations = {
 	ignoreObsidianName: "Ignore config directory",
 	ignoreObsidianDesc: "Exclude Obsidian config folder from triggering auto-commits.",
 
+	debugLogName: "Debug logging",
+	debugLogDesc: "Log git commands to console (Ctrl+Shift+I to view).",
+
 	includeFileListName: "Include file list in commit body",
 	includeFileListDesc: "List changed files in commit message body, one per line.",
 
@@ -283,6 +289,9 @@ const zhCN: Translations = {
 	ignoreObsidianName: "忽略配置目录",
 	ignoreObsidianDesc: "排除 Obsidian 配置文件夹触发自动提交。",
 
+	debugLogName: "调试日志",
+	debugLogDesc: "将 git 命令输出到控制台（Ctrl+Shift+I 查看）。",
+
 	includeFileListName: "在提交正文中包含文件列表",
 	includeFileListDesc: "在提交消息正文中列出变动的文件，每行一个。",
 

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, getConflictFiles, markConflictsResolved, revertAll, revertFile, getChangedFilesSync, commitSyncAndPushDetached } from "./git";
+import { getChangedFiles, commitAll, push, pull, getConflictFiles, markConflictsResolved, revertAll, revertFile, getChangedFilesSync, commitSyncAndPushDetached, setGitDebug } from "./git";
 import { renderTemplate } from "./template";
 import { t } from "./i18n";
 import { RevertConfirmModal } from "./modals";
@@ -111,6 +111,7 @@ export default class AutoGitPlugin extends Plugin {
 
 	async loadSettings() {
 		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData() as Partial<AutoGitSettings>);
+		setGitDebug(this.settings.debugLog);
 	}
 
 	async saveSettings() {

src/main.ts

@@ -1,7 +1,7 @@
 import { App, Notice, Platform, PluginSettingTab, Setting } from "obsidian";
 import type AutoGitPlugin from "./main";
 import { t } from "./i18n";
-import { isGitRepo, initRepo, getRemoteUrl, setRemoteUrl, hasConflicts, markConflictsResolved, detectRepoState, RepoState, connectToRemote, initAndPush, setUpstream } from "./git";
+import { isGitRepo, initRepo, getRemoteUrl, setRemoteUrl, hasConflicts, markConflictsResolved, detectRepoState, RepoState, connectToRemote, initAndPush, setUpstream, setGitDebug } from "./git";
 
 export interface AutoGitSettings {
 	autoCommit: boolean;
@@ -16,6 +16,7 @@ export interface AutoGitSettings {
 	showStatusBadge: boolean;
 	showRibbonButton: boolean;
 	badgeRefreshInterval: number; // 0 = disabled, otherwise seconds
+	debugLog: boolean;
 }
 
 export const DEFAULT_SETTINGS: AutoGitSettings = {
@@ -31,6 +32,7 @@ export const DEFAULT_SETTINGS: AutoGitSettings = {
 	showStatusBadge: true,
 	showRibbonButton: true,
 	badgeRefreshInterval: 0, // 0 = disabled (event-driven only), otherwise seconds
+	debugLog: false,
 };
 
 export class AutoGitSettingTab extends PluginSettingTab {
@@ -216,6 +218,17 @@ export class AutoGitSettingTab extends PluginSettingTab {
 					await this.plugin.saveSettings();
 				})
 			);
+
+		new Setting(containerEl)
+			.setName(i18n.debugLogName)
+			.setDesc(i18n.debugLogDesc)
+			.addToggle((toggle) =>
+				toggle.setValue(this.plugin.settings.debugLog).onChange(async (value) => {
+					this.plugin.settings.debugLog = value;
+					setGitDebug(value);
+					await this.plugin.saveSettings();
+				})
+			);
 	}
 
 	private async displaySetupSection(container: HTMLElement): Promise<void> {