gitlog
v5.1.0TypeScript
Git log parser for Node.JS
97.7K/weekUpdated 1 years agoBSD-3-ClauseUnpacked: 38.0 KB
Published by Dom Harrington
npm install gitlognode-gitlog
Git log parser for Node.JS
Installation
``sh`
npm install gitlog --save
Usage
`js
import gitlog from "gitlog";
const options = {
repo: __dirname + "/test-repo-folder",
number: 20,
author: "Dom Harrington",
fields: ["hash", "abbrevHash", "subject", "authorName", "authorDateRel"],
execOptions: { maxBuffer: 1000 * 1024 },
};
const commits = await gitlog(options);
`
gitlog comes with full typescript support!
`ts
import gitlog, { GitlogOptions } from "gitlog";
// Option 1: Just use the function, returned commit type has specified fields
gitlog({
repo: "foo",
fields: ["subject", "authorName", "authorDate"],
});
// Option 2: Use Options type to create options
const options: GitlogOptions<"subject" | "authorName" | "authorDate"> = {
repo: "foo",
fields: ["subject", "authorName", "authorDate"],
};
gitlog(options);
// Option 3: Typescript Magic
const options = {
repo: "foo",
fields: ["subject", "authorName", "authorDate"] as const,
};
gitlog(options);
// NOT SUPPORTED: Without "as const" gitlog can't create a good return type
const options = {
repo: "foo",
fields: ["subject", "authorName", "authorDate"],
};
gitlog(options);
`
Options
See git log
$3
The location of the repo, required field.
$3
The number of commits to return, defaults to 10.
$3
Show commits more recent than a specific date.
$3
Show commits older than a specific date.
$3
Limit the commits output to ones with author/committer header lines that match the specified pattern.
$3
Below fields was returned from the log:
- files - changed files names (array)
- status - changed files status (array)
This option is enabled by default.
$3
Much more likely to set status codes to 'C' if files are exact copies of each other.
This option is disabled by default.
$3
Pass the -m option to includes files in a merge commit.
This option is disabled by default.
$3
Pass the --follow option to follow files across renames.
This option is disabled by default.
$3
Find commits on all branches instead of just on the current one.
This option is disabled by default.
$3
Show only commits in the specified branch or revision range.
By default uses the current branch and defaults to HEAD (i.e. the whole history leading to the current commit).
$3
Optional field for getting only the commits that affected a specific line range of a given file.
$3
Optional file filter for the git log command
$3
Type: Object
Specify some options to be passed to the .exec() method:
- cwd String _Current working directory of the child process_env
- Object _Environment key-value pairs_setsid
- Booleanencoding
- String _(Default: 'utf8')_timeout
- Number _(Default: 0)_maxBuffer
- Number _(Default: 200\*1024)_killSignal
- String _(Default: 'SIGTERM')_
$3
An array of fields to return from the log, here are the possible options:
- hash - the long hash of the commit e.g. 7dd0b07625203f69cd55d779d873f1adcffaa84aabbrevHash
- - the abbreviated commit hash e.g. 7dd0b07treeHash
- - the tree hash of the commitabbrevTreeHash
- - the abbreviated commit hashparentHashes
- - the parent hashesabbrevParentHashes
- - the abbreviated parent hashesauthorName
- - author name of the commitauthorEmail
- - author email of the commitauthorDate
- - author date of the commitauthorDateRel
- - relative author date of the commitcommitterName
- - committer namecommitterEmail
- - committer emailcommitterDate
- - committer datecommitterDateRel
- - relative committer datesubject
- - commit message (first line)body
- - commit bodyrawBody
- - raw body (subject + body)tag
- - raw tag information of commit
Defaults to 'abbrevHash', 'hash', 'subject' and 'authorName'.
How it works
This module works by executing a child process (using child_process.exec()) to the git executable, then parsing the stdout into commits. This is done using the --pretty command line option which allows you to provide a custom formatter to git log. To enable easy parsing the format is delimited by a tab (\t) character.
Example
The following is an example of what a parsed commit might look like.
`json``
{
"hash": "6a7ef5e3b3d9c77743140443c8f9e792b0715721",
"abbrevHash": "6a7ef5e",
"treeHash": "f1bf51b15b48a00c33727f364afef695029864c0",
"abbrevTreeHash": "f1bf51b",
"parentHashes": "cfe06dbdb8d0a193640977e016a04678f8f3b04f",
"abbrevParentHashes": "cfe06dbdb8d0a193640977e016a04678f8f3b04f",
"authorName": "Dom Harrington",
"authorEmail": "dom@harringtonxxxxx",
"authorDate": "2015-04-09 09:39:23 +0100",
"authorDateRel": "6 days ago",
"committerName": "Dom Harrington",
"committerEmail": "dom@harringtonxxxxx",
"committerDate": "Thu Apr 9 09:39:23 2015 +0100",
"committerDateRel": "6 days ago",
"subject": "1.0.0",
"status": ["M"],
"files": ["package.json"]
}
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!