You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
2.5 KiB
Markdown
90 lines
2.5 KiB
Markdown
# parse-git-config [](http://badge.fury.io/js/parse-git-config) [](https://travis-ci.org/jonschlinkert/parse-git-config)
|
|
|
|
> Parse `.git/config` into a JavaScript object. sync or async.
|
|
|
|
## Install with [npm](npmjs.org)
|
|
|
|
```bash
|
|
npm i parse-git-config --save
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var git = require('parse-git-config');
|
|
|
|
// sync
|
|
var config = git.sync();
|
|
|
|
// or async
|
|
git(function (err, config) {
|
|
// do stuff with err/config
|
|
});
|
|
```
|
|
|
|
**Custom path and/or cwd**
|
|
|
|
```js
|
|
git.sync({cwd: 'foo', path: '.git/config'});
|
|
|
|
// async
|
|
git({cwd: 'foo', path: '.git/config'}, function (err, config) {
|
|
// do stuff
|
|
});
|
|
```
|
|
|
|
**Example result**
|
|
|
|
Config object will be something like:
|
|
|
|
```js
|
|
{ core:
|
|
{ repositoryformatversion: '0',
|
|
filemode: true,
|
|
bare: false,
|
|
logallrefupdates: true,
|
|
ignorecase: true,
|
|
precomposeunicode: true },
|
|
'remote "origin"':
|
|
{ url: 'https://github.com/jonschlinkert/parse-git-config.git',
|
|
fetch: '+refs/heads/*:refs/remotes/origin/*' },
|
|
'branch "master"': { remote: 'origin', merge: 'refs/heads/master', ... } }
|
|
```
|
|
|
|
## Other useful projects
|
|
|
|
* [parse-github-url](https://github.com/jonschlinkert/parse-github-url): Parse a github URL into an object.
|
|
* [parse-gitignore](https://github.com/jonschlinkert/parse-gitignore): Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.
|
|
* [parse-author](https://github.com/jonschlinkert/parse-author): Parse a string into an object with `name`, `email` and `url` properties following npm conventions.… [more](https://github.com/jonschlinkert/parse-author)
|
|
* [parse-authors](https://github.com/jonschlinkert/parse-authors): Parse a string into an array of objects with `name`, `email` and `url` properties following… [more](https://github.com/jonschlinkert/parse-authors)
|
|
|
|
## Run tests
|
|
|
|
Install dev dependencies:
|
|
|
|
```bash
|
|
npm i -d && npm test
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/parse-git-config/issues)
|
|
|
|
## Author
|
|
|
|
**Jon Schlinkert**
|
|
|
|
[github/jonschlinkert](https://github.com/jonschlinkert)
|
|
[twitter/jonschlinkert](http://twitter.com/jonschlinkert)
|
|
|
|
## License
|
|
|
|
Copyright (c) 2015 Jon Schlinkert
|
|
Released under the MIT license.
|
|
|
|
***
|
|
|
|
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on April 29, 2015._
|
|
|
|
<!-- reflinks generated by verb-reflinks plugin -->
|