@lerna/describe-ref
Advanced tools
Package description
@lerna/describe-ref is a utility package that helps in describing the current Git reference in a Lerna-managed monorepo. It provides information about the current Git branch, tag, or commit, which can be useful for versioning and release management in monorepos.
Describe the current Git reference
This feature allows you to get a description of the current Git reference, including branch name, tag, or commit hash. The `describeRef` function returns an object with details about the current Git state.
const { describeRef } = require('@lerna/describe-ref');
async function getGitRef() {
const ref = await describeRef();
console.log(ref);
}
getGitRef();Custom base ref
This feature allows you to specify a custom base reference to compare against. The `describeRef` function can take an options object where you can set the `baseRef` to a specific branch or tag.
const { describeRef } = require('@lerna/describe-ref');
async function getCustomBaseRef(baseRef) {
const ref = await describeRef({ baseRef });
console.log(ref);
}
getCustomBaseRef('main');Include distance from base ref
This feature includes the distance (number of commits) from the base reference in the description. The `includeDistance` option can be set to `true` to get this additional information.
const { describeRef } = require('@lerna/describe-ref');
async function getRefWithDistance() {
const ref = await describeRef({ includeDistance: true });
console.log(ref);
}
getRefWithDistance();git-rev-sync is a package that provides synchronous access to Git information such as the current branch, commit hash, and tag. It is similar to @lerna/describe-ref but operates synchronously and is not specifically designed for monorepos.
git-describe is a package that provides a way to describe a Git commit using tags and commit distance. It is similar to @lerna/describe-ref but focuses on general Git repositories rather than Lerna-managed monorepos.
simple-git is a lightweight interface for running Git commands in any Node.js application. It provides a broader range of Git functionalities compared to @lerna/describe-ref, which is more specialized for describing Git references in monorepos.
Changelog
4.0.0 (2021-02-10)
lazy named export is now a proper static method of Package.Here's the gnarly one-liner I used to make these changes:
npx lerna exec --concurrency 1 --stream -- 'json -I -f package.json -e '"'"'this.engines=this.engines||{};this.engines.node=">= 10.18.0"'"'"
(requires npm i -g json beforehand)
Readme
@lerna/describe-refParse git describe output for lerna-related tags
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.
FAQs
Unknown package
We found that @lerna/describe-ref demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A threat actor on BreachForums is selling an unverified npm vulnerability for account takeover, but npm has not officially confirmed the existence of this security concern.
Security News
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.