15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 01:33:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add bad CWD case for getGitRepoRoot API

This commit is contained in:
sebastien 2025-11-07 12:29:04 +01:00
parent 0623b00fc4
commit 7a4d3f790c
2 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
packages/docusaurus-utils/src/vcs/__tests__/gitUtils.test.ts
View File

@ -310,9 +310,9 @@ describe('commit info APIs', () => {
describe('getGitRepoRoot', () => {
async function initTestRepo() {
const {repoDir, git} = await createGitRepoEmpty();
await fs.mkdir(path.join(repoDir, 'subdir'));
await fs.mkdir(path.join(repoDir, 'subDir'));
await fs.writeFile(
path.join(repoDir, 'subdir', 'test.txt'),
path.join(repoDir, 'subDir', 'test.txt'),
'Some content',
);
await git.commit(
@ -328,4 +328,18 @@ describe('getGitRepoRoot', () => {
const cwd = repoDir;
await expect(getGitRepoRoot(cwd)).resolves.toEqual(repoDir);
});
it('returns repoDir for cwd=repoDir/subDir', async () => {
const repoDir = await initTestRepo();
const cwd = path.join(repoDir, 'subDir');
await expect(getGitRepoRoot(cwd)).resolves.toEqual(repoDir);
});
it('returns repoDir for cwd=repoDir/doesNotExist', async () => {
const repoDir = await initTestRepo();
const cwd = path.join(repoDir, 'doesNotExist');
await expect(getGitRepoRoot(cwd)).rejects.toThrow(
/Couldn't find the git repository root directory/,
);
});
});

19
packages/docusaurus-utils/src/vcs/gitUtils.ts
View File

@ -264,13 +264,30 @@ export async function getGitCreation(
}
export async function getGitRepoRoot(cwd: string): Promise<string> {
const createErrorMessageBase = () => {
return `Couldn't find the git repository root directory
Running ${logger.code('git rev-parse --show-toplevel')} from cwd=${logger.path(
cwd,
)})`;
};
const result = await execa('git', ['rev-parse', '--show-toplevel'], {
cwd,
}).catch((error) => {
// We enter this rejection when cwd is not a dir for example
throw new Error(
`${createErrorMessageBase()}
The command executed throws an error`,
{cause: error},
);
});
if (result.exitCode !== 0) {
throw new Error(
`Failed to retrieve the git repository root with exit code ${result.exitCode}: ${result.stderr}`,
`${createErrorMessageBase()}
The command returned exit code ${logger.code(result.exitCode)}: ${logger.subdue(
result.stderr,
)}`,
);
}