git-repo-info

Retrieves repo information without relying on the git command.

Usage

1var getRepoInfo = require('git-repo-info');
2
3var info = getRepoInfo();
4
5info.branch               // current branch
6info.sha                  // current sha
7info.abbreviatedSha       // first 10 chars of the current sha
8info.tag                  // tag for the current sha (or `null` if no tag exists)
9info.lastTag              // tag for the closest tagged ancestor
10                          //   (or `null` if no ancestor is tagged)
11info.commitsSinceLastTag  // number of commits since the closest tagged ancestor
12                          //   (`0` if this commit is tagged, or `Infinity` if no ancestor is tagged)
13info.committer            // committer for the current sha
14info.committerDate        // commit date for the current sha
15info.author               // author for the current sha
16info.authorDate           // authored date for the current sha
17info.commitMessage        // commit message for the current sha
18info.root                 // root directory for the Git repo or submodule
19                          //   (if in a worktree, this is the directory containing the original copy)
20info.commonGitDir         // directory containing Git metadata for this repo or submodule
21                          //   (if in a worktree, this is the primary Git directory for the repo)
22info.worktreeGitDir       // if in a worktree, the directory containing Git metadata specific to
23                          //   this worktree; otherwise, this is the same as `commonGitDir`.

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.