last-commit-log

---

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/last-commit-log.svg
[npm-url]: https://npmjs.org/package/last-commit-log
[travis-image]: https://img.shields.io/travis/node-modules/last-commit-log.svg
[travis-url]: https://travis-ci.org/node-modules/last-commit-log
[codecov-image]: https://img.shields.io/codecov/c/github/node-modules/last-commit-log.svg
[codecov-url]: https://codecov.io/gh/node-modules/last-commit-log/branch/master
[node-image]: https://img.shields.io/badge/node.js-%3E=_8-green.svg
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/last-commit-log.svg
[download-url]: https://npmjs.org/package/last-commit-log

> Node.js module to get the last git commit information - mostly to be used by CI/CD and building phase.

Who are using

- ⭐⭐⭐Forward Email
- ⭐⭐⭐Cabin
- ⭐⭐⭐microsoft/BotFramework-WebChat

For more

Usage

``javascript
const LCL = require('last-commit-log');
const lcl = new LCL(); // or new LCL(dir) dir is process.cwd() by default
`

Asychronous use, using a Promise:

`javascript
lcl
.getLastCommit()
.then(commit => console.log(commit));
`

Synchronous use:

`javascript
const commit = lcl.getLastCommitSync();
`

full examples

commit information is an object like this:

`json
{
"gitTag": "2.0.0",
"gitBranch": "master",
"gitRemote": "git@github.com:group/repo.git", // .git http or ssh
"gitUrl": "http://github.com/group/repo", // url only
"shortHash": "42dc921",
"hash": "42dc921d25a3e7e1607302d2acfdc3fd991c0c01",
"subject": "chore: add lock",
"sanitizedSubject": "chore-add-lock",
"body": "",
"committer": {
"date": "1515240839",
"relativeDate": "2 hours ago",
"name": "Committer Fred",
"email": "fred@fred.com"
},
"author": {
"date": "1515240839",
"relativeDate": "2 hours ago",
"name": "Author Baz",
"email": "baz@baz.com"
}
}
`

Get map of line changed or added from git diff:

`javascript
const data = lcl.diff({
currentBranch: 'gh-pages',
});

/**
{
'/diff.js': [
[
1,
46
]
],
'/index.js': [
[
124,
125
]
],
'/package.json': [],
'/test/diff.test.js': [
[
1,
14
]
]
}
*/
console.log(data);
`

Related Projects

- macacajs/macaca-coverage code coverage tool

Contributors

|
zhangyuheng
|
xudafeng
|
titanism
|
atidyshirt
|
stared
|
yihuineng
|
| :---: | :---: | :---: | :---: | :---: | :---: |

antife-yinyue


This project follows the git-contributor spec, auto updated at Sun May 21 2023 11:57:56 GMT+0800`.

License

The MIT License (MIT)