is-git-repository

What is is-git-repository?

The is-git-repository npm package is a utility that allows you to check if a given directory is a Git repository. It is useful for scripts and tools that need to verify the presence of a Git repository before performing certain operations.

What are is-git-repository's main functionalities?

Check if a directory is a Git repository

This feature allows you to check if a specified directory is a Git repository. The function takes a path and a callback function. The callback function receives an error object and a boolean indicating whether the directory is a Git repository.

const isGitRepo = require('is-git-repository');

const path = '/path/to/directory';

isGitRepo(path, (err, result) => {
  if (err) {
    console.error(err);
  } else {
    console.log(result ? 'This is a Git repository' : 'This is not a Git repository');
  }
});

Other packages similar to is-git-repository

simple-git

simple-git is a lightweight interface for running Git commands in any node.js application. Unlike is-git-repository, which only checks if a directory is a Git repository, simple-git provides a wide range of Git functionalities such as cloning repositories, committing changes, and more.

nodegit

nodegit is a native Node.js library that provides a comprehensive set of Git functionalities. It allows you to perform various Git operations programmatically, such as creating branches, merging, and more. While is-git-repository is focused on checking the existence of a Git repository, nodegit offers a full suite of Git operations.

isomorphic-git

isomorphic-git 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 cloning, committing, and pushing changes. Compared to is-git-repository, isomorphic-git offers a more extensive set of features for interacting with Git repositories.

README

is-git-repository

Checks synchronously if a specific directory is a git repository

Installation

$ npm i is-git-repository --save

or

$ yarn add is-git-repository

Usage

const isGit = require('is-git-repository');

isGit(); // true or false of process.cwd()
isGit('any/git/repo'); // true or false

LICENSE

MIT © Jan Peer Stöcklmair