Merge pull request #106 from arzzen/task/log-options

Ability to use options for git log command

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: [arzzen]
+open_collective: git-quick-stats
+custom: ['https://lukasmestan.com/thanks/']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -0,0 +1,10 @@
+*.json
+*.db
+.DS_Store*
+._*
+.*.swp
+.*.swo
+.Spotlight*
+.Trash*
+**/*~
+nbproject/*

.travis.yml

@@ -11,8 +11,6 @@ addons:
       - cmake
 
 install:
-  - git checkout ${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}
-  - git branch --set-upstream-to origin/$TRAVIS_BRANCH
   - git rev-parse HEAD
 
 script: make test

Dockerfile

@@ -0,0 +1,27 @@
+FROM alpine
+
+# Copy sources
+COPY . /app
+
+# Install required packages & build git-quick-stats
+RUN     apk add --no-cache bash git make ncurses util-linux \
+    &&  cd /app \
+    &&  make install \
+    &&  rm -rf /app \
+    &&  apk del --no-cache make \
+    &&  mkdir -p /usr/local/bin \
+    &&  echo -en "#!/bin/bash\nset -e\n[[ \"\${1::1}\" == '-' ]] && set -- /usr/bin/git quick-stats \"\$@\"\nexec \"\$@\"" \
+            > /usr/local/bin/docker-entrypoint \
+    &&  chmod +x /usr/local/bin/docker-entrypoint
+
+# Declare all variables usables by git-quick-stats
+ENV _GIT_SINCE= \
+    _GIT_UNTIL= \
+    _GIT_LIMIT= \
+    _GIT_PATHSPEC= \
+    _MENU_THEME=default \
+    TERM=xterm-256color
+
+WORKDIR /git
+ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
+CMD [ "/usr/bin/git", "quick-stats" ]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Lukáš Mešťan
+Copyright (c) 2020 Lukáš Mešťan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,39 +1,43 @@
 PREFIX ?= /usr/local
+_INSTDIR ?= $(DESTDIR)$(PREFIX)
+BINDIR ?= $(_INSTDIR)/bin
+MANDIR ?= $(_INSTDIR)/share/man
 TASK_DONE = echo -e "\n✓ $@ done\n"
-# files that need mode 755
-EXEC_FILES=git-quick-stats
 
 .PHONY: test
 
 all:
-	@echo "usage: make install"
-	@echo "       make reinstall"
-	@echo "       make uninstall"
-	@echo "       make test"
+	@echo "Usage:"
+	@echo "  make install"
+	@echo "  make reinstall"
+	@echo "  make uninstall"
+	@echo "  make test"
 
 help:
 	$(MAKE) all
 	@$(TASK_DONE)
 
 install:
-	mkdir -p $(PREFIX)/bin
-	install -m 0755 $(EXEC_FILES) $(PREFIX)/bin/$(EXEC_FILES)
-	git config --global alias.quick-stats '! $(PREFIX)/bin/$(EXEC_FILES)'
+	install -d -m 0755 $(BINDIR)
+	install -m 0755 git-quick-stats $(BINDIR)/git-quick-stats
+	$(MAKE) man
 	@$(TASK_DONE)
 
 uninstall:
-	test -d $(PREFIX)/bin && \
-	cd $(PREFIX)/bin && \
-	rm -f $(EXEC_FILES) && \
-	git config --global --unset alias.quick-stats
+	rm -f $(BINDIR)/git-quick-stats
+	rm -f $(MANDIR)/man1/git-quick-stats.1
 	@$(TASK_DONE)
 
 reinstall:
-	@curl -s https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats > git-quick-stats
-	$(MAKE) uninstall && \
+	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
+	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
 	$(MAKE) install
 	@$(TASK_DONE)
 
+man:
+	install -d -m 0755 $(MANDIR)/man1/
+	install -m 0644 git-quick-stats.1 $(MANDIR)/man1/
+
 test:
 	tests/commands_test.sh
 	@$(TASK_DONE)

README.md

@@ -1,101 +1,196 @@
 
-## GIT quick statistics [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Simple%20and%20efficient%20way%20to%20access%20various%20statistics%20in%20git%20repository&url=https://github.com/arzzen/git-quick-stat&via=arzzen&hashtags=git,stats,tool,statistics,developers)
+# GIT quick statistics [![Backers on Open Collective](https://opencollective.com/git-quick-stats/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/git-quick-stats/sponsors/badge.svg)](#sponsors) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Simple%20and%20efficient%20way%20to%20access%20various%20statistics%20in%20git%20repository&url=https://github.com/arzzen/git-quick-stat&via=arzzen&hashtags=git,stats,tool,statistics,developers) [![Travis](https://api.travis-ci.org/arzzen/git-quick-stats.svg?branch=master)](https://travis-ci.org/arzzen/git-quick-stats) [![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](http://braumeister.org/formula/git-quick-stats) [![Linuxbrew package](https://repology.org/badge/version-for-repo/linuxbrew/git-quick-stats.svg)](https://repology.org/metapackage/git-quick-stats/packages)
 
-[![Travis](https://api.travis-ci.org/arzzen/git-quick-stats.svg?branch=master)](https://travis-ci.org/arzzen/git-quick-stats)
-[![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](http://braumeister.org/formula/git-quick-stats)
-[![Linuxbrew package](https://repology.org/badge/version-for-repo/linuxbrew/git-quick-stats.svg)](https://repology.org/metapackage/git-quick-stats/packages)
+> `git-quick-stats` is a simple and efficient way to access various statistics in a git repository.
+>
+> Any git repository may contain tons of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because there are a gadzillion options to a gadzillion git commands – I don’t think there is a single person alive who knows them all. Probably not even [Linus Torvalds](https://github.com/torvalds) himself :).
 
-> `git quick-stats` is a simple and efficient way to access various statistics in git repository.
-
-> Any git repository contains tons of information about commits, contributors, and files.  Extracting this information is not  always trivial, mostly because of a gadzillion options to a gadzillion git commands – I don’t think there is a single person  alive who knows them all.  Probably not even [Linus Torvalds](https://github.com/torvalds) himself :).
+![mainMenuScreenshot](https://user-images.githubusercontent.com/8818630/58364013-61e53800-7e7b-11e9-87f9-790d6744fbd5.png)
 
 ## Table of Contents
 
 [**Screenshots**](#screenshots)
 
-[**Installation**](#installation)
-* [**Unix OS**](#unix-like-os)
-* [**OS X**](#os-x-homebrew)
-* [**Windows**](#windows-cygwin)
-
 [**Usage**](#usage)
-* [**Git log since/until**](#git-log-since-until)
+
+* [**Interactive**](#interactive)
+* [**Non-interactive**](#non-interactive)
+* [**Command-line arguments**](#command-line-arguments)
+* [**Git log since and until**](#git-log-since-and-until)
 * [**Git log limit**](#git-log-limit)
+* [**Git log options**](#git-log-options)
 * [**Git pathspec**](#git-pathspec)
-* [**Tests**](#tests)
+* [**Git merge view strategy**](#git-merge-view-strategy)
+* [**Color themes**](#color-themes)
+
+[**Installation**](#installation)
+
+* [**UNIX and Linux**](#unix-and-linux)
+* [**macOS**](#macos-homebrew)
+* [**Windows**](#windows)
+* [**Docker**](#docker)
 
 [**System requirements**](#system-requirements)
-* [**Dependences**](#dependences)
 
-[**Contribution**](#contribution)
+* [**Dependencies**](#dependencies)
 
 [**FAQ**](#faq)
 
-[**License**](#licensing)
+[**Contribution**](#contribution)
 
+* [**Code reviews**](#code-reviews)
+* [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
+* [**Formatting**](#formatting)
+
+[**Tests**](#tests)
+
+[**Licensing**](#licensing)
+
+[**Contributors**](#contributors)
+
+* [**Backers**](#backers)
+* [**Sponsors**](#sponsors)
 
 ## Screenshots
 
-![screenshot from 2017-04-02 17-10-21](https://cloud.githubusercontent.com/assets/6382002/24588459/bef0a1b8-17c8-11e7-8525-3ab5983b81dc.png)
-
-![screenshot from 2017-04-02 17-09-13](https://cloud.githubusercontent.com/assets/6382002/24588456/bec1278a-17c8-11e7-8835-39273da7bc99.png)
-
-![screenshot from 2017-04-02 17-09-31](https://cloud.githubusercontent.com/assets/6382002/24588457/beece9f6-17c8-11e7-80a4-274ecd314a7e.png)
-
-![screenshot from 2017-04-02 17-09-45](https://cloud.githubusercontent.com/assets/6382002/24588458/bef03656-17c8-11e7-82e6-30a5a11cfbb0.png)
-
-![screenshot from 2017-04-02 17-08-28](https://cloud.githubusercontent.com/assets/6382002/24588460/bef0c2e2-17c8-11e7-88b2-a4033593c5d0.png)
+![commitsByWeekdayScreenshot](https://user-images.githubusercontent.com/8818630/58364011-61e53800-7e7b-11e9-9417-16cbb241ac2e.png)
 
+![commitsByHourScreenshot](https://user-images.githubusercontent.com/8818630/58364010-61e53800-7e7b-11e9-8711-a40b50aebf52.png)
 
 ## Usage
 
+### Interactive
+
+git-quick-stats has a built-in interactive menu that can be executed as such:
+
 ```bash
-git quick-stats
-# or
 git-quick-stats
 ```
 
-Or you can use (non-interactive) direct execution:
-
-`git quick-stats <optional-command-to-execute-directly>`
-
-Possible arguments:
-> suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors,
-branchTree, branchesByDate, changelogs, changelogsByAuthor
-
-
-#### Git log since / until
-
-You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
+Or
 
 ```bash
-export _GIT_SINCE="2017-20-01"
-export _GIT_UNTIL="2017-22-01"
+git quick-stats
 ```
 
-then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
+### Non-interactive
 
+For those who prefer to utilize command-line options, `git-quick-stats` also has a non-interactive mode supporting both short and long options:
 
-#### Git log limit
+```bash
+git-quick-stats <optional-command-to-execute-directly>
+```
 
-You can set variable `_GIT_LIMIT` for limited output (it will affect: "Git changelogs" and "Branch tree view" )
+Or
+
+```bash
+git quick-stats <optional-command-to-execute-directly>
+```
+
+### Command-line arguments
+
+Possible arguments in short and long form:
+
+```bash
+-r, --suggest-reviewers
+    show the best people to contact to review code
+-T, --detailed-git-stats
+    give a detailed list of git stats
+-R, --git-stats-by-branch
+    see detailed list of git stats by branch
+-d, --commits-per-day
+    displays a list of commits per day
+-m, --commits-by-month
+    displays a list of commits per month
+-w, --commits-by-weekday
+    displays a list of commits per weekday
+-o, --commits-by-hour
+    displays a list of commits per hour
+-A, --commits-by-author-by-hour
+    displays a list of commits per hour by author
+-a, --commits-per-author
+    displays a list of commits per author
+-S, --my-daily-stats
+    see your current daily stats
+-C, --contributors
+    see a list of everyone who contributed to the repo
+-b, --branch-tree
+    show an ASCII graph of the git repo branch history
+-D, --branches-by-date
+    show branches by date
+-c, --changelogs
+    see changelogs
+-L, --changelogs-by-author
+    see changelogs by author
+-j, --json-output
+    save git log as a JSON formatted file to a specified area
+-h, -?, --help
+    display this help text in the terminal
+```
+
+### Git log since and until
+
+You can set the variables `_GIT_SINCE` and/or `_GIT_UNTIL` before running `git-quick-stats` to limit the git log. These work similar to git's built-in `--since` and `--until` log options.
+
+```bash
+export _GIT_SINCE="2017-01-20"
+export _GIT_UNTIL="2017-01-22"
+```
+
+Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
+
+### Git log limit
+
+You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options.
 
 ```bash
 export _GIT_LIMIT=20
 ```
 
-#### Git pathspec
+### Git log options
 
-You can exclude directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
+You can set _GIT_LOG_OPTIONS for [git log options](https://git-scm.com/docs/git-log#_options):
+
+```bash
+export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
+```
+
+### Git pathspec
+
+You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
 
 ```bash
 export _GIT_PATHSPEC=':!directory'
 ```
 
+You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
+
+```bash
+export _GIT_PATHSPEC=':!package-lock.json'
+```
+
+### Git merge view strategy
+
+You can set the variable `_GIT_MERGE_VIEW` to enable merge commits to be part of the stats by setting `_GIT_MERGE_VIEW` to `enable`. You can also choose to only show merge commits by setting `_GIT_MERGE_VIEW` to `exclusive`. Default is to not show merge commits. These work similar to git's built-in `--merges` and `--no-merges` log options. 
+
+```bash
+export _GIT_MERGE_VIEW="enable"
+export _GIT_MERGE_VIEW="exclusive"
+```
+
+### Color themes
+
+You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`
+
+```bash
+export _MENU_THEME=legacy
+```
+
+![legacyThemeScreenshot](https://user-images.githubusercontent.com/8818630/58364012-61e53800-7e7b-11e9-910a-aaff836260eb.png)
 
 ## Installation
 
-#### Unix like OS
+### UNIX and Linux
 
 ```bash
 git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
@@ -114,24 +209,37 @@ For update/reinstall
 sudo make reinstall
 ```
 
-#### OS X (homebrew)
+### macOS (homebrew)
 
 ```bash
 brew install git-quick-stats
 ```
 
-#### Windows (cygwin)
+Or you can follow the UNIX and Linux instructions if you wish.
+
+### Windows
+
+If you are installing with Cygwin, use these scripts:
 
 * [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
 * [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
 
+If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
+
+### Docker
+
+You can use the Docker image provided:
+
+* Build: `docker build -t arzzen/git-quick-stats .`
+* Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
+* Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
 
 ## System requirements
 
-* Unix like OS with a proper shell
-* Tools we use: git ; awk ; sed ; tr ; echo ; grep ; cut ; sort ; head ; uniq ; column.
+* An OS with a Bash shell
+* Tools we use: awk ; basename ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
 
-#### Dependences
+### Dependencies
 
 * [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
 
@@ -139,18 +247,20 @@ brew install git-quick-stats
 
 *Q:* I get some errors after run git-quick-stats in cygwin like `/usr/local/bin/git-quick-stats: line 2: $'\r': command not found`
 
-*A:* You can run dos2unix app in cygwin `/bin/dos2unix.exe /usr/local/bin/git-quick-stats`. This will convert it to Unix format and you then should be able to run it.
+*A:* You can run the dos2unix app in cygwin as follows: `/bin/dos2unix.exe /usr/local/bin/git-quick-stats`. This will convert the script from the CR-LF convention that Microsoft uses to the LF convention that UNIX, OS X, and Linux use. You should then should be able to run it as normal.
 
 ## Contribution
 
 Want to contribute? Great! First, read this page.
 
-#### Code reviews
-All submissions, including submissions by project members, require review.
-We use Github pull requests for this purpose.
+### Code reviews
 
-#### Some tips for good pull requests:
-* Use our code
+All submissions, including submissions by project members, require review.</br>
+We use GitHub pull requests for this purpose.
+
+### Some tips for good pull requests
+
+* Use our code </br>
   When in doubt, try to stay true to the existing code of the project.
 * Write a descriptive commit message. What problem are you solving and what
   are the consequences? Where and what did you test? Some good tips:
@@ -162,11 +272,11 @@ We use Github pull requests for this purpose.
   HEAD. This make reviewing the code so much easier, and our history more
   readable.
 
-#### Formatting
+### Formatting
 
 This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
 
-#### Tests
+## Tests
 
 [![codecov](https://codecov.io/gh/arzzen/git-quick-stats/branch/master/graph/badge.svg)](https://codecov.io/gh/arzzen/git-quick-stats)
 
@@ -175,9 +285,35 @@ make test
 ```
 
 ## Licensing
+
 MIT see [LICENSE][] for the full license text.
 
-   [read this page]: http://github.com/arzzen/git-quick-stats/blob/master/docs/CONTRIBUTING.md
+   [read this page]: http://github.com/arzzen/git-quick-stats/blob/master/.github/CONTRIBUTING.md
    [landing page]: http://arzzen.github.io/git-quick-stats
    [LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
 
+## Contributors
+
+This project exists thanks to all the people who contribute.
+<a href="https://github.com/arzzen/git-quick-stats/graphs/contributors"><img src="https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false" /></a>
+
+### Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
+
+<a href="https://opencollective.com/git-quick-stats#backers" target="_blank"><img src="https://opencollective.com/git-quick-stats/backers.svg?width=890"></a>
+
+### Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-quick-stats#sponsor)]
+
+<a href="https://opencollective.com/git-quick-stats/sponsor/0/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/0/avatar.svg?v=1"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/1/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/2/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/3/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/4/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/5/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/6/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/7/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/8/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/9/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg"></a>

docs/css/creative.css

@@ -1,509 +0,0 @@
-/*!
- * Start Bootstrap - Creative Bootstrap Theme (http://startbootstrap.com)
- * Code licensed under the Apache License v2.0.
- * For details, see http://www.apache.org/licenses/LICENSE-2.0.
- */
-
-html,
-body {
-    width: 100%;
-    height: 100%;
-}
-
-body {
-    font-family: Merriweather,'Helvetica Neue',Arial,sans-serif;
-}
-
-hr {
-    max-width: 50px;
-    border-color: #f05f40;
-    border-width: 3px;
-}
-
-hr.light {
-    border-color: #fff;
-}
-
-a {
-    color: #f05f40;
-    -webkit-transition: all .35s;
-    -moz-transition: all .35s;
-    transition: all .35s;
-}
-
-a:hover,
-a:focus {
-    color: #eb3812;
-}
-
-#about a {
-    color: rgba(52, 52, 52, .7);
-}
-
-#about a:hover,
-#about a:focus {
-    color: rgb(52, 52, 52);
-}
-
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-    font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
-}
-
-p {
-    margin-bottom: 20px;
-    font-size: 16px;
-    line-height: 1.5;
-}
-
-.bg-primary {
-    background-color: #f05f40;
-}
-
-.bg-dark {
-    color: #fff;
-    background-color: #222;
-}
-
-.text-faded {
-    color: rgba(255,255,255,.7);
-}
-
-section {
-    padding: 100px 0;
-}
-
-aside {
-    padding: 50px 0;
-}
-
-.no-padding {
-    padding: 0;
-}
-
-.navbar-default {
-    border-color: rgba(34,34,34,.05);
-    font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
-    background-color: #fff;
-    -webkit-transition: all .35s;
-    -moz-transition: all .35s;
-    transition: all .35s;
-}
-
-.navbar-default .navbar-header .navbar-brand {
-    text-transform: uppercase;
-    font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
-    font-weight: 700;
-    color: #2d8888;
-}
-
-.navbar-default .navbar-header .navbar-brand:hover,
-.navbar-default .navbar-header .navbar-brand:focus {
-    color: #eb3812;
-}
-
-.navbar-default .nav > li>a,
-.navbar-default .nav>li>a:focus {
-    text-transform: uppercase;
-    font-size: 13px;
-    font-weight: 700;
-    color: #222;
-}
-
-.navbar-default .nav > li>a:hover,
-.navbar-default .nav>li>a:focus:hover {
-    color: #f05f40;
-}
-
-.navbar-default .nav > li.active>a,
-.navbar-default .nav>li.active>a:focus {
-    color: #f05f40!important;
-    background-color: transparent;
-}
-
-.navbar-default .nav > li.active>a:hover,
-.navbar-default .nav>li.active>a:focus:hover {
-    background-color: transparent;
-}
-
-@media(min-width:768px) {
-    .navbar-default {
-        border-color: rgba(255,255,255,.3);
-        background-color: transparent;
-    }
-
-    .navbar-default .navbar-header .navbar-brand {
-        color: rgba(255,255,255,.7);
-    }
-
-    .navbar-default .navbar-header .navbar-brand:hover,
-    .navbar-default .navbar-header .navbar-brand:focus {
-        color: #fff;
-    }
-
-    .navbar-default .nav > li>a,
-    .navbar-default .nav>li>a:focus {
-        color: rgba(255,255,255,.7);
-    }
-
-    .navbar-default .nav > li>a:hover,
-    .navbar-default .nav>li>a:focus:hover {
-        color: #fff;
-    }
-
-    .navbar-default.affix {
-        border-color: rgba(34,34,34,.05);
-        background-color: #fff;
-    }
-
-    .navbar-default.affix .navbar-header .navbar-brand {
-        font-size: 14px;
-        color: #f05f40;
-    }
-
-    .navbar-default.affix .navbar-header .navbar-brand:hover,
-    .navbar-default.affix .navbar-header .navbar-brand:focus {
-        color: #eb3812;
-    }
-
-    .navbar-default.affix .nav > li>a,
-    .navbar-default.affix .nav>li>a:focus {
-        color: #222;
-    }
-
-    .navbar-default.affix .nav > li>a:hover,
-    .navbar-default.affix .nav>li>a:focus:hover {
-        color: #f05f40;
-    }
-}
-
-header {
-    position: relative;
-    width: 100%;
-    min-height: auto;
-    text-align: center;
-    color: #fff;
-    background-color: #2f2d2f;
-    /*background-color: #2c3333;*/
-    /*background-image: url(../img/header.jpg);*/
-    /*background-position: center;*/
-    /*-webkit-background-size: cover;*/
-    /*-moz-background-size: cover;*/
-    /*background-size: cover;*/
-    /*-o-background-size: cover;*/
-}
-
-header .header-content {
-    position: relative;
-    width: 100%;
-    padding: 100px 15px;
-    text-align: center;
-}
-
-header .header-content .header-content-inner h1 {
-    margin-top: 0;
-    margin-bottom: 0;
-    /* text-transform: uppercase; */
-    font-weight: 700;
-    font-size: 120px;
-}
-
-header .header-content .header-content-inner hr {
-    margin: 30px auto;
-}
-
-header .header-content .header-content-inner p {
-    margin-bottom: 50px;
-    font-size: 16px;
-    font-weight: 300;
-    color: rgba(255,255,255,.7);
-}
-
-@media(min-width:768px) {
-    header {
-        min-height: 100%;
-    }
-
-    header .header-content {
-        position: absolute;
-        top: 50%;
-        padding: 0 50px;
-        -webkit-transform: translateY(-50%);
-        -ms-transform: translateY(-50%);
-        transform: translateY(-50%);
-    }
-
-    header .header-content .header-content-inner {
-        margin-right: auto;
-        margin-left: auto;
-        max-width: 1000px;
-    }
-
-    header .header-content .header-content-inner p {
-        margin-right: auto;
-        margin-left: auto;
-        max-width: 80%;
-        font-size: 18px;
-    }
-}
-
-.section-heading {
-    margin-top: 0;
-}
-
-.service-box {
-    margin: 50px auto 0;
-    max-width: 400px;
-}
-
-@media(min-width:992px) {
-    .service-box {
-        margin: 20px auto 0;
-    }
-}
-
-.service-box p {
-    margin-bottom: 0;
-}
-
-.portfolio-box {
-    display: block;
-    position: relative;
-    margin: 0 auto;
-    max-width: 650px;
-}
-
-.portfolio-box .portfolio-box-caption {
-    display: block;
-    position: absolute;
-    bottom: 0;
-    width: 100%;
-    height: 100%;
-    text-align: center;
-    color: #fff;
-    opacity: 0;
-    background: rgba(240,95,64,.9);
-    -webkit-transition: all .35s;
-    -moz-transition: all .35s;
-    transition: all .35s;
-}
-
-.portfolio-box .portfolio-box-caption .portfolio-box-caption-content {
-    position: absolute;
-    top: 50%;
-    width: 100%;
-    text-align: center;
-    transform: translateY(-50%);
-}
-
-.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-category,
-.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-name {
-    padding: 0 15px;
-    font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
-}
-
-.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-category {
-    text-transform: uppercase;
-    font-size: 14px;
-    font-weight: 600;
-}
-
-.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-name {
-    font-size: 18px;
-}
-
-.portfolio-box:hover .portfolio-box-caption {
-    opacity: 1;
-}
-
-@media(min-width:768px) {
-    .portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-category {
-        font-size: 16px;
-    }
-
-    .portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-name {
-        font-size: 22px;
-    }
-}
-
-.call-to-action h2 {
-    margin: 0 auto 20px;
-}
-
-.text-primary {
-    color: #f05f40;
-}
-
-.no-gutter > [class*=col-] {
-    padding-right: 0;
-    padding-left: 0;
-}
-
-.btn-default {
-    border-color: #fff;
-    color: #222;
-    background-color: #fff;
-    -webkit-transition: all .35s;
-    -moz-transition: all .35s;
-    transition: all .35s;
-}
-
-.btn-default:hover,
-.btn-default:focus,
-.btn-default.focus,
-.btn-default:active,
-.btn-default.active,
-.open > .dropdown-toggle.btn-default {
-    border-color: #ededed;
-    color: #222;
-    background-color: #f2f2f2;
-}
-
-.btn-default:active,
-.btn-default.active,
-.open > .dropdown-toggle.btn-default {
-    background-image: none;
-}
-
-.btn-default.disabled,
-.btn-default[disabled],
-fieldset[disabled] .btn-default,
-.btn-default.disabled:hover,
-.btn-default[disabled]:hover,
-fieldset[disabled] .btn-default:hover,
-.btn-default.disabled:focus,
-.btn-default[disabled]:focus,
-fieldset[disabled] .btn-default:focus,
-.btn-default.disabled.focus,
-.btn-default[disabled].focus,
-fieldset[disabled] .btn-default.focus,
-.btn-default.disabled:active,
-.btn-default[disabled]:active,
-fieldset[disabled] .btn-default:active,
-.btn-default.disabled.active,
-.btn-default[disabled].active,
-fieldset[disabled] .btn-default.active {
-    border-color: #fff;
-    background-color: #fff;
-}
-
-.btn-default .badge {
-    color: #fff;
-    background-color: #222;
-}
-
-.btn-primary {
-    border-color: #f05f40;
-    color: #fff;
-    background-color: #2d8888;
-    -webkit-transition: all .35s;
-    -moz-transition: all .35s;
-    transition: all .35s;
-}
-
-.btn-primary:hover,
-.btn-primary:focus,
-.btn-primary.focus,
-.btn-primary:active,
-.btn-primary.active,
-.open > .dropdown-toggle.btn-primary {
-    color: #fff;
-    background-color: #68a9a9;
-}
-
-.btn-primary:active,
-.btn-primary.active,
-.open > .dropdown-toggle.btn-primary {
-    background-image: none;
-}
-
-.btn-primary.disabled,
-.btn-primary[disabled],
-fieldset[disabled] .btn-primary,
-.btn-primary.disabled:hover,
-.btn-primary[disabled]:hover,
-fieldset[disabled] .btn-primary:hover,
-.btn-primary.disabled:focus,
-.btn-primary[disabled]:focus,
-fieldset[disabled] .btn-primary:focus,
-.btn-primary.disabled.focus,
-.btn-primary[disabled].focus,
-fieldset[disabled] .btn-primary.focus,
-.btn-primary.disabled:active,
-.btn-primary[disabled]:active,
-fieldset[disabled] .btn-primary:active,
-.btn-primary.disabled.active,
-.btn-primary[disabled].active,
-fieldset[disabled] .btn-primary.active {
-    border-color: #f05f40;
-    background-color: #f05f40;
-}
-
-.btn-primary .badge {
-    color: #f05f40;
-    background-color: #fff;
-}
-
-.btn {
-    border: 0;
-    border-radius: 300px;
-    text-transform: uppercase;
-    font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
-    font-weight: 700;
-    font-size: 1.4em;
-}
-
-.btn-xl {
-    padding: 15px 30px;
-}
-
-::-moz-selection {
-    text-shadow: none;
-    color: #fff;
-    background: #222;
-}
-
-::selection {
-    text-shadow: none;
-    color: #fff;
-    background: #222;
-}
-
-img::selection {
-    color: #fff;
-    background: 0 0;
-}
-
-img::-moz-selection {
-    color: #fff;
-    background: 0 0;
-}
-
-body {
-    webkit-tap-highlight-color: #222;
-}
-
-#map {
-    height: 300px;
-    overflow: visible;
-    position: relative;
-}
-
-.subtitle {
-  color: #b1b1b1;
-}
-
-.logo {
-  width: 50%;
-  padding-bottom: 5px;
-}
-
-.screencap {
-  width: 80%;
-  padding-top: 20px;
-  padding-bottom: 30px;
-}

