tinovyatkin / git-blame-json

Returns `git blame` results in JSON. Written in TypeScript, async and high-performance

git-blame-json

Shelling out to git blame in a streaming Node fashion and returns a Map of blame information for each line. Contrary to other implementations, this one written in TypeScript, well tested and allow to specify line ranges and revision to blame.

import { blame } from 'git-blame-json';

it('supports blame options', async () => {
  const res = await blame('lib/context.js', {
    gitDir: './test/koa/.git', // optional git-dir or work-tree parameters
    range: '195,197', // lines range
    rev: '2.11.0', // revision
  });
  expect(res).toBeInstanceOf(Map);
  expect(res.size).toBe(3);
  expect(res.get(196)).toMatchInlineSnapshot(`
      Object {
        "author": "Konstantin Vyatkin",
        "authorMail": "[e-mail]",
        "authorTime": 1571054445,
        "authorTz": "-0400",
        "committer": "Yiyu He",
        "committerMail": "[e-mail]",
        "committerTime": 1571054445,
        "committerTz": "+0800",
        "filename": "lib/context.js",
        "hash": "d48d88ee17b780c02123e6d657274cab456e943e",
        "numberOfLines": 1,
        "previous": "8be5626bbb54e6c899a1b71d22411709126d9fea lib/context.js",
        "resultLine": 196,
        "sourceLine": 196,
        "summary": "feat: implement response.has (#1397)",
      }
    `);
});