gimme-stat is a CLI GIT report tool

Installation

$ npm -g install gimme-stat
$ cd /home/your_git_project_name
$ gimme-stat

Available Arguments

• --init - create default configuration file gimme.config.js. The config can be an alternative for console arguments.
• --since=[date] --until=[date] you can use any git log valid formats for the options, as a rule in ISO 8601
  • examples of use:
    • --since="2014-02-12T16:36:00-07:00"
  • Note: you can also use:
    • --since="2.years"
    • --since="3.months"
    • --since="2014-02-12T16:36:00-07:00"
    • --since="1 month ago"
    • --since="2 weeks 3 days 2 hours 30 minutes 59 seconds ago"
    • ---since="2024-01-01" --until="2024-03-31"
• --graph = [ all | short | detailed | none ] - take one of specified flags, to set detail level of statistic information as shown in the Examples, using all return both short and detailed. none will hide per user statistics, use it if only table or daily needed.
• --statext = "js,html,htm,cs,css,scss,less,json,php,sql" - The list of extensions which you want to see in --graph=detailed mode.
• --cwd you can use the argument to specify repository path in your local system if you run the command not from the repository or you want to specify a few repositories.
  • single rep example: --cwd="/home/project"
  • You can use multiple repos separated by commas:
    • --cwd="/pwd/project1,/pwd/project2"
• --prepull - pull commits for all repositories before analysis.
  • Note: doesn't resolve merge conflicts.
• --users = "Me,ThatGuy" - takes an array of names and returns statistics only for them.
• --lmargin=19 - the space between progress line and a left edge of the window
• --barSize=200 - set length of progress bar in chars, default value set at 100 chars
• --table - generate table with short personal commit statistic
• --daily - generate per day statistic based on number of changed lines.
• --appendtomd=report.md - will create report.md file with statistic in your project directory
• --bartype = [default | detailed] - change progress bar representation, detailed show insertions/deletions, default doesn't.
• --ignoreusers="FirstName LastName,FirstName2 LastName2,SomeUsername" - allows you to exclude specific users from the statistics (Their contribution will be ignored fully).
• --statignore="package-lock.json,assets,bin" - you can put any files which will be ignored.
  • Items in the list are RegExp strings. NOTES: Flags mi will be appended for the RegExp.
  • With config file gimme.config.js can be configured with more flexibility (see Examples below).

JSON Configuration gimme.config.js

To save your git report / gimme-stat configuration create following gimme.config.js file.

module.exports = {
    userAliases   : [
        'Barack Obama>Reptiloid',
        'Justin Bieber>Reptiloid'
    ],
    appendToMd    : "report.md",
    since         : "1.weeks",
    until         : "",
    graph         : "short",
    lmargin       : 19,
    barSize       : 100,
    cwd           : [
        "C:/repository/MyProject1",
        "C:/repository/MyProject2"
    ],
    users         :'',
    barType       :'default',
    //Masks of files which will be ignored in your statistic
    statIgnore    : [
        /node_modules/mi,
        /package\-lock\.json/mi,
        /yarn\.lock/mi,
        /assets/mi,
        /dist/mi,
        /\.gitignore/,
        /www(\/|\\)build/mi,
        /^(\/|\\)www/mi,
        /\.idea/,
        /config\.xml/,
        /\.sourcemaps/,
        /.+\.map/
    ],


    table: false,
    daily: false,
    prepull: false,
    // The file extensions will be shown in your statistic,
    // other will be under 'other' category.
    statExtensions: [
        'js', 'html', 'htm', 'cs', 'css', 'scss', 'less',
        'json', 'php', 'sql'
    ],

    //The users will be ignored in your statistics
    ignoreUsers : [
        'Unknown', 'user1'
    ]
}

Report types

Repositories:
home/rep/project1
home/rep/project2

Nicolas Cage   ███████████████░░░░░░░░░░░░░░░░░░░░░░░░░ 38.34%
Tom Hanks      ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 35.91%
Keanu Reeves   █████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 22.84%
Morgan Freeman █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2.90%

