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

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:

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

Synchronous use:

const commit = lcl.getLastCommitSync();

full examples

commit information is an object like this:

{
  "gitTag": "2.0.0",
  "gitBranch": "master",
  "gitRemote": "[email protected]: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": "[email protected]"
  },
  "author": {
    "date": "1515240839",
    "relativeDate": "2 hours ago",
    "name": "Author Baz",
    "email": "[email protected]"
  }
}

Get map of line changed or added from git diff:

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)