To help you get started, we've collected the most common ways that git-parse is being used within popular public projects.

apollographql / apollo-tooling / packages / apollo / src / git.ts View on Github

// Occasionally `branch` will be undefined depending on the environment, so
  // we need to fallback on `prBranch`. However in some cases, we are not able
  // to get to the branch at all. For more information, see
  // https://github.com/pvdlg/env-ci#caveats
  const { commit, branch: ciBranch, root, prBranch } = ci();
  const gitLoc = root ? root : findGitRoot();

  if (!commit) return;

  let committer, remoteUrl, message;
  let branch = ciBranch || prBranch;

  // In order to use git-parse and git-rev-sync, we must ensure that a git context is
  // accessible. Without this check, the commands would throw
  if (gitLoc) {
    const { authorName, authorEmail, ...commit } = await gitToJs(gitLoc)
      .then((commits: Commit[]) =>
        commits && commits.length > 0
          ? commits[0]
          : { authorName: null, authorEmail: null, message: null }
      )
      .catch(() => ({ authorEmail: null, authorName: null, message: null }));

    committer = `${authorName || ""} ${
      authorEmail ? `<${authorEmail}>` : ""
    }`.trim();

    message = commit.message;

    // The remoteUrl call can fail and throw an error
    // https://github.com/kurttheviking/git-rev-sync-js#gitremoteurl--string
    try {

View more ways to use git-parse

Git-Parse

> git-parse is a utility which generates an array of javascript objects representing the current branch of a local git repository's commit history.

Details

• Support NodeJS >= 14

Installation

npm install git-parse

Usage

const { gitToJs } = require('git-parse');

const commitsPromise = gitToJs('path/to/repo/');

commitsPromise.then(commits => console.log(JSON.stringify(commits, null, 2)));

[
  {
    "hash": "7cedc121ee163d859dfdb9911e627d4b5933cc6d",
    "authorName": "mpackard@wayfair.com",
    "authorEmail": "mpackard@wayfair.com",
    "date": "Wed, 10 Jan 2018 16:44:52 -0500",
    "message": "initial setup",
    "filesAdded":[
        { "path": "packages/raspberry-popsicle/index.js" },
        { "path": "packages/raspberry-popsicle/package-lock.json" },
        { "path": "packages/raspberry-popsicle/package.json" }
    ],
    "filesDeleted": [],
    "filesModified": [],
    "filesRenamed": []
  },
  {
    "hash": "226f032eb87ac1eb18b7212eeaf1356980a9ae03",
    "authorName": "mpackard@wayfair.com",
    "authorEmail": "mpackard@wayfair.com",
    "date": "Wed, 10 Jan 2018 15:25:16 -0500",
    "message": "add README",
    "filesAdded": [
      { "path": "README.md" }
    ],
    "filesDeleted": [],
    "filesModified": [],
    "filesRenamed": []
  }
]

API

.gitToJs(pathToRepo, [options])

Returns a promise which resolves with a list of objects describing git commits on the current branch. pathToRepo is a string. options is an optional object with one property, sinceCommit, which is a commit hash. If sinceCommit is present, gitToJs will return logs for commits after the commit specified.

const { gitToJs } = require('git-parse');

const commitsPromise = gitToJs('path/to/repo/');

commitsPromise.then(commits => console.log(JSON.stringify(commits, null, 2)));

.checkOutCommit(pathToRepo, commitHash, [options])

Checks a repository out to a given commit. hash is the commit hash. Options is an optional object with one property, force. force adds --force to the underlying git checkout. Returns a promise.

.gitPull(pathToRepo)

Runs 'git pull' on the repository at the given path. Returns a promise.

.gitDiff(pathToRepo, commitHash1, [commitHash2], [file])

Returns a git diff given a path to the repo, a commit, an optional second commit, and an optional file path.

Returns a promise resolving with the diff as a string.

Development

Build

To generate a local distribution for the git-parse library run the following command:

yarn build

To build the library in the background on file changes, use:

yarn build:watch

Code Formatting

To automatically format the code using Prettier run:

yarn format

or

yarn format:check

Linting

To lint the project using ESLint run:

yarn lint

Tests

To run the project tests using the Jest framework run:

yarn test

Type Checking

To check the project for type errors using Typescript run:

yarn tsc

Use --watch to run the type checker in the background:

yarn tsc --watch

License

This project is licensed under the BSD-2-Clause license.