# @spryker-lerna/describe-ref

> Parse git describe output for lerna-related tags

Latest version **5.1.0** (published 2022-06-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @spryker-lerna/describe-ref
pnpm add @spryker-lerna/describe-ref
yarn add @spryker-lerna/describe-ref
bun add @spryker-lerna/describe-ref
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.1.0 |
| Published | 2022-06-04 |
| First published | 2022-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^14.19.3 \|\| >=16.0.0 |
| Dependencies | 2 |
| Unpacked size | 10.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Daniel Stockman |
| Maintainers | spryker-bot |
| Keywords | lerna, utils, git, describe |

## Links

- npm: https://www.npmjs.com/package/@spryker-lerna/describe-ref
- Repository: https://github.com/lerna/lerna
- Homepage: https://github.com/lerna/lerna/tree/master/utils/describe-ref#readme
- Issues: https://github.com/lerna/lerna/issues
- npm.io page: https://npm.io/package/@spryker-lerna/describe-ref

## Dependencies (2)

- [npmlog](https://npm.io/package/npmlog.md) ^4.1.2
- [@spryker-lerna/child-process](https://npm.io/package/@spryker-lerna/child-process.md) 5.1.0

## Recent versions

- 5.1.0 (latest) — 2022-06-04
- 5.2.0 (lerna-temp) — 2022-06-04

## README

# `@lerna/describe-ref`

> Parse [git describe][] output for lerna-related tags

## Usage

```js
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](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

[git describe]: https://git-scm.com/docs/git-describe

---
_Source: https://npm.io/package/@spryker-lerna/describe-ref · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._