giterator

> git log as a JavaScript generator

Installation

``
npm install --save giterator
`

Usage

`js
import { giterator } from 'giterator';

for await (const commit of giterator('/Users/foldleft/Dev/syncpack', {
pageSize: 20,
skipMerges: true,
tokenNames: ['authorEmail', 'subject', 'refNames'],
})) {
console.log(commit);
}
`

Our example would produce;

`
{
authorName: 'Jamie Mason',
subject: 'chore(license): update year',
refNames: 'HEAD -> master, origin/master, origin/HEAD'
}
{
authorName: 'Jamie Mason',
subject: 'chore(release): 9.8.4',
refNames: 'tag: 9.8.4'
}
{
authorName: 'Jamie Mason',
subject: 'docs(site): mark up required/optional config',
refNames: 'origin/dev, dev'
}
{
authorName: 'Jamie Mason',
subject: 'feat(semver): support resolving with lowest version',
refNames: ''
}
// ...etc
``

Options

$3

Absolute path to your locally cloned git repository.

$3

Optional array of strings representing the data required from each git commit
(defaults to all).

- authorDate
- authorDateRelative
- authorEmail
- authorName
- body
- commitHash
- commitNotes
- committerDate
- committerDateRelative
- committerEmail
- committerName
- parentHashes
- reflogIdentityEmail
- reflogIdentityName
- reflogSelector
- reflogSubject
- refNames
- sanitizedSubjectLine
- subject
- treeHash

For more information see the
Git Pretty Formats Documentation.

$3

Whether to exclude merge commits from being returned (defaults to true).

Badges

- 
-