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

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

Asychronous use, using a Promise:

1lcl
2  .getLastCommit()
3  .then(commit => console.log(commit));

Synchronous use:

1const commit = lcl.getLastCommitSync();

full examples

commit information is an object like this:

1{
2  "gitTag": "2.0.0",
3  "gitBranch": "master",
4  "gitRemote": "git@github.com:group/repo.git", // .git http or ssh
5  "gitUrl": "http://github.com/group/repo",     // url only
6  "shortHash": "42dc921",
7  "hash": "42dc921d25a3e7e1607302d2acfdc3fd991c0c01",
8  "subject": "chore: add lock",
9  "sanitizedSubject": "chore-add-lock",
10  "body": "",
11  "committer": {
12    "date": "1515240839",
13    "relativeDate": "2 hours ago",
14    "name": "Committer Fred",
15    "email": "fred@fred.com"
16  },
17  "author": {
18    "date": "1515240839",
19    "relativeDate": "2 hours ago",
20    "name": "Author Baz",
21    "email": "baz@baz.com"
22  }
23}

Get map of line changed or added from git diff:

1const data = lcl.diff({
2  currentBranch: 'gh-pages',
3});
4
5/**
6{
7  '/diff.js': [
8    [
9      1,
10      46
11    ]
12  ],
13  '/index.js': [
14    [
15      124,
16      125
17    ]
18  ],
19  '/package.json': [],
20  '/test/diff.test.js': [
21    [
22      1,
23      14
24    ]
25  ]
26}
27 */
28console.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)