branch-name

Get the current branch name

Usage no npm install needed!

<script type="module">
  import branchName from 'https://cdn.skypack.dev/branch-name';
</script>

README

branch-name Build status for branch-name

Get the current branch name

Why?

  • Clean, minimal, promise-based API.
  • Respects your $PATH.
  • Uses the most reliable branch detection algorithm.
  • Gives you control in weird situations.

Install

npm install branch-name --save

Usage

Get it into your program.

const branchName = require('branch-name');

Get the current branch name.

branchName.get().then((name) => {
   console.log(name);
});

Get the current branch name, but with a fallback result for detached head and non-repository situations.

branchName.assume('dev').then((name) => {
   console.log(name);  // prints current branch if possible, 'dev' otherwise
});

Get the current branch name, with the default master as a fallback.

branchName.assumeMaster().then((name) => {
   console.log(name);  // prints current branch if possible, 'master' otherwise
});

API

get(option)

Returns the branch name that HEAD points to. Throws an error if not in a git repository or HEAD is not a branch.

assume(name, option)

Similar to .get(), but will return name if not in a git repository or the HEAD is detached.

assumeMaster(option)

Similar to .assume() but always uses "master" as the fallback name.

option

Type: object

cwd

Type: string
Default: process.cwd()

Directory whose branch you want determine.

Related

Contributing

See our contributing guidelines for more details.

  1. Fork it.
  2. Make a feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.