Skip to content

README.md

Latest commit

 

History

History
31 lines (20 loc) · 1.04 KB

README.md

File metadata and controls

31 lines (20 loc) · 1.04 KB

current-git-branch

Build Status Coverage Status

Get synchronously the current branch name

Installation

$ npm i current-git-branch --save

Usage

Returns:

  • Boolean false: It is not a git repository
  • String: The branch name
import branchName from "current-git-branch";

branchName(); // false or branch name of process.cwd()
branchName({ cwd: "any/git/repo" }); // false or branch name of the directory 'any/git/repo'
branchName({ cwd: "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