parse-git-config
Advanced tools
Package description
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.
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);
});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.
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/configinto a JavaScript object. sync or async.
Install with npm:
$ npm install --save parse-git-config
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', ... } }
Asynchronously parse a .git/config file. If only the callback is passed, the .git/config file relative to process.cwd() is used.
Example
parse(function(err, config) {
if (err) throw err;
// do stuff with config
});
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}Synchronously parse a .git/config file. If no arguments are passed, the .git/config file relative to process.cwd() is used.
Example
var config = parse.sync();
Params
options {Object|String}: Options with cwd or path, or the cwd to use.returns {Object}Returns an object with only the properties that had ini-style keys converted to objects (example below).
Example
var config = parse.sync();
var obj = parse.keys(config);
Params
config {Object}: The parsed git config object.returns {Object}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
}
}
}
name, email and url properties following npm conventions… more | homepagename, email and url properties following… more | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 33 | jonschlinkert |
| 1 | sam3d |
| 1 | jsdnxx |
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.2.0, on October 26, 2016.
FAQs
Parse `.git/config` into a JavaScript object. sync or async.
The npm package parse-git-config receives a total of 1,137,165 weekly downloads. As such, parse-git-config popularity was classified as popular.
We found that parse-git-config demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.