git-rev-sync
Advanced tools
Readme
Synchronously get the current git commit hash, tag, count, branch or commit message. Forked from git-rev. Supports Node 4+.
var git = require('git-rev-sync');
console.log(git.short());
// 75bf4ee
console.log(git.long());
// 75bf4eea9aa1a7fd6505d0d0aa43105feafa92ef
console.log(git.branch());
// master
You can also run these examples via: npm run examples
npm install git-rev-sync --save
var git = require('git-rev-sync');
git.short([filePath], [length]) → <String>return the result of git rev-parse --short HEAD
filePath parameter can be used to run the command against a repo outside the current working directorylength parameter can be used to set the desired hash length (defaults to 7)git.long([filePath]) → <String>return the result of git rev-parse HEAD; optional filePath parameter can be used to run the command against a repo outside the current working directory
git.branch([filePath]) → <String>return the current branch; optional filePath parameter can be used to run the command against a repo outside the current working directory
git.count() → <Number>return the count of commits across all branches; this method will fail if the git command is not found in PATH
git.date() → <Date>returns the date of the current commit; this method will fail if the git command is not found in PATH
git.hasUnstagedChanges() → <Boolean>returns true if there are unstaged changes; this method will fail if the git command is not found in PATH
git.isDirty() → <Boolean>returns true if there are uncommitted changes; this method will fail if the git command is not found in PATH
git.isTagDirty() → <Boolean>returns true if the current tag is dirty; this method will fail if the git command is not found in PATH
git.message() → <String>return the current commit message; this method will fail if the git command is not found in PATH
git.remoteUrl() → <String>return the current remote URL; this method will fail if the git command is not found in PATH
git.tag([markDirty]) → <String>return the current tag and mark as dirty if markDirty is truthful; this method will fail if the git command is not found in PATH
FAQs
Synchronously get the current git commit hash, tag, or branch
The npm package git-rev-sync receives a total of 308,291 weekly downloads. As such, git-rev-sync popularity was classified as popular.
We found that git-rev-sync demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.