git-head-info ·

Retrieve current sha and branch name from a git repo.

Install

1npm i git-head-info

Usage

1import gitHeadInfo from 'git-head-info' /* or */ const gitHeadInfo = require('git-head-info')
2
3/**
4 * @param {path | void} repo: the git repo to get HEAD info, default is current working dir
5 * @returns ({
6 *  repo: the repo used to get git info
7 *  sha: HEAD sha
8 *  branch: HEAD branch | undefined(if in `detached HEAD` state)
9 * })
10 */
11
12// promise
13gitHeadInfo(repo?).then(res => {
14  ...
15}).catch()
16
17// async
18async function foo() {
19  try {
20    const res = await gitHeadInfo(repo?)
21    ...
22  } catch() {}
23}