UNPKG

current-git-branch

Version:

A tool to check if files are added in a git repository

github.com/JPeer264/node-current-git-branch

JPeer264/node-current-git-branch

35 lines (24 loc) • 1.02 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# current-git-branch [![Build Status](https://travis-ci.org/JPeer264/node-current-git-branch.svg?branch=master)](https://travis-ci.org/JPeer264/node-current-git-branch) [![Build status](https://ci.appveyor.com/api/projects/status/ehj6762gbj1e2qyc?svg=true)](https://ci.appveyor.com/project/JPeer264/node-current-git-branch) [![Coverage Status](https://coveralls.io/repos/github/JPeer264/node-current-git-branch/badge.svg?branch=master)](https://coveralls.io/github/JPeer264/node-current-git-branch?branch=master) Get synchronously the current branch name ## Installation ```sh $ npm i current-git-branch --save ``` or ```sh $ yarn add current-git-branch ``` ## Usage Returns: - Boolean `false`: It is not a git repository - String: The branch name ```js const branchName = require('current-git-branch'); branchName(); // false or branch name of process.cwd() branchName('any/git/repo'); // false or branch name of the directory 'any/git/repo' ``` ## LICENSE MIT © [Jan Peer Stöcklmair](https://www.jpeer.at)