gitconfiglocal

What is gitconfiglocal?

The gitconfiglocal npm package allows you to read and manipulate local Git configuration files. It provides a simple API to access and modify the .git/config file in a Git repository.

What are gitconfiglocal's main functionalities?

Read Local Git Config

This feature allows you to read the local Git configuration of a repository. The code sample demonstrates how to use the gitconfiglocal package to read the .git/config file of a specified repository.

const gitconfiglocal = require('gitconfiglocal');
const path = require('path');

const repoPath = path.resolve('/path/to/repo');
gitconfiglocal(repoPath, (err, config) => {
  if (err) throw err;
  console.log(config);
});

Modify Local Git Config

This feature allows you to modify the local Git configuration of a repository. The code sample demonstrates how to read the .git/config file, modify the user name and email, and then write the changes back to the file.

const gitconfiglocal = require('gitconfiglocal');
const fs = require('fs');
const ini = require('ini');
const path = require('path');

const repoPath = path.resolve('/path/to/repo');
gitconfiglocal(repoPath, (err, config) => {
  if (err) throw err;
  config.user.name = 'New User';
  config.user.email = '[e-mail]';
  fs.writeFileSync(path.join(repoPath, '.git', 'config'), ini.stringify(config));
});

Other packages similar to gitconfiglocal

simple-git

The simple-git package provides a simple interface for running Git commands in any Node.js application. It allows you to execute Git commands programmatically and handle the results. Unlike gitconfiglocal, which focuses on reading and modifying the .git/config file, simple-git provides a broader range of Git functionalities.

nodegit

The nodegit package is a native Node.js binding to the libgit2 library, which provides a comprehensive set of Git functionalities. It allows you to perform various Git operations, such as cloning repositories, creating branches, and committing changes. While gitconfiglocal is specialized in handling Git configuration files, nodegit offers a more extensive set of Git-related features.

isomorphic-git

The isomorphic-git package is a pure JavaScript implementation of Git that works in both Node.js and browser environments. It provides a wide range of Git functionalities, including reading and writing Git configuration files. Compared to gitconfiglocal, isomorphic-git offers a more versatile solution that can be used in different environments.

README

gitconfiglocal

parse the .git/config file into a useful data structure

example

• search config in $GIT_DIR (.git by default)

var gitconfig = require('gitconfiglocal');

gitconfig('./',function(err,config){
  console.log(config);
  /* prints:
  { core:
     { repositoryformatversion: '0',
       filemode: true,
       bare: false,
       logallrefupdates: true },
    remote:
     { origin:
        { url: '[e-mail]:soldair/node-gitconfiglocal.git',
          fetch: '+refs/heads/*:refs/remotes/origin/*' } } }
  */
});

• specify $GIT_DIR via options:

gitconfig('./', { gitDir: 'path/to/gitdir' }, cb);