docs/css/modals.css

@@ -1,81 +0,0 @@
-/*!
- * The code below adds the modal functionality of the Freelancer Bootstrap Theme
- * and was originally part of this theme.
- *
- *
- * Start Bootstrap - Freelancer Bootstrap Theme (http://startbootstrap.com)
- * Code licensed under the Apache License v2.0.
- * For details, see http://www.apache.org/licenses/LICENSE-2.0.
- */
-
-body {
-    overflow-x: hidden;
-}
-
-.img-centered {
-    margin: 0 auto;
-}
-
-.portfolio-modal .modal-content {
-    padding: 100px 0;
-    min-height: 100%;
-    border: 0;
-    border-radius: 0;
-    text-align: center;
-    background-clip: border-box;
-    -webkit-box-shadow: none;
-    box-shadow: none;
-}
-
-.portfolio-modal .modal-content h2 {
-    margin: 0;
-    font-size: 3em;
-}
-
-.portfolio-modal .modal-content img {
-    margin-bottom: 30px;
-}
-
-.portfolio-modal .modal-content .item-details {
-    margin: 30px 0;
-}
-
-.portfolio-modal .close-modal {
-    position: absolute;
-    top: 25px;
-    right: 25px;
-    width: 75px;
-    height: 75px;
-    background-color: transparent;
-    cursor: pointer;
-}
-
-.portfolio-modal .close-modal:hover {
-    opacity: .3;
-}
-
-.portfolio-modal .close-modal .lr {
-    z-index: 1051;
-    width: 1px;
-    height: 75px;
-    margin-left: 35px;
-    background-color: #2c3e50;
-    -webkit-transform: rotate(45deg);
-    -ms-transform: rotate(45deg);
-    transform: rotate(45deg);
-}
-
-.portfolio-modal .close-modal .lr .rl {
-    z-index: 1052;
-    width: 1px;
-    height: 75px;
-    background-color: #2c3e50;
-    -webkit-transform: rotate(90deg);
-    -ms-transform: rotate(90deg);
-    transform: rotate(90deg);
-}
-
-.portfolio-modal .modal-backdrop {
-    display: none;
-    opacity: 0;
-}

