git-local-info

1.0.1 • Public • Published

git-local-info

Badges

npm package Build Status dependencies Status


gitInfo

Retrieves repo information without relying on the git command.

Usage

// install
$ npm install git-local-info -S
import GitInfo from 'git-local-info';
 
 
const gitInfo = new GitInfo();
 
const result = gitInfo.getGitInfo;
 
// result is:
{
  /** The current branch */
  branch: string;
  /** The current repository url */
  repository: string;
  /** SHA of the current commit */
  sha: string;
  /** The committer of the current SHA */
  commit: ICommit;
  /** The commit message for the current SHA */
  rootDir: string;
}
 

Params

new GitInfo(params);

// params
{
  // default process.cwd()
  gitPath: process.cwd(),
  // default .git
  GIT_DIR: '.git',
}

Screenshot

image

Readme

Keywords

Package Sidebar

Install

npm i git-local-info

Weekly Downloads

23

Version

1.0.1

License

MIT

Unpacked Size

11.8 kB

Total Files

8

Last publish

Collaborators

  • ycjcl868