feat(utils): implement helpers for making paths relative to git root

Author: matejchalk

packages/utils/src/index.ts

@@ -22,6 +22,10 @@ export {
   readTextFile,
   removeDirectoryIfExists,
 } from './lib/file-system';
+export {
+  filterAuditsBySlug,
+  filterGroupsByAuditSlug,
+} from './lib/filter-by-slug';
 export {
   formatBytes,
   formatDuration,
@@ -33,13 +37,20 @@ export {
   truncateText,
   truncateTitle,
 } from './lib/formatting';
-export { getLatestCommit, git, validateCommitData } from './lib/git';
+export {
+  formatGitPath,
+  getGitRoot,
+  getLatestCommit,
+  toGitPath,
+  validateCommitData,
+} from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export {
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
 } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
+export { link } from './lib/logging';
 export { ProgressBar, getProgressBar } from './lib/progress';
 export { TERMINAL_WIDTH } from './lib/reports/constants';
 export { generateMdReport } from './lib/reports/generate-md-report';
@@ -71,8 +82,3 @@ export {
   toUnixPath,
 } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
-export { link } from './lib/logging';
-export {
-  filterAuditsBySlug,
-  filterGroupsByAuditSlug,
-} from './lib/filter-by-slug';

packages/utils/src/lib/git.integration.test.ts

@@ -1,18 +1,63 @@
+import { mkdir, rm, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { type SimpleGit, simpleGit } from 'simple-git';
 import { expect } from 'vitest';
-import { getLatestCommit } from './git';
+import { getGitRoot, getLatestCommit, toGitPath } from './git';
+import { toUnixPath } from './transform';
 
-const gitCommitDateRegex =
-  /^(Mon|Tue|Wed|Thu|Fri|Sat|Sun) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{1,2} \d{2}:\d{2}:\d{2} \d{4} [+|-]\d{4}$/;
+describe('git utils', () => {
+  const baseDir = join(process.cwd(), 'tmp', 'testing-git-repo');
+  let git: SimpleGit;
+
+  beforeAll(async () => {
+    await mkdir(baseDir, { recursive: true });
+    await writeFile(join(baseDir, 'README.md'), '# hello-world\n');
+
+    git = simpleGit(baseDir);
+    await git.init();
+
+    await git.addConfig('user.name', 'John Doe');
+    await git.addConfig('user.email', '[email protected]');
+
+    await git.add('README.md');
+    await git.commit('Create README');
+  });
+
+  afterAll(async () => {
+    await rm(baseDir, { recursive: true, force: true });
+  });
 
-describe('getLatestCommit', () => {
   it('should log latest commit', async () => {
-    await expect(getLatestCommit()).resolves.toEqual(
-      expect.objectContaining({
-        hash: expect.stringMatching(/^[\da-f]{40}$/),
-        message: expect.stringMatching(/.+/),
-        author: expect.stringMatching(/.+/),
-        date: expect.stringMatching(gitCommitDateRegex),
-      }),
+    const gitCommitDateRegex =
+      /^(Mon|Tue|Wed|Thu|Fri|Sat|Sun) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{1,2} \d{2}:\d{2}:\d{2} \d{4} [+|-]\d{4}$/;
+
+    await expect(getLatestCommit(git)).resolves.toEqual({
+      hash: expect.stringMatching(/^[\da-f]{40}$/),
+      message: 'Create README',
+      author: 'John Doe',
+      date: expect.stringMatching(gitCommitDateRegex),
+    });
+  });
+
+  it('should find Git root', async () => {
+    await expect(getGitRoot(git)).resolves.toBe(toUnixPath(baseDir));
+  });
+
+  it('should convert absolute path to relative Git path', async () => {
+    await expect(
+      toGitPath(join(process.cwd(), 'src', 'utils.ts')),
+    ).resolves.toBe('src/utils.ts');
+  });
+
+  it('should convert relative Windows path to relative Git path', async () => {
+    await expect(toGitPath('Backend\\API\\Startup.cs')).resolves.toBe(
+      'Backend/API/Startup.cs',
+    );
+  });
+
+  it('should keep relative Unix path as is (already a Git path)', async () => {
+    await expect(toGitPath('Backend/API/Startup.cs')).resolves.toBe(
+      'Backend/API/Startup.cs',
     );
   });
 });

packages/utils/src/lib/git.ts

@@ -1,4 +1,6 @@
+import { isAbsolute, join, relative } from 'node:path';
 import { simpleGit } from 'simple-git';
+import { toUnixPath } from './transform';
 
 export type CommitData = {
   hash: string;
@@ -7,19 +9,35 @@ export type CommitData = {
   date: string;
 };
 
-export const git = simpleGit();
-
-export async function getLatestCommit() {
+export async function getLatestCommit(git = simpleGit()) {
   // git log -1 --pretty=format:"%H %s %an %ad" // logs hash, message, author, date
   const log = await git.log({
     maxCount: 1,
     format: { hash: '%H', message: '%s', author: '%an', date: '%ad' },
   });
-  return log.latest;
+  return log.latest satisfies CommitData | null;
+}
+
+export function getGitRoot(git = simpleGit()): Promise<string> {
+  return git.revparse('--show-toplevel');
+}
+
+export function formatGitPath(path: string, gitRoot: string): string {
+  const absolutePath = isAbsolute(path) ? path : join(process.cwd(), path);
+  const relativePath = relative(gitRoot, absolutePath);
+  return toUnixPath(relativePath);
+}
+
+export async function toGitPath(
+  path: string,
+  git = simpleGit(),
+): Promise<string> {
+  const gitRoot = await getGitRoot(git);
+  return formatGitPath(path, gitRoot);
 }
 
 export function validateCommitData(
-  commitData?: unknown,
+  commitData: CommitData | null,
   options: { throwError?: boolean } = {},
 ): commitData is CommitData {
   const { throwError = false } = options;