current-git-branch

What is current-git-branch?

The `current-git-branch` npm package is a simple utility that allows you to get the name of the current Git branch in a Node.js environment. It is useful for scripts and tools that need to be aware of the current branch context.

What are current-git-branch's main functionalities?

Get Current Git Branch

This feature allows you to retrieve the name of the current Git branch. The code sample demonstrates how to use the `current-git-branch` package to get the branch name and print it to the console.

const currentGitBranch = require('current-git-branch');
const branchName = currentGitBranch();
console.log(branchName);

Other packages similar to current-git-branch

git-branch

The `git-branch` package provides similar functionality to `current-git-branch` by allowing you to get the current Git branch name. It also offers additional features like listing all branches and checking out a branch. Compared to `current-git-branch`, it is more feature-rich but also slightly more complex to use.

git-rev-sync

The `git-rev-sync` package offers a broader range of Git-related functionalities, including getting the current branch name, the latest commit hash, and the commit message. It is more comprehensive than `current-git-branch` but may be overkill if you only need to get the current branch name.

simple-git

The `simple-git` package is a lightweight interface for running Git commands in a Node.js environment. It can be used to get the current branch name among many other Git operations. It is more versatile than `current-git-branch` but requires more setup and understanding of Git commands.

README

current-git-branch

Get synchronously the current branch name

Installation

$ npm i current-git-branch --save

or

$ yarn add current-git-branch

Usage

Returns:

• Boolean false: It is not a git repository
• String: The branch name

const branchName = require('current-git-branch');

branchName(); // false or branch name of process.cwd()
branchName({ altPath: 'any/git/repo' }); // false or branch name of the directory 'any/git/repo'
branchName({ altPath: 'any/git/repo', branchOptions: [ "--no-color" ] }); // alternatively, you may pass git-branch command options, either as a string or an array

LICENSE

MIT © Jan Peer Stöcklmair