parse-git-config

What is parse-git-config?

The parse-git-config npm package is a utility for parsing git configuration files. It allows developers to read and interpret the configuration settings of git repositories programmatically. This can be useful for automating tasks, creating development tools, or integrating with other software that needs to understand git configurations.

What are parse-git-config's main functionalities?

Parse local git configuration

This feature allows you to parse the git configuration file of a local repository. The function takes options specifying the working directory and the path to the git config file, then returns the configuration as an object.

const parseGitConfig = require('parse-git-config');
parseGitConfig({ cwd: '/path/to/repo', path: '.git/config' }, (err, config) => {
  if (err) throw err;
  console.log(config);
});

Synchronously parse git config

This feature provides a synchronous method to parse the git config file. It is useful when you need to get the configuration data immediately without dealing with asynchronous callbacks.

const parseGitConfig = require('parse-git-config');
const config = parseGitConfig.sync({ cwd: '/path/to/repo', path: '.git/config' });
console.log(config);

Expand include paths

This feature supports expanding include directives in git config files, allowing you to see the full configuration with included paths resolved. This is particularly useful for complex configurations that use multiple included files.

const parseGitConfig = require('parse-git-config');
parseGitConfig.expandKeys({ include: true }).then(config => {
  console.log(config);
});

Other packages similar to parse-git-config

git-config

git-config is another npm package that reads and parses git configuration files. Unlike parse-git-config, git-config focuses more on providing a simpler and more direct approach to accessing git config values without the additional features for handling includes or synchronous parsing.

ini

The ini package is used to parse INI files, which is the format used by git config files. While not specifically designed for git, it can be used to parse any INI file, including git configs. It lacks the git-specific enhancements of parse-git-config, such as understanding git-specific properties or includes.

README

parse-git-config

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

Install

Install with npm:

$ npm install parse-git-config --save

Usage

var parse = require('parse-git-config');

// sync
var 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

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

var 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

var config = parse.sync();
var obj = parse.keys(config);

.keys examples

Converts ini-style keys into objects:

Example 1

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

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:

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

Related 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 a string into an object with name, email and url properties following npm conventions.… 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

Contributing

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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb, v0.9.0, on March 19, 2016.