kucherenko/blamer

blamer is a tool for getting information about author of code from version control system

Blamer

Blamer is a tool for get information about author of code from version control system. Supports git and subversion.

Status

Setup

npm install blamer

Usage

import Blamer from 'blamer';

// first parameter in Blamer is type of VCS, can be 'svn' or 'git', 'git' used by default
const blamer = new Blamer('git');

( async () => {
    const result = await blamer.blameByFile('/path/to/file/in/repo');
    console.log("Blame json: %j", result);
    //        will print
    //        Blame json: {"/path/to/file/in/repo": {
    //            "1": {
    //                "rev": "rev",
    //                "author": "author",
    //                "date": "2014-10-15T12:33:31.675393Z",
    //                "line": "1"
    //             }
    //        }
    //   }
})

License

The MIT License

blamer's Issues

Ignore code movements inside a file

What do you think about ignoring moving of snippets of code as well?

with git blame -w -M one would be ignoring movements of functions up and down in the code.

Cannot find module 'node:fs'

• I'm submitting a ...
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

Cannot find module 'node:fs'
Require stack:
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/node_modules/blamer/build/main/vcs/git.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/node_modules/blamer/build/main/blamer.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/node_modules/blamer/build/main/index.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/node_modules/@jscpd/finder/dist/hooks/blamer.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/node_modules/@jscpd/finder/dist/hooks/index.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/node_modules/@jscpd/finder/dist/index.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/dist/index.js
- /tmp/.npm/_npx/66/lib/node_modules/jscpd/bin/jscpd

https://github.com/kucherenko/blamer/blame/2ca7c28bdd8d31bb7d8bd33e8a637c456476a853/src/vcs/git.ts#L4

node version: v14.16.1

https://nodejs.org/api/esm.html#node-imports

node:imports only support by node >=v14.18.0 >=v16.0.0

For compatibility with lower versions, please adjust the way the module is introduced. Thank you very much.

CVE-2023-0842 for xml2js version 0.4.23

See Leonidas-from-XIV/node-xml2js#663

Perhaps time to deprecate svn.ts (?)

Whitespace ommit

This happens on Windows on a git repo.

It should be nice to be able to activate the "-w" option or not (ot just have it enabled by default). Otherwise I get the text "Not committed yet" when is a whitespace issue.

Thanks for this nice plugin.

Regards