git-branch
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/git-branch package

2.0.1 • Public • Published

git-branch NPM version NPM monthly downloads NPM total downloads Linux Build Status

Get the current branch from the local git repository.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save git-branch

Usage

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

Optionally pass the cwd (current working directory) as the first argument.

Promise

branch('some/path')
  .then(name => console.log('Branch:', name)) //=> 'master'
  .catch(console.error);

Callback

branch(function(err, name) {
  if (err) throw err;
  console.log('Branch:', name); //=> 'master'
});

Sync

console.log('Branch:', branch.sync()); //=> 'master'

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

Contributors

Commits Contributor
19 jonschlinkert
6 emilrowland

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on March 09, 2018.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 2.0.1
    327,606
    • latest

Version History

Package Sidebar

Install

npm i git-branch

Weekly Downloads

352,039

Version

2.0.1

License

MIT

Unpacked Size

6.91 kB

Total Files

4

Last publish

Collaborators

  • jonschlinkert