Skip to content

Commit 93e95c8

Browse files
committed
Update README with new arguments
1 parent 6b3ad13 commit 93e95c8

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,26 @@ In addition to `CommitFilesBasedArgs`, this function has the following arguments
9393
/**
9494
* The root of the repository.
9595
*
96-
* @default process.cwd()
96+
* When unspecified, the root of the repository will be found by recursively
97+
* searching for the `.git` directory from the current working directory.
9798
*/
9899
repoDirectory?: string;
100+
/**
101+
* The starting directory to recurse from when detecting changed files.
102+
*
103+
* Useful for monorepos where you want to add files from a specific directory only.
104+
*
105+
* Defaults to resolved value of {@link repoDirectory},
106+
* which will add all changed files in the repository.
107+
*/
108+
addFromDirectory?: string;
109+
/**
110+
* An optional function that can be used to filter which files are included
111+
* in the commit. True should be returned for files that should be included.
112+
*
113+
* By default, all files are included.
114+
*/
115+
filterFiles?: (file: string) => boolean;
99116
}
100117
```
101118

0 commit comments

Comments
 (0)