Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.47 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.47 KB

Blamer

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

Status

NPM version Build Status codecov Code Climate

NPM

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