Add git root directory support to Git functions

Introduce getGitRootDir function to consistently determine the Git root directory for executing Git commands. This change modifies existing Git utility functions to use the -C flag with the root directory, ensuring that all operations execute in the correct repository context, which enhances reliability when scripts are run from subdirectories.

Release-Note: Add support for executing Git commands from any subdirectory within a repository

Signed-off-by: Ian Skelskey <[email protected]>

Author: IanSkelskey

src/util/git.ts

@@ -14,6 +14,14 @@ export enum GitFileStatus {
     '!' = 'Ignored',
 }
 
+export function getGitRootDir(): string {
+    try {
+        return execSync('git rev-parse --show-toplevel', { encoding: 'utf-8' }).trim();
+    } catch (error) {
+        throw new Error('Unable to determine git repository root directory.');
+    }
+}
+
 export function isInGitRepo(): boolean {
     try {
         execSync('git rev-parse --is-inside-work-tree', { stdio: 'ignore' });
@@ -25,7 +33,8 @@ export function isInGitRepo(): boolean {
 
 export function pushChanges(): void {
     try {
-        execSync('git push');
+        const gitRoot = getGitRootDir();
+        execSync(`git -C "${gitRoot}" push`);
     } catch (error: any) {
         if (error.message.includes('fatal: The current branch')) {
             throw new Error('The current branch has no upstream branch.');
@@ -43,35 +52,42 @@ export function setUserEmail(email: string): void {
 
 export function setupUpstreamBranch(): void {
     const branchName = getCurrentBranchName();
-    execSync(`git push --set-upstream origin ${branchName}`);
+    const gitRoot = getGitRootDir();
+    execSync(`git -C "${gitRoot}" push --set-upstream origin ${branchName}`);
 }
 
 export function stageAllFiles(): void {
-    execSync('git add .');
+    const gitRoot = getGitRootDir();
+    execSync(`git -C "${gitRoot}" add .`);
 }
 
 export function stageFile(filePath: string): void {
-    execSync(`git add ${filePath}`);
+    const gitRoot = getGitRootDir();
+    execSync(`git -C "${gitRoot}" add "${filePath}"`);
 }
 
 export function unstageFile(filePath: string): void {
-    execSync(`git restore --staged ${filePath}`);
+    const gitRoot = getGitRootDir();
+    execSync(`git -C "${gitRoot}" restore --staged "${filePath}"`);
 }
 
 export function unstageAllFiles(): void {
-    execSync('git restore --staged .');
+    const gitRoot = getGitRootDir();
+    execSync(`git -C "${gitRoot}" restore --staged .`);
 }
 
 export function listChangedFiles(): string[] {
-    const statusOutput = execSync('git status --porcelain').toString().trim();
+    const gitRoot = getGitRootDir();
+    const statusOutput = execSync(`git -C "${gitRoot}" status --porcelain`).toString().trim();
     return statusOutput
         .split('\n')
         .map((line) => line.trim().slice(2))
         .filter(Boolean);
 }
 
 export function getStatusForFile(filePath: string): GitFileStatus {
-    const status = execSync(`git status --porcelain "${filePath}"`).toString().trim();
+    const gitRoot = getGitRootDir();
+    const status = execSync(`git -C "${gitRoot}" status --porcelain "${filePath}"`).toString().trim();
     if (!status) {
         return GitFileStatus['!'];
     }
@@ -81,7 +97,8 @@ export function getStatusForFile(filePath: string): GitFileStatus {
 export function getDiffForStagedFiles(): string {
     const maxBufferSize = 10 * 1024 * 1024; // 10 MB buffer
     try {
-        let diff: string = execSync('git diff --staged', { maxBuffer: maxBufferSize }).toString();
+        const gitRoot = getGitRootDir();
+        let diff: string = execSync(`git -C "${gitRoot}" diff --staged`, { maxBuffer: maxBufferSize }).toString();
         diff = removeDiffForFile(diff, 'package-lock.json');
         return diff;
     } catch (error: any) {
@@ -102,7 +119,8 @@ function removeDiffForFile(diff: string, filePath: string): string {
 
 export function getCurrentBranchName(): string {
     try {
-        const branchName = execSync('git rev-parse --abbrev-ref HEAD', {
+        const gitRoot = getGitRootDir();
+        const branchName = execSync(`git -C "${gitRoot}" rev-parse --abbrev-ref HEAD`, {
             encoding: 'utf-8',
         }).trim();
 
@@ -113,7 +131,8 @@ export function getCurrentBranchName(): string {
 }
 
 export function hasGitChanges(): boolean {
-    const status = execSync('git status --porcelain').toString().trim();
+    const gitRoot = getGitRootDir();
+    const status = execSync(`git -C "${gitRoot}" status --porcelain`).toString().trim();
     return status.length > 0;
 }
 
@@ -126,11 +145,12 @@ export function getEmail(): string {
 }
 
 export function commitWithMessage(message: string): void {
+    const gitRoot = getGitRootDir();
     const sanitizedMessage = sanitizeCommitMessage(message);
     const tempFilePath = path.join(os.tmpdir(), 'commit-message.txt');
 
     fs.writeFileSync(tempFilePath, sanitizedMessage);
-    execSync(`git commit -F "${tempFilePath}"`);
+    execSync(`git -C "${gitRoot}" commit -F "${tempFilePath}"`);
     fs.unlinkSync(tempFilePath); // Clean up the temporary file
 }
 
@@ -139,12 +159,14 @@ function sanitizeCommitMessage(message: string): string {
 }
 
 export function checkForRemote(remoteUrl: string): boolean {
-    const remoteUrls = execSync('git remote -v').toString();
+    const gitRoot = getGitRootDir();
+    const remoteUrls = execSync(`git -C "${gitRoot}" remote -v`).toString();
     return remoteUrls.includes(remoteUrl);
 }
 
 export function getRemoteName(remoteUrl: string): string {
-    const remoteUrls = execSync('git remote -v').toString();
+    const gitRoot = getGitRootDir();
+    const remoteUrls = execSync(`git -C "${gitRoot}" remote -v`).toString();
     const remoteName = remoteUrls.split('\n').find((line: string) => line.includes(remoteUrl));
     return remoteName ? remoteName.split('\t')[0] : '';
 }