docs/index.html

@@ -1,34 +0,0 @@
-<!DOCTYPE html>
-<html lang="en-us">
-    <head>
-        <meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<meta name="viewport" content="width=device-width, initial-scale=1">
-	<meta name="author" content="Lukas Mestan">
-	<meta name="description" content="Commandline GIT statistics">
-	<title>git quick stats</title>
-	<link rel="shortcut icon" href="favicon.ico?v=1" type="image/x-icon">
-	<link rel="stylesheet" href="css/bootstrap.min.css" type="text/css">
-	<link href="https://fonts.googleapis.com/css?family=Montserrat" rel="stylesheet"> 
-	<link rel="stylesheet" href="css/animate.min.css" type="text/css">
-	<link rel="stylesheet" href="css/creative.css" type="text/css">
-	<link rel="stylesheet" href="css/modals.css" type="text/css">
-	<!--[if lt IE 9]>
-	<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
-	<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
-	<![endif]-->
-    </head>
-    <body id="page-top">
-	<header>
-    		<div class="header-content">
-        		<div class="header-content-inner">
-				<h1>git quick stats</h1>
-		                <h3 class="subtitle"> simple and efficient way to access various statistics in git repository</h3>
-			        <img class="screencap" src="bg.png" \>
-				<br>
-		                <a href="https://github.com/arzzen/git-quick-stats" class="btn btn-primary btn-xl page-scroll">download</a>
-        		</div>
-    		</div>
-	</header>
-     </body>
-</html>

