gimme-stat
Version:
Simple tool for git repositories to generate progress statistic.
519 lines (486 loc) • 37.4 kB
HTML
<html lang="en">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-D53PDTTYE6"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-D53PDTTYE6');
</script>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>gimme-stat - CLI GIT Report Tool Documentation</title>
<meta name="description" content="gimme-stat is a CLI GIT report tool that provides detailed statistics on commits, changed lines, and developer contributions. Generate reports with flexible customization options.">
<meta name="keywords" content="git, statistics, commits, developer stats, git report, cli tool, code analysis, repository stats">
<meta name="author" content="gimme-stat">
<!-- Favicon -->
<link rel="icon" type="image/png" href="logo-icon.png">
<!-- Prism.js for syntax highlighting -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css" />
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-javascript.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-bash.min.js"></script>
<link rel="stylesheet" href="style.css">
</head>
<body>
<!-- Mobile Header -->
<div class="mobile-header">
<img src="logo.png" alt="gimme-stat logo" class="mobile-logo">
<span class="mobile-title">gimme-stat</span>
<button class="hamburger" id="hamburger" aria-label="Toggle menu">
<span></span>
<span></span>
<span></span>
</button>
</div>
<!-- Sidebar Navigation -->
<nav class="sidebar" id="sidebar">
<div class="sidebar-header">
<img src="logo.png" alt="gimme-stat logo" class="sidebar-logo">
<a href="https://www.npmjs.com/package/gimme-stat" target="_blank" rel="noopener noreferrer" class="sidebar-title-link">
<img src="npm.png" alt="npm" class="npm-icon">
<h2 class="sidebar-title">gimme-stat</h2>
</a>
</div>
<ul class="nav-menu">
<li><a href="#introduction" class="nav-link">Introduction</a></li>
<li><a href="#installation" class="nav-link">Installation</a></li>
<li><a href="#arguments" class="nav-link">Available Arguments</a></li>
<li>
<a href="#examples" class="nav-link">Examples</a>
<ul class="nav-submenu">
<li><a href="#example1" class="nav-link nav-sublink">Detailed Graph</a></li>
<li><a href="#example2" class="nav-link nav-sublink">Bar Type</a></li>
<li><a href="#example3" class="nav-link nav-sublink">Daily Stats</a></li>
<li><a href="#example4" class="nav-link nav-sublink">Specific User</a></li>
<li><a href="#example5" class="nav-link nav-sublink">Table Format</a></li>
</ul>
</li>
<li><a href="#config" class="nav-link">Json Configuration</a></li>
<li><a href="#report-sample" class="nav-link">Report Types</a></li>
<li><a href="#nodejs-usage" class="nav-link">Node.js Usage</a></li>
</ul>
</nav>
<!-- Main Content -->
<main class="main-content">
<section id="introduction" class="doc-section">
<div class="section-intro">
<h1>gimme-stat is a CLI <strong>GIT report tool</strong></h1>
<p>Having a git repository you can get the report which includes commits count per developer, number of changed lines, their percentage relative with other project developers.</p>
<p>It has flexible customization which allows to combine a list of repositories, merge developers nicknames, exclude some of them from the report. Allow to export the report to MD format.</p>
</div>
</section>
<section id="installation" class="doc-section">
<h2>Installation</h2>
<div class="terminal-example">
<div class="terminal-header">
<span class="terminal-title">Terminal</span>
</div>
<pre class="terminal-content"><code>$ npm -g install gimme-stat
$ cd /home/your_git_project_name
$ gimme-stat</code></pre>
</div>
</section>
<section id="arguments" class="doc-section">
<h2>Available Arguments</h2>
<ul class="arguments-list">
<li>
<code>--init</code> - create default configuration file <code>gimme.config.js</code>. The config can be an alternative for console arguments.
</li>
<li>
<code>--since=[date]</code> <code>--until=[date]</code> you can use any <code>git log</code> valid formats for the options, as a rule in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>
<ul>
<li>examples of use:
<ul>
<li>--since="2014-02-12T16:36:00-07:00"</li>
</ul>
</li>
<li>Note: you can also use:
<ul>
<li>--since="2.years"</li>
<li>--since="3.months"</li>
<li>--since="2014-02-12T16:36:00-07:00"</li>
<li>--since="1 month ago"</li>
<li>--since="2 weeks 3 days 2 hours 30 minutes 59 seconds ago"</li>
<li>---since="2024-01-01" --until="2024-03-31"</li>
</ul>
</li>
</ul>
</li>
<li>
<code>--graph = [ all | short | detailed | none ]</code> - take one of specified flags, to set detail level of statistic information as shown in the Examples, using <code>all</code> return both <code>short</code> and <code>detailed</code>. <code>none</code> will hide per user statistics, use it if only <code>table</code> or <code>daily</code> needed.
</li>
<li>
<code>--statext = "js,html,htm,cs,css,scss,less,json,php,sql"</code> - The list of extensions which you want to see in <code>--graph=detailed</code> mode.
</li>
<li>
<code>--cwd</code> 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.
<ul>
<li>single rep example: <code>--cwd="/home/project"</code></li>
<li>You can use multiple repos separated by commas:
<ul>
<li><code>--cwd="/pwd/project1,/pwd/project2"</code></li>
</ul>
</li>
</ul>
</li>
<li>
<code>--prepull</code> - pull commits for all repositories before analysis.
<ul>
<li>Note: doesn't resolve merge conflicts.</li>
</ul>
</li>
<li>
<code>--users = "Me,ThatGuy"</code> - takes an array of names and returns statistics only for them.
</li>
<li>
<code>--lmargin=19</code> - the space between progress line and a left edge of the window
</li>
<li>
<code>--barSize=200</code> - set length of progress bar in chars, default value set at 100 chars
</li>
<li>
<code>--table</code> - generate table with short personal commit statistic
</li>
<li>
<code>--daily</code> - generate per day statistic based on number of changed lines.
</li>
<li>
<code>--appendtomd=report.md</code> - will create <code>report.md</code> file with statistic in your project directory
</li>
<li>
<code>--bartype = [default | detailed]</code> - change progress bar representation, <code>detailed</code> show insertions/deletions, <code>default</code> doesn't.
</li>
<li>
<code>--ignoreusers="FirstName LastName,FirstName2 LastName2,SomeUsername"</code> - allows you to exclude specific users from the statistics (Their contribution will be ignored fully).
</li>
<li>
<code>--statignore="package-lock.json,assets,bin"</code> - you can put any files which will be ignored.
<ul>
<li>Items in the list are <a href="https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/RegExp" target="_blank">RegExp</a> strings. NOTES: Flags <code>mi</code> will be appended for the RegExp.</li>
<li>With config file <code>gimme.config.js</code> can be configured with more flexibility (see Examples below).</li>
</ul>
</li>
</ul>
</section>
<section id="examples" class="doc-section">
<div class="section-header">
<h2>Examples</h2>
<button id="expand-all-btn" class="expand-all-btn collapse-mode">Collapse All Examples</button>
</div>
<div id="example1" class="example-block">
<h3>Example 1: Detailed graph with file extensions</h3>
<button class="collapse-btn active" data-target="example1-output">Hide Output</button>
<div class="command-line">
<span class="cmd-prompt">$</span> <span class="cmd-name">gimme-stat</span> <span class="cmd-param">--since</span>=<span class="cmd-value">3.months</span> <span class="cmd-param">--cwd</span>=<span class="cmd-value">"/home/project"</span> <span class="cmd-param">--graph</span>=<span class="cmd-value">detailed</span>
</div>
<div id="example1-output" class="terminal-example collapsible open">
<div class="terminal-header">
<span class="terminal-title">Output</span>
</div>
<pre class="terminal-content"><code>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%</code></pre>
</div>
</div>
<div id="example2" class="example-block">
<h3>Example 2: Short graph with detailed bar type</h3>
<button class="collapse-btn active" data-target="example2-output">Hide Output</button>
<div class="command-line">
<span class="cmd-prompt">$</span> <span class="cmd-name">gimme-stat</span> <span class="cmd-param">--graph</span>=<span class="cmd-value">short</span> <span class="cmd-param">--bartype</span>=<span class="cmd-value">detailed</span> <span class="cmd-param">--barsize</span>=<span class="cmd-value">40</span>
</div>
<div id="example2-output" class="terminal-example collapsible open">
<div class="terminal-header">
<span class="terminal-title">Output</span>
</div>
<pre class="terminal-content"><code> Legend:
+ - insertions
- - deletions
Nicolas Cage [-----------------+++++++++++ ] 71.26%
Tom Hanks [-------++++ ] 28.74%</code></pre>
</div>
</div>
<div id="example3" class="example-block">
<h3>Example 3: Short graph with daily statistics</h3>
<button class="collapse-btn active" data-target="example3-output">Hide Output</button>
<div class="command-line">
<span class="cmd-prompt">$</span> <span class="cmd-name">gimme-stat</span> <span class="cmd-param">--since</span>=<span class="cmd-value">1.weeks</span> <span class="cmd-param">--graph</span>=<span class="cmd-value">short</span> <span class="cmd-param">--barsize</span>=<span class="cmd-value">50</span> <span class="cmd-param">--daily</span>
</div>
<div id="example3-output" class="terminal-example collapsible open">
<div class="terminal-header">
<span class="terminal-title">Output</span>
</div>
<pre class="terminal-content"><code>Nicolas Cage ███████████████░░░░░░░░░░░░░░░░░░░░░░░░░ 38.34%
Tom Hanks ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 35.91%
Keanu Reeves █████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 22.84%
Morgan Freeman █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2.90%
commits|changes
Thu Nov 23 2017 ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 4 | 119
Fri Nov 24 2017 ████████████████░░░░░░░░░░░░░░░░░░░░░░░░ 7 | 290
Sat Nov 25 2017 ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0 | 0
Sun Nov 26 2017 ██████████████████░░░░░░░░░░░░░░░░░░░░░░ 6 | 330
Mon Nov 27 2017 ████████████████████████████░░░░░░░░░░░░ 8 | 517
Tue Nov 28 2017 ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 5 | 265
Wed Nov 29 2017 ████████████████████████████████████████ 20 | 741</code></pre>
</div>
</div>
<div id="example4" class="example-block">
<h3>Example 4: Daily statistics for specific user</h3>
<button class="collapse-btn active" data-target="example4-output">Hide Output</button>
<div class="command-line">
<span class="cmd-prompt">$</span> <span class="cmd-name">gimme-stat</span> <span class="cmd-param">--since</span>=<span class="cmd-value">1.weeks</span> <span class="cmd-param">--daily</span> <span class="cmd-param">--users</span>=<span class="cmd-value">"Dat Ding"</span> <span class="cmd-param">--graph</span>=<span class="cmd-value">none</span>
</div>
<div id="example4-output" class="terminal-example collapsible open">
<div class="terminal-header">
<span class="terminal-title">Output</span>
</div>
<pre class="terminal-content"><code> commits|changes
Thu Nov 23 2017 ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 4 | 119
Fri Nov 24 2017 ████████████████░░░░░░░░░░░░░░░░░░░░░░░░ 7 | 290
Sat Nov 25 2017 ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0 | 0
Sun Nov 26 2017 ██████████████████░░░░░░░░░░░░░░░░░░░░░░ 6 | 330
Mon Nov 27 2017 ████████████████████████████░░░░░░░░░░░░ 8 | 517
Tue Nov 28 2017 ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 5 | 265
Wed Nov 29 2017 ████████████████████████████████████████ 20 | 741</code></pre>
</div>
</div>
<div id="example5" class="example-block">
<h3>Example 5: Table format</h3>
<button class="collapse-btn active" data-target="example5-output">Hide Output</button>
<div class="command-line">
<span class="cmd-prompt">$</span> <span class="cmd-name">gimme-stat</span> <span class="cmd-param">--since</span>=<span class="cmd-value">3.months</span> <span class="cmd-param">--graph</span>=<span class="cmd-value">none</span> <span class="cmd-param">--table</span>
</div>
<div id="example5-output" class="terminal-example collapsible open">
<div class="terminal-header">
<span class="terminal-title">Output</span>
</div>
<pre class="terminal-content"><code>┌────────────────┬─────────┬────────────┬───────────┬──────────────┐
│ 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 │
└────────────────┴─────────┴────────────┴───────────┴──────────────┘</code></pre>
</div>
</div>
</section>
<section id="config" class="doc-section">
<h2>JSON Configuration <code>gimme.config.js</code></h2>
<p>To save your git report / gimme-stat configuration create following <code>gimme.config.js</code> file.</p>
<pre><code class="language-javascript">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'
]
}</code></pre>
</section>
<section id="report-sample" class="doc-section">
<h2>Report types</h2>
<div class="example-block">
<h3>Repositories</h3>
<div class="terminal-example">
<div class="terminal-header">
<span class="terminal-title">Repositories</span>
</div>
<pre class="terminal-content"><code>Repositories:
home/rep/project1
home/rep/project2</code></pre>
</div>
</div>
<div class="example-block">
<h3>Short</h3>
<div class="terminal-example">
<div class="terminal-header">
<span class="terminal-title">Short Statistics</span>
</div>
<pre class="terminal-content"><code>Nicolas Cage ███████████████░░░░░░░░░░░░░░░░░░░░░░░░░ 38.34%
Tom Hanks ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░ 35.91%
Keanu Reeves █████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 22.84%
Morgan Freeman █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2.90%</code></pre>
</div>
</div>
<div class="example-block">
<h3>Detailed</h3>
<div class="terminal-example">
<div class="terminal-header">
<span class="terminal-title">Detailed Statistics</span>
</div>
<pre class="terminal-content"><code>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%</code></pre>
</div>
</div>
<div class="example-block">
<h3>Table</h3>
<div class="terminal-example">
<div class="terminal-header">
<span class="terminal-title">Table Statistics</span>
</div>
<pre class="terminal-content"><code>┌────────────────┬─────────┬────────────┬───────────┬──────────────┐
│ 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 │
└────────────────┴─────────┴────────────┴───────────┴──────────────┘</code></pre>
</div>
</div>
<div class="example-block">
<h3>Daily</h3>
<div class="terminal-example">
<div class="terminal-header">
<span class="terminal-title">Daily Statistics</span>
</div>
<pre class="terminal-content"><code> 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</code></pre>
</div>
</div>
</section>
<section id="nodejs-usage" class="doc-section">
<h2>Usage as Node.js Module</h2>
<p>Easiest way to use it is to call module with default parameters, use empty object for this.</p>
<pre><code class="language-javascript">let gimmeStat = require('gimme-stat');
gimmeStat.text({}).then((answer) => {
console.log(answer);
});</code></pre>
<p>Available 3 type of return:</p>
<ul>
<li><code>gimmeStat.text({})</code> - <code>{json, string}</code> - json will contain raw data and second field will be in requested format</li>
<li><code>gimmeStat.md({})</code> - <code>{json, md}</code></li>
<li><code>gimmeStat.json({})</code> - <code>{json}</code></li>
</ul>
<p>Also you can choose parameters, pass it as an object</p>
<pre><code class="language-javascript">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);});</code></pre>
</section>
<footer class="doc-footer">
<p>Created with GbitCode | <a href="https://gbitcode.com" target="_blank">Author</a></p>
</footer>
</main>
<script src="script.js"></script>
</body>
</html>