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.
 
jonschlinkert 0d335eb3ff
minor edit
7 years ago
test adds promise support 7 years ago
.editorconfig run update 7 years ago
.eslintrc.json run update 7 years ago
.gitattributes first commit 10 years ago
.gitignore run update 7 years ago
.travis.yml adds promise support 7 years ago
.verb.md adds promise support 7 years ago
LICENSE run update 7 years ago
README.md adds promise support 7 years ago
example.js adds promise support 7 years ago
index.js minor edit 7 years ago
package.json adds promise support 7 years ago

README.md

parse-git-config NPM version NPM monthly downloads NPM total downloads Linux Build Status

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.
  • cb {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();

.keys

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

Params

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

Example

const config = parse.sync();
const obj = parse.keys(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

You might also be interested in these projects:

Contributors

Commits Contributor
51 jonschlinkert
1 sam3d
1 js-n

Author

Jon Schlinkert

License

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


This file was generated by verb-generate-readme, v0.6.0, on January 23, 2018.