getConfig
Read an entry from the git config files.
| param | type [= default] | description |
|---|---|---|
| fs | FsClient | a file system implementation |
| dir | string | The working tree directory path |
| gitdir | string = join(dir,'.git') | The git directory path |
| path | string | The key of the git config entry |
| return | Promise<any> | Resolves with the config value |
Caveats:
- Currently only the local
$GIT_DIR/configfile can be read or written. However support for the global~/.gitconfigand system$(prefix)/etc/gitconfigwill be added in the future. - The current parser does not support the more exotic features of the git-config file format such as
[include]and[includeIf].
Example Code:
// Read config value
let value = await git.getConfig({
fs,
dir: '/tutorial',
path: 'remote.origin.url'
})
console.log(value)
Tip: If you need a clean slate, expand and run this snippet to clean up the file system.
window.fs = new LightningFS('fs', { wipe: true })
window.pfs = window.fs.promises
console.log('done')