Nicolas Cage        ███████████████░░░░░░░░░░░░░░░░░░░░░░░░░ 38.34%
├── cs              ███████████████████░░░░░░░░░░░░░░░░░░░░░ 47.51%
├── other           ██████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 26.64%
├── js              ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 16.88%
├── scss            ██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 6.41%
├── sql             ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 1.46%
└── json            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 1.10%
Tom Hanks           ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 35.91%
├── cs              ███████████████████████░░░░░░░░░░░░░░░░░ 57.25%
├── other           ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 36.08%
├── js              ██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 5.18%
├── scss            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0.64%
├── json            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0.50%
├── html            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0.18%
└── sql             ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0.18%
Keanu Reeves        █████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 22.84%
├── cs              ██████████████████████░░░░░░░░░░░░░░░░░░ 54.38%
├── other           ██████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 25.49%
├── js              ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 15.45%
├── sql             █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2.40%
├── json            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 1.73%
├── scss            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0.45%
└── html            ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0.11%
Morgan Freeman      █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2.90%
├── cs              █████████████████████████████████████░░░ 92.11%
├── other           ██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 6.14%
└── js              ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 1.75%

┌────────────────┬─────────┬────────────┬───────────┬──────────────┐
│ Author         │ Commits │ Insertions │ Deletions │ % of changes │
├────────────────┼─────────┼────────────┼───────────┼──────────────┤
│ Nicolas Cage   │ 69      │ 2237       │ 1110      │ 36           │
├────────────────┼─────────┼────────────┼───────────┼──────────────┤
│ Tom Hanks      │ 92      │ 2335       │ 905       │ 35           │
├────────────────┼─────────┼────────────┼───────────┼──────────────┤
│ Keanu Reeves   │ 42      │ 1389       │ 801       │ 24           │
├────────────────┼─────────┼────────────┼───────────┼──────────────┤
│ Morgan Freeman │ 5       │ 209        │ 127       │ 4            │
├────────────────┼─────────┼────────────┼───────────┼──────────────┤
│ Samuel Jackson │ 4       │ 193        │ 35        │ 3            │
└────────────────┴─────────┴────────────┴───────────┴──────────────┘

                                                      commits|changes
Thu Nov 23 2017 ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 4   | 119
Fri Nov 24 2017 ████████████████░░░░░░░░░░░░░░░░░░░░░░░░ 7   | 290
Sat Nov 25 2017 ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0   | 0
Sun Nov 26 2017 ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0   | 0
Mon Nov 27 2017 ██████████████████░░░░░░░░░░░░░░░░░░░░░░ 6   | 330
Tue Nov 28 2017 ████████████████████████████░░░░░░░░░░░░ 8   | 517
Wed Nov 29 2017 ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 5   | 265
Thu Nov 30 2017 ████████████████████████████████████████ 20  | 741

Usage as Node.js Module

Easiest way to use it is to call module with default parameters, use empty object for this.

let gimmeStat = require('gimme-stat');
gimmeStat.text({}).then((answer) => {
    console.log(answer);
});

Available 3 type of return:

• gimmeStat.text({}) - {json, string} - json will contain raw data and second field will be in requested format
• gimmeStat.md({}) - {json, md}
• gimmeStat.json({}) - {json}

Also you can choose parameters, pass it as an object

let gimmeStat = require('gimme-stat');
gimmeStat.text({
    appendToMd:false,
    barSize:60,
    barType:"default",
    cwd:Array(1) ["."],
    daily:false,
    graph:"short",
    ignoreUsers:Array(2) ["Unknown", "user1"],
    init:false,
    prepull:false,
    since:"3.months",
    table:false,
    until:"",
    userAliases:Object {'Barack Obama': "Reptiloid", 'Justin Bieber': "Reptiloid"},
    users:Array(1) [""]
}).then((answer) => {console.log(answer);});