git-quick-stats.1

@@ -0,0 +1,136 @@
+.TH git-quick-stats "1" "January 2020" "git-quick-stats" "User Commands"
+.SH NAME
+.B git\-quick\-stats 
+\- Simple and efficient way to access various stats in a git repository.
+.SH SYNOPSIS
+.PP
+For non\-interactive mode: 
+.B git\-quick\-stats [OPTIONS]
+.PP
+For interactive mode: 
+.B git-quick-stats
+.PP
+.SH DESCRIPTION
+.PP
+Any git repository contains tons of information about commits, contributors,
+and files. Extracting this information is not always trivial, mostly because
+of a gadzillion options to a gadzillion git commands.
+This program allows you to see detailed information about a git repository.
+.PP
+.SH OPTIONS
+.HP
+\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
+.IP
+show the best people to contact to review code
+.HP
+.PP
+\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
+.IP
+give a detailed list of git stats
+.HP
+.PP
+\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
+.IP
+see detailed list of git stats by branch
+.HP
+.PP
+\fB\-d\fR, \fB\-\-commits\-per\-day\fR
+.IP
+displays a list of commits per day
+.HP
+.PP
+\fB\-m\fR, \fB\-\-commits\-by\-month\fR
+.IP
+displays a list of commits per month
+.HP
+.PP
+\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
+.IP
+displays a list of commits per weekday
+.HP
+.PP
+\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
+.IP
+displays a list of commits per hour
+.HP
+.PP
+\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
+.IP
+displays a list of commits per hour by author
+.HP
+.PP
+\fB\-a\fR, \fB\-\-commits\-per\-author\fR
+.IP
+displays a list of commits per author
+.HP
+.PP
+\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
+.IP
+see your current daily stats
+.HP
+.PP
+\fB\-C\fR, \fB\-\-contributors\fR
+.IP
+see a list of everyone who contributed to the repo
+.HP
+.PP
+\fB\-b\fR, \fB\-\-branch\-tree\fR
+.IP
+show an ASCII graph of the git repo branch history
+.HP
+.PP
+\fB\-D\fR, \fB\-\-branches\-by\-date\fR
+.IP
+show branches by date
+.HP
+.PP
+\fB\-c\fR, \fB\-\-changelogs\fR
+.IP
+see changelogs
+.HP
+.PP
+\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
+.IP
+see changelogs by author
+.HP
+.PP
+\fB\-j\fR, \fB\-\-json\-output\fR
+.IP
+save git log as a JSON formatted file to a specified area
+.HP
+.PP
+\fB\-h\fR, \-?, \fB\-\-help\fR
+.IP
+display this help text in the terminal
+.PP
+.SH ADDITIONAL USAGE
+You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
+.PP
+.B  export _GIT_SINCE="2017\-01\-20"
+.PP
+You can set _GIT_LIMIT for limited output log, example:
+.PP
+.B  export _GIT_LIMIT=20
+.PP
+You can set _GIT_LOG_OPTIONS for git log options, example:
+.PP
+.B  export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
+.PP
+You can exclude directories or files from the stats by using pathspec, example:
+.PP
+.B export _GIT_PATHSPEC=':!pattern'
+.PP
+You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
+.PP
+.B  export _GIT_MERGE_VIEW="enable"
+.PP
+You can also set _GIT_MERGE_VIEW to only show merge commits, example:
+.PP
+.B  export _GIT_MERGE_VIEW="exclusive"
+.PP
+You can switch to the legacy color scheme, example:
+.PP
+.B export _MENU_THEME=legacy
+.
+.fi
+

