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.

237 lines
7.2 KiB
Markdown

8 years ago
# parse-git-config [![NPM version](https://img.shields.io/npm/v/parse-git-config.svg?style=flat)](https://www.npmjs.com/package/parse-git-config) [![NPM monthly downloads](https://img.shields.io/npm/dm/parse-git-config.svg?style=flat)](https://npmjs.org/package/parse-git-config) [![NPM total downloads](https://img.shields.io/npm/dt/parse-git-config.svg?style=flat)](https://npmjs.org/package/parse-git-config) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/parse-git-config.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/parse-git-config)
10 years ago
> Parse `.git/config` into a JavaScript object. sync or async.
## Install
10 years ago
Install with [npm](https://www.npmjs.com/):
```sh
8 years ago
$ npm install --save parse-git-config
10 years ago
```
## Usage
```js
9 years ago
var parse = require('parse-git-config');
10 years ago
// sync
9 years ago
var config = parse.sync();
10 years ago
// or async
9 years ago
parse(function (err, config) {
10 years ago
// do stuff with err/config
});
```
**Custom path and/or cwd**
```js
9 years ago
parse.sync({cwd: 'foo', path: '.git/config'});
// async
9 years ago
parse({cwd: 'foo', path: '.git/config'}, function (err, config) {
// do stuff
});
```
**Example result**
10 years ago
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', ... } }
```
9 years ago
## API
8 years ago
### [parse](index.js#L34)
9 years ago
Asynchronously parse a `.git/config` file. If only the callback is passed, the `.git/config` file relative to `process.cwd()` is used.
**Example**
```js
parse(function(err, config) {
if (err) throw err;
// do stuff with config
});
```
**Params**
8 years ago
* `options` **{Object|String|Function}**: Options with `cwd` or `path`, the cwd to use, or the callback function.
* `cb` **{Function}**: callback function if the first argument is options or cwd.
9 years ago
* `returns` **{Object}**
8 years ago
### [.sync](index.js#L77)
Synchronously parse a `.git/config` file. If no arguments are passed, the `.git/config` file relative to `process.cwd()` is used.
9 years ago
**Example**
```js
var config = parse.sync();
```
**Params**
8 years ago
* `options` **{Object|String}**: Options with `cwd` or `path`, or the cwd to use.
9 years ago
* `returns` **{Object}**
8 years ago
### [.keys](index.js#L133)
Returns an object with only the properties that had ini-style keys converted to objects (example below).
9 years ago
**Example**
```js
var config = parse.sync();
var obj = parse.keys(config);
```
8 years ago
**Params**
* `config` **{Object}**: The parsed git config object.
* `returns` **{Object}**
9 years ago
### .keys examples
Converts ini-style keys into objects:
**Example 1**
```js
var parse = require('parse-git-config');
var config = {
'foo "bar"': { doStuff: true },
'foo "baz"': { doStuff: true }
};
console.log(parse.keys(config));
```
Results in:
```js
{
foo: {
bar: { doStuff: true },
baz: { doStuff: true }
}
}
```
**Example 2**
```js
var parse = require('parse-git-config');
var config = {
'remote "origin"': {
url: 'https://github.com/jonschlinkert/normalize-pkg.git',
fetch: '+refs/heads/*:refs/remotes/origin/*'
},
'branch "master"': {
remote: 'origin',
merge: 'refs/heads/master'
},
'branch "dev"': {
remote: 'origin',
merge: 'refs/heads/dev',
rebase: true
}
};
console.log(parse.keys(config));
```
Results in:
```js
{
remote: {
origin: {
url: 'https://github.com/jonschlinkert/normalize-pkg.git',
fetch: '+refs/heads/*:refs/remotes/origin/*'
}
},
branch: {
master: {
remote: 'origin',
merge: 'refs/heads/master'
},
dev: {
remote: 'origin',
merge: 'refs/heads/dev',
rebase: true
}
}
}
```
8 years ago
## About
8 years ago
### Related projects
9 years ago
8 years ago
* [git-user-name](https://www.npmjs.com/package/git-user-name): Get a user's name from git config at the project or global scope, depending on… [more](https://github.com/jonschlinkert/git-user-name) | [homepage](https://github.com/jonschlinkert/git-user-name "Get a user's name from git config at the project or global scope, depending on what git uses in the current context.")
* [git-username](https://www.npmjs.com/package/git-username): Get the username from a git remote origin URL. | [homepage](https://github.com/jonschlinkert/git-username "Get the username from a git remote origin URL.")
* [parse-author](https://www.npmjs.com/package/parse-author): Parse a string into an object with `name`, `email` and `url` properties following npm conventions… [more](https://github.com/jonschlinkert/parse-author) | [homepage](https://github.com/jonschlinkert/parse-author "Parse a string into an object with `name`, `email` and `url` properties following npm conventions. Useful for the `authors` property in package.json or for parsing an AUTHORS file into an array of authors objects.")
* [parse-authors](https://www.npmjs.com/package/parse-authors): Parse a string into an array of objects with `name`, `email` and `url` properties following… [more](https://github.com/jonschlinkert/parse-authors) | [homepage](https://github.com/jonschlinkert/parse-authors "Parse a string into an array of objects with `name`, `email` and `url` properties following npm conventions. Useful for the `authors` property in package.json or for parsing an AUTHORS file into an array of authors objects.")
* [parse-github-url](https://www.npmjs.com/package/parse-github-url): Parse a github URL into an object. | [homepage](https://github.com/jonschlinkert/parse-github-url "Parse a github URL into an object.")
* [parse-gitignore](https://www.npmjs.com/package/parse-gitignore): Parse a gitignore file into an array of patterns. Comments and empty lines are stripped. | [homepage](https://github.com/jonschlinkert/parse-gitignore "Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.")
8 years ago
### Contributing
10 years ago
8 years ago
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
10 years ago
8 years ago
### Contributors
10 years ago
8 years ago
| **Commits** | **Contributor**<br/> |
| --- | --- |
| 33 | [jonschlinkert](https://github.com/jonschlinkert) |
| 1 | [sam3d](https://github.com/sam3d) |
| 1 | [jsdnxx](https://github.com/jsdnxx) |
8 years ago
### Building docs
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
10 years ago
8 years ago
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
8 years ago
$ npm install -g verb verb-generate-readme && verb
```
8 years ago
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
10 years ago
8 years ago
### Author
10 years ago
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
10 years ago
8 years ago
### License
9 years ago
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/parse-git-config/blob/master/LICENSE).
10 years ago
***
8 years ago
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 26, 2016._