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.

$3

- Support NodeJS >= 14

$3

``bash
npm install git-parse
`

$3

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

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

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

API

$3

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.

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

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

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

$3

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.

$3

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

$3

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

$3

To generate a local distribution for the git-parse library run the following command:
`sh
yarn build
`

To build the library in the background on file changes, use:
`sh
yarn build:watch
`

$3

To automatically format the code using Prettier run:
`sh
yarn format
`
or
`sh
yarn format:check
`

$3

To lint the project using ESLint run:
`sh
yarn lint
`

$3

To run the project tests using the Jest framework run:
`sh
yarn test
`

$3

To check the project for type errors using Typescript run:
`sh
yarn tsc
`

Use --watch to run the type checker in the background:
`sh
yarn tsc --watch
``

License

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