| title | sidebar_label |
|---|---|
listFiles |
listFiles |
List all the files in the git index or a commit
| param | type [= default] | description |
|---|---|---|
| core | string = 'default' | The plugin core identifier to use for plugin injection |
| fs [deprecated] | FileSystem | The filesystem containing the git repo. Overrides the fs provided by the plugin system. |
| dir | string | The working tree directory path |
| gitdir | string = join(dir,'.git') | The git directory path |
| ref | string | Return a list of all the files in the commit at ref instead of the files currently in the git index (aka staging area) |
| return | Promise<Array<string>> | Resolves successfully with an array of filepaths |
Note: This function is efficient for listing the files in the staging area, but listing all the files in a commit requires recursively walking through the git object store. If you do not require a complete list of every file, better can be achieved by using readObject directly and ignoring subdirectories you don't care about.
Example Code:
// All the files in the previous commit
let files = await git.listFiles({ dir: '$input((/))', ref: '$input((HEAD))' })
console.log(files)
// All the files in the current staging area
files = await git.listFiles({ dir: '$input((/))' })
console.log(files)