Skip to content

Commit 5f5c095

Browse files
committed
Add docs comments for listFiles and getGeneratedFiles
1 parent c7d0b92 commit 5f5c095

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/git-utils.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,11 @@ export async function isAnalyzingDefaultBranch(): Promise<boolean> {
400400
return currentRef === defaultBranch;
401401
}
402402

403+
/**
404+
* Gets a list of all tracked files in the repository.
405+
*
406+
* @param workingDirectory The working directory, which is part of a Git repository.
407+
*/
403408
export async function listFiles(workingDirectory: string): Promise<string[]> {
404409
const stdout = await runGitCommand(
405410
workingDirectory,
@@ -409,6 +414,11 @@ export async function listFiles(workingDirectory: string): Promise<string[]> {
409414
return stdout.split(os.EOL);
410415
}
411416

417+
/**
418+
* Gets a list of files that have the `linguist-generated: true` attribute.
419+
*
420+
* @param workingDirectory The working directory, which is part of a Git repository.
421+
*/
412422
export async function getGeneratedFiles(
413423
workingDirectory: string,
414424
): Promise<string[]> {

0 commit comments

Comments
 (0)