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.
 
Sam Holmes 622c3be598
Update license to use valid SPDX expression
9 years ago
.editorconfig first commit 10 years ago
.gitattributes first commit 10 years ago
.gitignore first commit 10 years ago
.jshintrc first commit 10 years ago
.travis.yml adds travis 10 years ago
.verb.md udpate/rebuild docs 10 years ago
LICENSE first commit 10 years ago
README.md udpate/rebuild docs 10 years ago
index.js lint 10 years ago
package.json Update license to use valid SPDX expression 9 years ago
test.js lint 10 years ago

README.md

parse-git-config NPM version Build Status

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

Install with npm

npm i parse-git-config --save

Usage

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

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:

{ 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: Parse a github URL into an object.
  • parse-gitignore: Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.
  • parse-author: Parse a string into an object with name, email and url properties following npm conventions.… more
  • parse-authors: Parse a string into an array of objects with name, email and url properties following… more

Run tests

Install dev dependencies:

npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

github/jonschlinkert twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on April 29, 2015.