fix: handle "Add to .gitignore" edgecases and make the added path absolute (#890)

Author: shumadrid

src/commands.ts

@@ -1,11 +1,11 @@
-import { Notice, Platform, WorkspaceLeaf } from "obsidian";
+import { Notice, Platform, TFolder, WorkspaceLeaf } from "obsidian";
 import { HISTORY_VIEW_CONFIG, SOURCE_CONTROL_VIEW_CONFIG } from "./constants";
+import { SimpleGit } from "./gitManager/simpleGit";
 import ObsidianGit from "./main";
 import { openHistoryInGitHub, openLineInGitHub } from "./openInGitHub";
 import { ChangedFilesModal } from "./ui/modals/changedFilesModal";
 import { GeneralModal } from "./ui/modals/generalModal";
 import { IgnoreModal } from "./ui/modals/ignoreModal";
-import { SimpleGit } from "./gitManager/simpleGit";
 
 export function addCommmands(plugin: ObsidianGit) {
     const app = plugin.app;
@@ -143,7 +143,7 @@ export function addCommmands(plugin: ObsidianGit) {
                 return file !== null;
             } else {
                 plugin
-                    .addFileToGitignore(file!.path)
+                    .addFileToGitignore(file!.path, file instanceof TFolder)
                     .catch((e) => plugin.displayError(e));
             }
         },

src/main.ts

@@ -1,5 +1,4 @@
 import { Errors } from "isomorphic-git";
-import * as path from "path";
 import type { Debouncer, Menu, TAbstractFile, WorkspaceLeaf } from "obsidian";
 import {
     debounce,
@@ -10,7 +9,9 @@ import {
     Platform,
     Plugin,
     TFile,
+    TFolder,
 } from "obsidian";
+import * as path from "path";
 import { LineAuthoringFeature } from "src/lineAuthor/lineAuthorIntegration";
 import { pluginRef } from "src/pluginGlobalRef";
 import { PromiseQueue } from "src/promiseQueue";
@@ -24,13 +25,14 @@ import {
     DEFAULT_SETTINGS,
     DIFF_VIEW_CONFIG,
     HISTORY_VIEW_CONFIG,
-    SPLIT_DIFF_VIEW_CONFIG,
     SOURCE_CONTROL_VIEW_CONFIG,
+    SPLIT_DIFF_VIEW_CONFIG,
 } from "./constants";
 import type { GitManager } from "./gitManager/gitManager";
 import { IsomorphicGit } from "./gitManager/isomorphicGit";
 import { SimpleGit } from "./gitManager/simpleGit";
 import { LocalStorageSettings } from "./setting/localStorageSettings";
+import Tools from "./tools";
 import type {
     FileStatusResult,
     ObsidianGitSettings,
@@ -39,19 +41,22 @@ import type {
     UnstagedFile,
 } from "./types";
 import {
+    CurrentGitAction,
     mergeSettingsByPriority,
     NoNetworkError,
-    CurrentGitAction,
 } from "./types";
 import DiffView from "./ui/diff/diffView";
+import SplitDiffView from "./ui/diff/splitDiffView";
 import HistoryView from "./ui/history/historyView";
 import { BranchModal } from "./ui/modals/branchModal";
 import { GeneralModal } from "./ui/modals/generalModal";
 import GitView from "./ui/sourceControl/sourceControl";
 import { BranchStatusBar } from "./ui/statusBar/branchStatusBar";
-import { formatRemoteUrl, splitRemoteBranch } from "./utils";
-import Tools from "./tools";
-import SplitDiffView from "./ui/diff/splitDiffView";
+import {
+    convertPathToAbsoluteGitignoreRule,
+    formatRemoteUrl,
+    splitRemoteBranch,
+} from "./utils";
 
 export default class ObsidianGit extends Plugin {
     gitManager: GitManager;
@@ -319,10 +324,22 @@ export default class ObsidianGit extends Plugin {
         );
     }
 
-    async addFileToGitignore(filePath: string): Promise<void> {
+    async addFileToGitignore(
+        filePath: string,
+        isFolder?: boolean
+    ): Promise<void> {
+        const gitRelativePath = this.gitManager.getRelativeRepoPath(
+            filePath,
+            true
+        );
+        // Define an absolute rule that can apply only for this item.
+        const gitignoreRule = convertPathToAbsoluteGitignoreRule({
+            isFolder,
+            gitRelativePath,
+        });
         await this.app.vault.adapter.append(
             this.gitManager.getRelativeVaultPath(".gitignore"),
-            "\n" + this.gitManager.getRelativeRepoPath(filePath, true)
+            "\n" + gitignoreRule
         );
         return this.refresh();
     }
@@ -389,9 +406,10 @@ export default class ObsidianGit extends Plugin {
                     .setIcon("file-x")
                     .setSection("action")
                     .onClick((_) => {
-                        this.addFileToGitignore(filePath).catch((e) =>
-                            this.displayError(e)
-                        );
+                        this.addFileToGitignore(
+                            filePath,
+                            file instanceof TFolder
+                        ).catch((e) => this.displayError(e));
                     });
             });
         }
@@ -402,9 +420,10 @@ export default class ObsidianGit extends Plugin {
                     .setIcon("file-x")
                     .setSection("action")
                     .onClick((_) => {
-                        this.addFileToGitignore(filePath).catch((e) =>
-                            this.displayError(e)
-                        );
+                        this.addFileToGitignore(
+                            filePath,
+                            file instanceof TFolder
+                        ).catch((e) => this.displayError(e));
                     });
             });
             const gitManager = this.app.vault.adapter;

src/utils.ts

@@ -206,3 +206,28 @@ export function fileOpenableInObsidian(
         return true;
     }
 }
+
+export function convertPathToAbsoluteGitignoreRule({
+    isFolder,
+    gitRelativePath,
+}: {
+    isFolder?: boolean;
+    gitRelativePath: string;
+}): string {
+    // Add a leading slash to set the rule as absolute from root, so it only excludes that exact path
+    let composedPath = "/";
+
+    composedPath += gitRelativePath;
+
+    // Add an explicit folder rule, so that the same path doesn't also apply for files with that same name
+    if (isFolder) {
+        composedPath += "/";
+    }
+
+    // Escape special characters, so that git treats them as literal characters.
+    const escaped = composedPath.replace(/([\\!#*?[\]])/g, String.raw`\$1`);
+
+    // Then escape each trailing whitespace character individually, because git trims trailing whitespace from the end of the rule.
+    // Files normally end with a file extension, not whitespace, but a file with trailing whitespace can appear if Obsidian's "Detect all file extensions" setting is turned on.
+    return escaped.replace(/\s(?=\s*$)/g, String.raw`\ `);
+}