README.md

git-describe

This Node.js module runs git describe on the working directory or any other directory and parses the output to individual components. Additionally, if your tags follow semantic versioning the semver will be parsed and supplemented with the git-specific information as build metadata.

As of version 3.0.0, both synchronous and asynchronous calls are supported. Note that the synchronous version will throw an Error on failure.

Installation

Available from npm: npm install git-describe

Usage

The module exposes two functions, gitDescribe (asynchronous) and gitDescribeSync (synchronous) — although gitDescribe can also be used in synchronous mode if the callback is omitted.

Both functions can take a directory string (defaults to working directory) and an options object. Either or both arguments can be omitted. If operating asynchronously, the callback argument must come last.

var gitDescribe = require('git-describe').gitDescribe;
var gitDescribeSync = require('git-describe').gitDescribeSync;

// Target working directory
var gitInfo = gitDescribeSync();

// Target the directory of the calling script
// Recommended when you want to target the repo your app resides in
var gitInfo = gitDescribeSync(__dirname);

// With options (see below)
var gitInfo = gitDescribeSync(__dirname, {
    longSemver: true,
    dirtySemver: false
});

// Another example: working directory, use 16 character commit hash abbreviation
var gitInfo = gitDescribeSync({
    customArguments: ['--abbrev=16']
});

// Asynchronous
gitDescribe(__dirname, function(err, gitInfo) {
    if (err)
        return console.error(err);
    console.dir(gitInfo);
});

Example output

{ 
    dirty: false,
    hash: 'g3c9c15b',
    distance: 6,
    tag: 'v2.1.0-beta',
    semver: SemVer, // SemVer instance, see https://github.com/npm/node-semver
    suffix: '6-g3c9c15b',
    raw: 'v2.1.0-beta-6-g3c9c15b',
    semverString: '2.1.0-beta+6.g3c9c15b'
}

Options

Option	Default	Description
dirtySemver	true	Appends '.dirty' to semverString if repo state is dirty (similar to --dirty).
longSemver	false	Always add commit distance and hash to semverString (similar to --long).
requireAnnotated	false	Uses --tags if false, so that simple git tags are allowed.
match	'v[0-9]*'	Uses --match to filter tag names. By default only tags resembling a version number are considered.
customArguments	[]	Array of additional arguments to pass to git describe. Not all arguments are useful and some may even break the library, but things like --abbrev and --candidates should be safe to add.