Wondering what’s next for npm?Check out our public roadmap! »

    git-rev-sync
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/git-rev-sync package

    3.0.1 • Public • Published

    git-rev-sync Build Status

    Synchronously get the current git commit hash, tag, count, branch or commit message. Forked from git-rev. Supports Node 4+.

    Example

    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

    Install

    npm install git-rev-sync --save

    API

    var git = require('git-rev-sync');

    git.short([filePath], [length]) → <String>

    return the result of git rev-parse --short HEAD

    • optional filePath parameter can be used to run the command against a repo outside the current working directory
    • optional length 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

    License

    MIT

    Donations

    We're all in this together

    Keywords

    none

    Install

    npm i git-rev-sync

    DownloadsWeekly Downloads

    490,861

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    13.3 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar