remove
Remove a file from the git index (aka staging area)
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 |
filepath | string | The path to the file to remove from the index |
return | Promise<void> | Resolves successfully once the git index has been updated |
Note that this does NOT delete the file in the working directory.
Example Code:
await git.remove({ dir: '$input((/))', filepath: '$input((README.md))' })
console.log('done')