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 with npm:
$ npm install --save git-branchconst 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)) //=> 'Branch: master'
.catch(console.error);Callback
branch(function(err, name) {
if (err) throw err;
console.log('Branch:', name); //=> 'Branch: master'
});Sync
console.log('Branch:', branch.sync()); //=> 'Branch: master'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 testBuilding 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 && verbYou might also be interested in these projects:
- git-add-remote: API for adding git remotes. | homepage
- git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
- github-base: JavaScript wrapper that greatly simplifies working with GitHub's API. | homepage
| Commits | Contributor |
|---|---|
| 19 | jonschlinkert |
| 6 | emilrowland |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on March 09, 2018.