Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 817 Bytes

README.md

File metadata and controls

31 lines (22 loc) · 817 Bytes

@lerna/describe-ref

Parse git describe output for lerna-related tags

Usage

const { describe } = require("@lerna/describe-ref");

(async () => {
  const { lastTagName, lastVersion, refCount, sha, isDirty } = await describe();
})();

// values listed here are their defaults
const options = {
  cwd: process.cwd(),
  // pass a glob to match tag name, e.g. "v*.*.*"
  match: undefined,
  // if true, omit --first-parent option
  includeMergedTags: false,
};

const { lastTagName, lastVersion, refCount, sha, isDirty } = describe.sync(options);

const result = describe.parse("v1.0.0-5-gdeadbeef");
// { lastTagName, lastVersion, refCount, sha, isDirty }

Install lerna for access to the lerna CLI.