Get the current branch from the local git repository.
npm install git-branch> 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 :heart: and support.
Install with npm:
``sh`
$ npm install --save git-branch
`js`
const branch = require('git-branch');
Optionally pass the cwd (current working directory) as the first argument.
Promise
`js`
branch('some/path')
.then(name => console.log('Branch:', name)) //=> 'master'
.catch(console.error);
Callback
`js`
branch(function(err, name) {
if (err) throw err;
console.log('Branch:', name); //=> 'master'
});
Sync
`js`
console.log('Branch:', branch.sync()); //=> '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:
`sh`
$ 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:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You 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
* LinkedIn Profile
* GitHub Profile
* Twitter Profile
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on March 09, 2018._