git-repo-info

Retrieves repo information WITH relying on the git command.

Why another library

There is already a library that works without git command, but it's tied to git's internal implementation; the code is fussy and hard to understand. I'm reimplementing its functions using basic git command, which results in MUCH less and cleaner code.

Isn't a library relies on another program's output can be easy broken?

No. There are LOTS of third party git tools that relies on the native git command. They have been working without problems for years.

Implementation details / git commands used

1$ git show --format='%H%n%h%n%cn%n%cI%n%an%n%aI%n%s' -q --encoding=UTF-8

For getting basic info of the last commit. Formating switches used are documented by the offical git docs

1$ git symbolic-ref --short HEAD

For getting working branch

1$ git describe --tags --long --always

For getting tag info

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

License

MIT