npm.io
2.0.2 • Published 10 months ago

current-git-branch

Licence
MIT
Version
2.0.2
Deps
1
Size
68 kB
Vulns
0
Weekly
0
Stars
10

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

Keywords