Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.02 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.02 KB
Raw

git-repo-info

Retrieves repo information without relying on the git command.

Usage

var getRepoInfo = require('git-repo-info');

var info = getRepoInfo();

info.branch         //=> will be the current branch
info.sha            //=> will be the current sha
info.abbreviatedSha //=> will be the first 10 chars of the current sha
info.tag            //=> will be the tag for the current sha (or `null` if no tag exists)
info.committer      //=> will be the committer for the current sha
info.committerDate  //=> will be the commit date for the current sha
info.author         //=> will be the author for the current sha
info.authorDate     //=> will be the authored date for the current sha
info.commitMessage  //=> will be the commit message for the current sha

When called without any arguments, git-repo-info will automatically lookup upwards into parent directories to find the first match with a .git folder.

If passed an argument, it will be assumed to be the path to the repo's .git folder to inspect.