tests/commands_test.sh

@@ -3,17 +3,83 @@
 . tests/assert.sh -v
 
 src="./git-quick-stats"
+assert "$src fail" "Invalid argument
+
+NAME
+    git-quick-stats - Simple and efficient way to access various stats in a git repo
+
+SYNOPSIS
+    For non-interactive mode: git-quick-stats [OPTIONS]
+    For interactive mode: git-quick-stats
+
+DESCRIPTION
+    Any git repository contains tons of information about commits, contributors,
+    and files. Extracting this information is not always trivial, mostly because
+    of a gadzillion options to a gadzillion git commands.
+
+    This program allows you to see detailed information about a git repository.
+
+OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
+    -T, --detailed-git-stats
+        give a detailed list of git stats
+    -R, --git-stats-by-branch
+        see detailed list of git stats by branch
+    -d, --commits-per-day
+        displays a list of commits per day
+    -m, --commits-by-month
+        displays a list of commits per month
+    -w, --commits-by-weekday
+        displays a list of commits per weekday
+    -o, --commits-by-hour
+        displays a list of commits per hour
+    -A, --commits-by-author-by-hour
+        displays a list of commits per hour by author
+    -a, --commits-per-author
+        displays a list of commits per author
+    -S, --my-daily-stats
+        see your current daily stats
+    -C, --contributors
+        see a list of everyone who contributed to the repo
+    -b, --branch-tree
+        show an ASCII graph of the git repo branch history
+    -D, --branches-by-date
+        show branches by date
+    -c, --changelogs
+        see changelogs
+    -L, --changelogs-by-author
+        see changelogs by author
+    -j, --json-output
+        save git log as a JSON formatted file to a specified area
+    -h, -?, --help
+        display this help text in the terminal
+
+ADDITIONAL USAGE
+    You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log
+        ex: export _GIT_SINCE=\"2017-01-20\"
+    You can set _GIT_LIMIT for limited output log
+        ex: export _GIT_LIMIT=20
+    You can set _GIT_LOG_OPTIONS for git log options
+        ex: export _GIT_LOG_OPTIONS=\"--ignore-all-space --ignore-blank-lines\"
+    You can exclude directories or files from the stats by using pathspec
+        ex: export _GIT_PATHSPEC=':!pattern'
+    You can set _GIT_MERGE_VIEW to view merge commits with normal commits
+        ex: export _GIT_MERGE_VIEW=enable
+    You can also set _GIT_MERGE_VIEW to only show merge commits
+        ex: export _GIT_MERGE_VIEW=exclusive
+    You can set _MENU_THEME to display the legacy color scheme
+        ex: export _MENU_THEME=legacy"
 
-assert "$src fail" "Invalid argument. Possible arguments: suggestReviewers, detailedGitStats, commitsPerDay, commitsByMonth, commitsByWeekday, commitsByHour, commitsByAuthorByHour, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor"
 assert_raises "$src fail" 1
 
-assert_contains "$src suggestReviewers" "Suggested code reviewers (based on git history)" 127
-assert_raises "$src suggestReviewers" 0
+assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
+assert_raises "$src --suggest-reviewers" 0
 
-assert_contains "$src detailedGitStats" "Contribution stats" 127
-assert_raises "$src detailedGitStats" 0
+assert_contains "$src --detailed-git-stats" "Contribution stats" 127
+assert_raises "$src --detailed-git-stats" 0
 
-assert_contains "$src commitsPerDay" "Git commits per date" 127
-assert_raises "$src commitsPerDay" 0
+assert_contains "$src --commits-per-day" "Git commits per date" 127
+assert_raises "$src --commits-per-day" 0
 
 assert_end