git-describeify
This browserify transform calls git-describe with the provided arguments on the working directory or any other directory and parses the output to individual components. On build/transform time the git-describe information will be injected so that it can be used in, for example, browser served applications which have no access to the local file system.
Installation
Available from npm:
$ npm i git-describeify
Tests are not included in the npm package — clone the git repository to run tests.
Usage
git-describeify uses the node git-describe module.
During transform, require('git-describeify')
is replaced with the
git-describe object.
Browserify transform
Make sure to enable the transform in Browserify by either specifying it in the terminal
$ browserify -t git-describeify
or by putting it in the package.json
.
Require syntax
// Require the module the arguments passed to git-describe; // For exampleconst gitInfo = ; // Transforms into:const gitInfo = 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'
More examples
// Target working directoryconst gitInfo = ; // Target the directory of the calling script// Recommended when you want to target the repo your app resides inconst gitInfo = ; // With options (see https://www.npmjs.com/package/git-describe)const gitInfo = ; // Another example: working directory, use 16 character commit hash abbreviationconst 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'
More information
See git-describe for more information about the usage of the git-describe package.
Test
Tests can be run by cloning the repository and running the following command.
$ npm install$ npm test