gitinfo

Gets information about Git repository.

Implementation

gitinfo reads the contents of the ./git directory to extract information.

API

1import createGitinfo from 'gitinfo';
2
3/**
4 * @typedef Configuration
5 * @property {string} [defaultBranchName] Default branch name to fallback to. Default: throws an error if branch cannot be resolved.
6 * @property {string} [gitPath] Path used to resolve .git path. Defaults to `__dirname`.
7 */
8
9/**
10 * @access public
11 * @name createGitinfo
12 * @param {Configuration} userConfig
13 */
14const gitinfo = createGitinfo();
15
16/**
17 * Returns **Any** GitHub repository URL.
18 */
19gitinfo.getGithubUrl();
20
21/**
22 * Returns **Any** Name of the current branch.
23 */
24gitinfo.getBranchName();
25
26/**
27 * Returns **Any** Remote URL of the current branch.
28 */
29gitinfo.getRemoteUrl();
30
31/**
32 * Returns **Any** Absolute path to the .git/ directory.
33 */
34gitinfo.getGitPath();
35
36/**
37 * Returns **Any** Username of the repository author.
38 */
39gitinfo.getUsername();
40
41/**
42 * Returns **Any** Repository name.
43 */
44gitinfo.getName();
45
46/**
47 * Returns **Any** Commit SHA of the current branch.
48 */
49gitinfo.getHeadSha();
50
51/**
52 * Returns **Any** Representation of the .git/config file.
53 */
54gitinfo.getConfig();
55

Download

Download using NPM:

1npm install gitinfo
2