@moyuyc/parse-git-config

parse-git-config

Forked from jonschlinkert/parse-git-config, But the origin using util.promisify which requires Node.js 8, so this one is compatible with node >= 6

See the PR

Parse .git/config into a JavaScript object. sync or async.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save parse-git-config

Usage

const parse = require('parse-git-config')

// sync
const config = parse.sync()

// or async
parse(function(err, config) {
  // do stuff with err/config
})

Custom path and/or cwd

parse.sync({ cwd: 'foo', path: '.git/config' })

// async
parse({ cwd: 'foo', path: '.git/config' }, function(err, config) {
  // do stuff
})

Example result

Config object will be something like:

{ 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', ... } }

API

parse

Asynchronously parse a .git/config file. If only the callback is passed, the .git/config file relative to process.cwd() is used.

Params

• options {Object|String|Function}: Options with cwd or path, the cwd to use, or the callback function.
• callback {Function}: callback function if the first argument is options or cwd.
• returns {Object}

Example

parse(function(err, config) {
  if (err) throw err
  // do stuff with config
})

.sync

Parse the given

Params

• options {Object|String}: Options with cwd or path, or the cwd to use.
• returns {Object}

Example

parse
  .promise({ path: '/path/to/.gitconfig' })
  .then(config => console.log(config))

.sync

Synchronously parse a .git/config file. If no arguments are passed, the .git/config file relative to process.cwd() is used.

Params

• options {Object|String}: Options with cwd or path, or the cwd to use.
• returns {Object}

Example

const config = parse.sync()

.expandKeys

Returns an object with only the properties that had ini-style keys converted to objects.

Params

• config {Object}: The parsed git config object.
• returns {Object}

Example

const config = parse.sync({ path: '/path/to/.gitconfig' })
const obj = parse.expandKeys(config)

.keys examples

Converts ini-style keys into objects:

Example 1

const parse = require('parse-git-config')
const config = {
  'foo "bar"': { doStuff: true },
  'foo "baz"': { doStuff: true }
}

console.log(parse.keys(config))

Results in:

{
  foo: {
    bar: { doStuff: true },
    baz: { doStuff: true }
  }
}

Example 2

const parse = require('parse-git-config')
const 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:

{
  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
    }
  }
}

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
• git-username: Get the username from a git remote origin URL. | homepage
• parse-author: Parse an author, contributor, maintainer or other 'person' string into an object with name, email… more | homepage
• parse-authors: Parse a string into an array of objects with name, email and url properties following… more | homepage
• parse-github-url: Parse a github URL into an object. | homepage
• parse-gitignore: Parse a gitignore file into an array of patterns. Comments and empty lines are stripped. | homepage

Contributors

Commits	Contributor
51	jonschlinkert
1	sam3d
1	js-n

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on February 14, 2018.