update manpage

_MENU_THEME=none

.github/FUNDING.yml

@@ -0,0 +1 @@
+# These are supported funding model platforms

.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,13 @@
+*.json
+*.db
+.DS_Store*
+._*
+.*.swp
+.*.swo
+.Spotlight*
+.Trash*
+**/*~
+nbproject/*
+/tests/test-git/.git/
+#/tests/test-git/*
+!/tests/test-git/resetgit

.mailmap

@@ -1,3 +1,3 @@
-Lukas Mestan <lukas.mestan@gmail.com> Lukáš Mešťan <arzzen@users.noreply.github.com> 
+Lukas <test@gmail.com> Lukáš <arzzen@users.noreply.github.com> 
-Lukas Mestan <lukas.mestan@gmail.com> arzzen 
+Lukas <lukas@gmail.com> arzzen 
 

.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,28 @@
+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
+RUN git config --global --add safe.directory /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) 2024 git-quick-stats.sh
 
 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,42 +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
+SHELL := $(shell which bash)
-EXEC_FILES=git-quick-stats
 
 .PHONY: test
 
 all:
-	@echo "usage: make install"
+	@echo "Usage:"
-	@echo "       make reinstall"
+	@echo "  make install"
-	@echo "       make uninstall"
+	@echo "  make reinstall"
-	@echo "       make test"
+	@echo "  make uninstall"
+	@echo "  make test"
 
 help:
 	$(MAKE) all
 	@$(TASK_DONE)
 
 install:
-	mkdir -p $(PREFIX)/bin
+	install -d -m 0755 $(BINDIR)
-	install -m 0755 $(EXEC_FILES) $(PREFIX)/bin/$(EXEC_FILES)
+	install -m 0755 git-quick-stats $(BINDIR)/git-quick-stats
-	git config --global alias.quick-stats '! $(PREFIX)/bin/$(EXEC_FILES)'
 	$(MAKE) man
 	@$(TASK_DONE)
 
 uninstall:
-	test -d $(PREFIX)/bin && \
+	rm -f $(BINDIR)/git-quick-stats
-	cd $(PREFIX)/bin && \
+	rm -f $(MANDIR)/man1/git-quick-stats.1
-	rm -f $(EXEC_FILES) && \
-	git config --global --unset alias.quick-stats
 	@$(TASK_DONE)
 
 reinstall:
-	@curl -s https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats > git-quick-stats
+	@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats
-	$(MAKE) uninstall && \
+	@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats.1
 	$(MAKE) install
 	@$(TASK_DONE)
 
 man:
-	install -g 0 -o 0 -m 0644 git-quick-stats.1 /usr/share/man/man1/
+	install -d -m 0755 $(MANDIR)/man1/
+	install -m 0644 git-quick-stats.1 $(MANDIR)/man1/
 
 test:
 	tests/commands_test.sh

README.md

@@ -1,134 +1,252 @@
+# 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 [![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)
+[![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](https://formulae.brew.sh/formula/git-quick-stats#default)
 
-[![Travis](https://api.travis-ci.org/arzzen/git-quick-stats.svg?branch=master)](https://travis-ci.org/arzzen/git-quick-stats)
+> `git-quick-stats` is a simple and efficient way to access various statistics in a git repository.
-[![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)
+> 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.
+![mainMenuScreenshot](https://github.com/user-attachments/assets/05a20ff1-44f6-4e44-9d62-c2c089f9ff4e)
-
-> 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 :).
 
 ## 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)
+
-* [**Git log limit**](#git-log-limit)
+- [**Interactive**](#interactive)
-* [**Git pathspec**](#git-pathspec)
+- [**Non-interactive**](#non-interactive)
-* [**Tests**](#tests)
+- [**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)
+- [**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)
+![commitsByWeekdayScreenshot](https://github.com/user-attachments/assets/3a55f3ac-8801-4bbf-9b3a-92b53a64631e)
-
-![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)
 
+![commitsByHourScreenshot](https://github.com/user-attachments/assets/d7de5280-8bb9-4391-9c6c-7e688f2df171)
 
 ## 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:
+Or
 
-`git quick-stats <optional-command-to-execute-directly>`
+```bash
+git quick-stats
+```
+
+### 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:
+
+```bash
+git-quick-stats <optional-command-to-execute-directly>
+```
+
+Or
+
+```bash
+git quick-stats <optional-command-to-execute-directly>
+```
+
+### Command-line arguments
 
 Possible arguments in short and long form:
 
-```
+```bash
--r, --suggest-reviewers
+GENERATE OPTIONS
-    show the best people to contact to review code
+    -T, --detailed-git-stats
--T, --detailed-git-stats
+        give a detailed list of git stats
-    give a detailed list of git stats
+    -R, --git-stats-by-branch
--d, --commits-per-day
+        see detailed list of git stats by branch
-    displays a list of commits per day
+    -c, --changelogs
--m, --commits-by-month
+        see changelogs
-    displays a list of commits per month
+    -L, --changelogs-by-author
--w, --commits-by-weekday
+        see changelogs by author
-    displays a list of commits per weekday
+    -S, --my-daily-stats
--o, --commits-by-hour
+        see your current daily stats
-    displays a list of commits per hour
+    -V, --csv-output-by-branch
--A, --commits-by-author-by-hour
+        output daily stats by branch in CSV format
-    displays a list of commits per hour by author
+    -j, --json-output
--a, --commits-per-author
+        save git log as a JSON formatted file to a specified area
-    displays a list of commits per author
+
--S, --my-daily-stats
+LIST OPTIONS
-    see your current daily stats
+    -b, --branch-tree
--C, --contributors
+        show an ASCII graph of the git repo branch history
-    see a list of everyone who contributed to the repo
+    -D, --branches-by-date
--b, --branch-tree
+        show branches by date
-    show an ASCII graph of the git repo branch history
+    -C, --contributors
--D, --branches-by-date
+        see a list of everyone who contributed to the repo
-    show branches by date
+    -n, --new-contributors
--c, --changelogs
+        list everyone who made their first contribution since a specified date
-    see changelogs
+    -a, --commits-per-author
--L, --changelogs-by-author
+        displays a list of commits per author
-    see changelogs by author
+    -d, --commits-per-day
--h, -?, --help
+        displays a list of commits per day
-    display this help text in the terminal
+    -Y, --commits-by-year
+        displays a list of commits per year
+    -m, --commits-by-month
+        displays a list of commits per month
+    -w, --commits-by-weekday
+        displays a list of commits per weekday
+    -W, --commits-by-author-by-weekday
+        displays a list of commits per weekday by author
+    -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
+    -z, --commits-by-timezone
+        displays a list of commits per timezone
+    -Z, --commits-by-author-by-timezone
+        displays a list of commits per timezone by author
+
+SUGGEST OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
+    -h, -?, --help
+        display this help text in the terminal
 ```
 
-#### Git log since / until
+### Git log since and until
 
-You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
+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-20-01"
+export _GIT_SINCE="2017-01-20"
-export _GIT_UNTIL="2017-22-01"
+export _GIT_UNTIL="2017-01-22"
 ```
 
-then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
+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
 
-#### Git log limit
+You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
-
-You can set variable `_GIT_LIMIT` for limited output (it will affect: "Git changelogs" and "Branch tree view" )
 
 ```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"
+```
+
+### Git branch
+
+You can set the variable `_GIT_BRANCH` to set the branch of the stats. Works with commands `--git-stats-by-branch` and `--csv-output-by-branch`.
+
+```bash
+export _GIT_BRANCH="master"
+```
+
+### Ignore authors
+
+You can set the variable `_GIT_IGNORE_AUTHORS` to filter out specific authors. It will affect the "All contributors", ""Suggested code reviewers" and "New contributors" options.
+
+```bash
+export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
+```
+
+### Sorting contribution stats
+
+You can sort contribution stats by field `name`, `commits`, `insertions`, `deletions`, or `lines` (total lines changed) and order (`asc`, `desc`). e.g.: `commits-desc`
+
+```bash
+export _GIT_SORT_BY="name-asc"
+```
+
+### Color themes
+
+You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`.
+You can completely disable the color theme by setting the `_MENU_THEME` variable to `none`.
+
+```bash
+export _MENU_THEME="legacy"
+# or
+export _MENU_THEME="none"
+```
+
+![legacyThemeScreenshot](https://github.com/user-attachments/assets/3b319c1a-827f-47b8-bbfa-b8b59a39deef)
 
 ## Installation
 
-#### Unix like OS
+### Debian and Ubuntu
+
+If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
 
 ```bash
-git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
+apt install git-quick-stats
+```
+
+### UNIX and Linux
+
+```bash
+git clone https://github.com/git-quick-stats/git-quick-stats.git && cd git-quick-stats
 sudo make install
 ```
 
@@ -144,59 +262,117 @@ For update/reinstall
 sudo make reinstall
 ```
 
-#### OS X (homebrew)
+### macOS (homebrew)
+
+macOS requires GNU coreutils to be installed and for the non "g" aliased
+versions to be exported to your path. The following is an example of how to
+perform this if you are using Homebrew as your package manager.
+
+```bash
+brew install coreutils
+export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
+```
+
+From there, you can install via Homebrew as follows:
 
 ```bash
 brew install git-quick-stats
 ```
 
-#### Windows (cygwin)
+Or you can follow the UNIX and Linux instructions if you wish.
 
-* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
+If you would like to default to using the GNU coreutils (recommended), then you
-* [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
+can add `export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"` to
+your applicable `~/.bash_profile`, `~/.zprofile`, or other relevant profile
+based on the shell of your choice.
 
+### 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
+- An OS with a Bash shell
-* Tools we use: awk ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
+- Tools we use:
 
-#### Dependences
+```bash
+awk
+basename
+cat
+column
+date
+echo
+git
+grep
+head
+printf
+seq
+sort
+tput
+tr
+uniq
+```
 
-* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
+### Dependencies
+
+- [`bsdextrautils`](https://packages.debian.org/sid/bsdextrautils) `apt install bsdextrautils`
+- [`coreutils`](https://packages.debian.org/sid/coreutils) `apt install coreutils`
+- [`gawk`](https://packages.debian.org/sid/gawk) `apt install gawk`
+- [`grep`](https://packages.debian.org/sid/grep) `apt install grep`
+- [`ncurses-bin`](https://packages.debian.org/sid/ncurses-bin) `apt install ncurses-bin`
 
 ## FAQ
 
-*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`
+_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.
+
+_Q:_ How they could be used in a project with many git projects and statistics would show a summary of all git projects?
+
+_A:_ If you want to include submodule logs, you can try using the following: `export _GIT_LOG_OPTIONS="-p --submodule=log"`
+(more info about [git log --submodule](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
 
 ## Contribution
 
 Want to contribute? Great! First, read this page.
 
-#### Code reviews
+### Code reviews
-All submissions, including submissions by project members, require review.</br>
-We use Github pull requests for this purpose.
 
-#### Some tips for good pull requests:
+All submissions, including submissions by project members, require review.</br>
-* Use our code </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
+- Write a descriptive commit message. What problem are you solving and what
   are the consequences? Where and what did you test? Some good tips:
   [here](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
   and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches).
-* If your PR consists of multiple commits which are successive improvements /
+- If your PR consists of multiple commits which are successive improvements /
   fixes to your first commit, consider squashing them into a single commit
   (`git rebase -i`) such that your PR is a single commit on top of the current
   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)
 
@@ -205,9 +381,36 @@ 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/git-quick-stats/git-quick-stats/blob/master/.github/CONTRIBUTING.md
-   [landing page]: http://arzzen.github.io/git-quick-stats
+[landing page]: https://git-quick-stats.sh
-   [LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
+[LICENSE]: https://github.com/git-quick-stats/git-quick-stats/blob/master/LICENSE
 
+## Contributors
+
+This project exists thanks to all the people who contribute.
+
+[![contributors](https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false)](https://github.com/git-quick-stats/git-quick-stats/graphs/contributors)
+
+### Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
+
+[![backers](https://opencollective.com/git-quick-stats/backers.svg?width=890)](https://opencollective.com/git-quick-stats#backers)
+
+### 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)]
+
+[![sponsor0](https://opencollective.com/git-quick-stats/sponsor/0/avatar.svg?v=1)](https://opencollective.com/git-quick-stats/sponsor/0/website)
+[![sponsor1](https://opencollective.com/git-quick-stats/sponsor/1/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/1/website)
+[![sponsor2](https://opencollective.com/git-quick-stats/sponsor/2/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/2/website)
+[![sponsor3](https://opencollective.com/git-quick-stats/sponsor/3/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/3/website)
+[![sponsor4](https://opencollective.com/git-quick-stats/sponsor/4/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/4/website)
+[![sponsor5](https://opencollective.com/git-quick-stats/sponsor/5/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/5/website)
+[![sponsor6](https://opencollective.com/git-quick-stats/sponsor/6/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/6/website)
+[![sponsor7](https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/7/website)
+[![sponsor8](https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/8/website)
+[![sponsor9](https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/9/website)

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,35 +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]-->
-	<meta http-equiv="refresh" content="0;url=https://lukasmestan.com/git-quick-stats/">
-    </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

@@ -1,13 +1,13 @@
-.TH git-quick-stats "1" "January 2019" "git-quick-stats" "User Commands"
+.TH git-quick-stats "1" "June 2025" "git-quick-stats" "User Commands"
 .SH NAME
-.B git\-quick\-stats 
+.B git\-quick\-stats
 \- Simple and efficient way to access various stats in a git repository.
 .SH SYNOPSIS
 .PP
-For non\-interactive mode: 
+For non\-interactive mode:
 .B git\-quick\-stats [OPTIONS]
 .PP
-For interactive mode: 
+For interactive mode:
 .B git-quick-stats
 .PP
 .SH DESCRIPTION
@@ -17,67 +17,16 @@ 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
+.SH GENERATE OPTIONS
-.HP
-\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
-.IP
-show the best people to contact to review code
-.HP
-.PP
 .PP
 \fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
 .IP
 give a detailed list of git stats
 .HP
 .PP
-\fB\-d\fR, \fB\-\-commits\-per\-day\fR
+\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
 .IP
-displays a list of commits per day
+see detailed list of git stats by branch
-.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
@@ -90,24 +39,175 @@ see changelogs
 see changelogs by author
 .HP
 .PP
+\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
+.IP
+see your current daily stats
+.HP
+.PP
+\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
+.IP
+output daily stats by branch in CSV format
+.HP
+.PP
+\fB\-j\fR, \fB\-\-json\-output\fR
+.IP
+save git log as a JSON formatted file to a specified area
+.HP
+.SH LIST OPTIONS
+.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\-\-contributors\fR
+.IP
+see a list of everyone who contributed to the repo
+.HP
+.PP
+\fB\-n\fR, \fB\-\-new\-contributors\fR
+.IP
+list everyone who made their first contribution since a specified date
+.HP
+.PP
+\fB\-a\fR, \fB\-\-commits\-per\-author\fR
+.IP
+displays a list of commits per author
+.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\-Y\fR, \fB\-\-commits\-by\-year\fR
+.IP
+displays a list of commits per year
+.HP
+.PP
+\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
+.IP
+displays a list of commits per weekday
+.HP
+.PP
+\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
+.IP
+displays a list of commits per weekday by author
+.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\-z\fR, \fB\-\-commits\-by\-timezone\fR
+.IP
+displays a list of commits per timezone
+.HP
+.PP
+\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
+.IP
+displays a list of commits per timezone by author
+.HP
+.PP
+\fB\-\-activity\-calendar\fR
+.IP
+displays a calendar-style grid of commit activity per day-of-week and month for a selected author.
+.HP
+.SH SUGGEST OPTIONS
+.PP
+\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
+.IP
+show the best people to contact to review code
+.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:
-.IP
 .PP
-.B  export _GIT_SINCE="2017\-20\-01"
+.B  export _GIT_SINCE="2017\-01\-20"
-.IP
 .PP
 You can set _GIT_LIMIT for limited output log, example:
 .PP
 .B  export _GIT_LIMIT=20
 .PP
-You can exclude a directory from the stats by using pathspec, example:
+You can set _GIT_LOG_OPTIONS for git log options, example:
 .PP
-.B export _GIT_PATHSPEC=':!directory'
+.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 sort contribution stats by field "name", "commits", "insertions", "deletions", or "lines" (total lines changed) and order ("asc", "desc"). e.g.: "commits-desc"
+.PP
+.B  export _GIT_SORT_BY="name-asc"
+.PP
+You can change to the legacy color scheme by toggling the variable "_MENU_THEME" between "default" and "legacy". You can completely disable the color theme by setting the "_MENU_THEME" variable to "none", example:
+.PP
+.B export _MENU_THEME=legacy
+.PP
+or
+.B export _MENU_THEME=none
+.PP
+You can set _GIT_BRANCH to set the branch of the stats, example:
+.PP
+.B  export _GIT_BRANCH="master"
+.PP
+.SH Calendar activity output
+.PP
+\fBactivity-calendar\fR outputs a visual grid of commit activity for a selected author, grouped by day-of-week (rows: Mon..Sun) and month (columns: Jan..Dec). Each cell is 3 characters wide, separated by one space.
+.PP
+Sample output:
+.PP
+.nf
+      Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
+Mon   ▓▓▓ ░░░ ▒▒▒ ░░░ ░░░ ▒▒▒ ▓▓▓ ░░░ ░░░ ▓▓▓ ▒▒▒ ▒▒▒
+Tue   ▒▒▒ ░░░ ▒▒▒ ░░░ ▒▒▒ ░░░ ▒▒▒ ▓▓▓ ▒▒▒ ░░░ ░░░ ░░░
+Wed   ░░░ ▓▓▓ ░░░ ▓▓▓ ▒▒▒ ░░░ ░░░ ▒▒▒ ░░░ ░░░ ▓▓▓ ░░░
+Thu   ░░░ ▒▒▒ ░░░ ░░░ ▒▒▒ ░░░ ▓▓▓ ▒▒▒ ▒▒▒ ░░░ ░░░ ▒▒▒
+Fri   ▒▒▒ ░░░ ▒▒▒ ▓▓▓ ░░░ ▓▓▓ ▒▒▒ ░░░ ▒▒▒ ░░░ ▒▒▒ ░░░
+Sat   ░░░ ░░░ ▒▒▒ ░░░ ░░░ ░░░ ▒▒▒ ░░░ ▒▒▒ ▓▓▓ ▒▒▒ ░░░
+Sun   ▓▓▓ ░░░ ▓▓▓ ░░░ ░░░ ▓▓▓ ░░░ ▒▒▒ ░░░ ░░░ ▓▓▓ ░░░
+
+Legend: ... = 0   ░░░ = 1–2   ▒▒▒ = 3–5   ▓▓▓ = 6+ commits
+.PP
+You can set _GIT_IGNORE_AUTHORS to filter out specific authors, example:
+.PP
+.B  export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
 .
 .fi
 
+.PP
+.SH SEE ALSO
+.BR git (1)
+.PP
+Project homepage:
+.UR https://github.com/git-quick-stats/git-quick-stats
+.UE

tests/assert.sh

@@ -17,12 +17,16 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+set -o nounset
+
 export DISCOVERONLY=${DISCOVERONLY:-}
 export DEBUG=${DEBUG:-}
 export STOP=${STOP:-}
 export INVARIANT=${INVARIANT:-}
 export CONTINUE=${CONTINUE:-}
 
+GREP=${GREP:-grep}
+
 args="$(getopt -n "$0" -l \
     verbose,help,stop,discover,invariant,continue vhxdic $*)" \
 || exit -1
@@ -75,7 +79,7 @@ assert_end() {
     tests_endtime="$(date +%s%N)"
     # required visible decimal place for seconds (leading zeros if needed)
     local tests_time="$( \
-        printf "%010d" "$(( ${tests_endtime/%N/000000000} 
+        printf "%010d" "$(( ${tests_endtime/%N/000000000}
                             - ${tests_starttime/%N/000000000} ))")"  # in ns
     tests="$tests_ran ${*:+$* }tests"
     [[ -n "$DISCOVERONLY" ]] && echo "collected $tests." && _assert_reset && return
@@ -101,7 +105,7 @@ assert_end() {
 assert() {
     # assert <command> <expected stdout> [stdin]
     (( tests_ran++ )) || :
-    [[ -z "$DISCOVERONLY" ]] || return
+    [[ -z "$DISCOVERONLY" ]] || return 0
     expected=$(echo -ne "${2:-}")
     result="$(eval 2>/dev/null $1 <<< ${3:-})" || true
     if [[ "$result" == "$expected" ]]; then
@@ -111,13 +115,13 @@ assert() {
     result="$(sed -e :a -e '$!N;s/\n/\\n/;ta' <<< "$result")"
     [[ -z "$result" ]] && result="nothing" || result="\"$result\""
     [[ -z "$2" ]] && expected="nothing" || expected="\"$2\""
-    _assert_fail "expected $expected${_indent}got $result" "$1" "$3"
+    _assert_fail "expected $expected${_indent}got $result" "$1" "${3:-}"
 }
 
 assert_raises() {
     # assert_raises <command> <expected code> [stdin]
     (( tests_ran++ )) || :
-    [[ -z "$DISCOVERONLY" ]] || return
+    [[ -z "$DISCOVERONLY" ]] || return 0
     status=0
     (eval $1 <<< ${3:-}) > /dev/null 2>&1 || status=$?
     expected=${2:-0}
@@ -125,19 +129,24 @@ assert_raises() {
         [[ -z "$DEBUG" ]] || echo -n .
         return
     fi
-    _assert_fail "program terminated with code $status instead of $expected" "$1" "$3"
+    _assert_fail "program terminated with code $status instead of $expected" "$1" "${3:-}"
+}
+
+assert_success() {
+    # assert_success <command>
+    assert_raises "$1" 0
 }
 
 # _assert_with_grep <grep modifiers> <command> <expected output...>
 _assert_with_grep() {
     local grep_modifier="$1"
     local output="$($2)"
-    local exitcode="$4" || 0
+    local exitcode=0
     shift 2
 
     while [ $# != 0 ]; do
-    	assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
+        assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
-    	shift
+        shift
     done
 }
 

tests/commands_test.sh

@@ -1,19 +1,123 @@
 #!/bin/bash
 
+# Verify we are in a git repo. Create one if not
+# FIXME: All the paths are hardcoded currently and will break if anything
+# in this chain moves or gets executed elsewhere. Adjust all of these so
+# pathing does not matter as much such as creating a TOP variable that
+# does something like TOP=$(cd "$(dirname "$0")" || exit ; pwd -P)
+# or maybe leverages Make to handle these as test targets
+./tests/test-git/resetgit
+
 . tests/assert.sh -v
 
 src="./git-quick-stats"
-#assert "$src fail" "Invalid argument\n\nNAME\n    git-quick-stats - Simple and efficient way to access various stats in a git repo\n\nSYNOPSIS\n    For non-interactive mode: git-quick-stats [OPTIONS]\n    For interactive mode: git-quick-stats\n\nDESCRIPTION\n    Any git repository contains tons of information about commits, contributors,\n    and files. Extracting this information is not always trivial, mostly because\n    of a gadzillion options to a gadzillion git commands.\n\n    This program allows you to see detailed information about a git repository.\n\nOPTIONS\n    suggestReviewers - see best people to contact to review code\n    detailedGitStats - displays a detailed list of git status\n    commitsPerDay - displays a list of commits per day\n    commitsByMonth - displays a list of commits per month\n    commitsByWeekday - displays a list of commits per weekday\n    commitsByHour - displays a list of commits per hour\n    commitsByAuthorByHour - see a list of commits per hour by author\n    commitsPerAuthor - displays a list of commits per author\n    myDailyStats - see your current daily stats\n    contributors - see a list of all contributors\n    branchTree - see an ASCII graph of the git repo\n    branchesByDate - show branches by date\n    changelogs - see changelogs\n    changelogsByAuthor - see changelogs by author\n\nADDITIONAL USAGE\n    You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log\n        ex: export _GIT_SINCE=2017-20-01\n    You can set _GIT_LIMIT for limited output log\n        ex: export _GIT_LIMIT=20\n    You can exclude a directory from the stats by using pathspec\n        ex: export _GIT_PATHSPEC=':!directory'\n    \nCONTRIBUTION\n    For details regarding contribution, please see the contribution.md document\n\nLICENSE\n    This is under the MIT license. See LICENSE in the repo for more info"
+assert "$src fail" "Invalid argument: fail
-assert "$src fail" "Invalid argument\n\nNAME\n    git-quick-stats - Simple and efficient way to access various stats in a git repo\n\nSYNOPSIS\n    For non-interactive mode: git-quick-stats [OPTIONS]\n    For interactive mode: git-quick-stats\n\nDESCRIPTION\n    Any git repository contains tons of information about commits, contributors,\n    and files. Extracting this information is not always trivial, mostly because\n    of a gadzillion options to a gadzillion git commands.\n\n    This program allows you to see detailed information about a git repository.\n\nOPTIONS\n    -r, --suggest-reviewers\n        show the best people to contact to review code\n    -T, --detailed-git-stats\n        give a detailed list of git stats\n    -d, --commits-per-day\n        displays a list of commits per day\n    -m, --commits-by-month\n        displays a list of commits per month\n    -w, --commits-by-weekday\n        displays a list of commits per weekday\n    -o, --commits-by-hour\n        displays a list of commits per hour\n    -A, --commits-by-author-by-hour\n        displays a list of commits per hour by author\n    -a, --commits-per-author\n        displays a list of commits per author\n    -S, --my-daily-stats\n        see your current daily stats\n    -C, --contributors\n        see a list of everyone who contributed to the repo\n    -b, --branch-tree\n        show an ASCII graph of the git repo branch history\n    -D, --branches-by-date\n        show branches by date\n    -c, --changelogs\n        see changelogs\n    -L, --changelogs-by-author\n        see changelogs by author\n    -h, -?, --help\n        display this help text in the terminal\n\nADDITIONAL USAGE\n    You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log\n        ex: export _GIT_SINCE=\"2017-20-01\"\n    You can set _GIT_LIMIT for limited output log\n        ex: export _GIT_LIMIT=20\n    You can exclude a directory from the stats by using pathspec\n        ex: export _GIT_PATHSPEC=':!directory'"
+
+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.
+
+GENERATE OPTIONS
+    -T, --detailed-git-stats
+        give a detailed list of git stats
+    -R, --git-stats-by-branch
+        see detailed list of git stats by branch
+    -c, --changelogs
+        see changelogs
+    -L, --changelogs-by-author
+        see changelogs by author
+    -S, --my-daily-stats
+        see your current daily stats
+    -V, --csv-output-by-branch
+        output daily stats by branch in CSV format
+    -j, --json-output
+        save git log as a JSON formatted file to a specified area
+
+LIST OPTIONS
+    -b, --branch-tree
+        show an ASCII graph of the git repo branch history
+    -D, --branches-by-date
+        show branches by date
+    -C, --contributors
+        see a list of everyone who contributed to the repo
+    -n, --new-contributors
+        list everyone who made their first contribution since a specified date
+    -a, --commits-per-author
+        displays a list of commits per author
+    -d, --commits-per-day
+        displays a list of commits per day
+    -m, --commits-by-month
+        displays a list of commits per month
+    -Y, --commits-by-year
+        displays a list of commits per year
+    -w, --commits-by-weekday
+        displays a list of commits per weekday
+    -W, --commits-by-author-by-weekday
+        displays a list of commits per weekday by author
+    -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
+    -z, --commits-by-timezone
+        displays a list of commits per timezone
+    -Z, --commits-by-author-by-timezone
+        displays a list of commits per timezone by author
+
+SUGGEST OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
+    -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 change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
+    You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
+        ex: export _MENU_THEME=legacy
+    You can set _GIT_BRANCH to set the branch of the stats
+        ex: export _GIT_BRANCH=master
+    You can set _GIT_IGNORE_AUTHORS to filter out specific authors
+        ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
+    You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
+        ex: export _GIT_SORT_BY=\"name-asc\""
+
 assert_raises "$src fail" 1
 
-assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
+assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
-assert_raises "$src --suggest-reviewers" 0
+assert_success "$src --suggest-reviewers"
 
-assert_contains "$src --detailed-git-stats" "Contribution stats" 127
+assert_contains "$src --detailed-git-stats" "Contribution stats (by author) on the current branch"
-assert_raises "$src --detailed-git-stats" 0
+assert_success "$src --detailed-git-stats"
 
-assert_contains "$src --commits-per-day" "Git commits per date" 127
+assert_contains "$src --commits-per-day" "Git commits per date"
-assert_raises "$src --commits-per-day" 0
+assert_success "$src --commits-per-day"
+
+assert_startswith "$src --commits-by-year" "Git commits by year"
+assert_success "$src --commits-by-year"
+
+export LC_TIME=POSIX
+assert_startswith "$src --commits-by-year" "Git commits by year"
+assert_success "$src --commits-by-year"
 
 assert_end

tests/test-git/resetgit

@@ -0,0 +1,16 @@
+#!/bin/sh
+# Initialises a new local Git repo for test purpose if one does not exist already
+if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
+    {
+        git init
+        git config user.name "$(printf %s 'Test Git,\nfor test purpose')"
+        git config user.email "TestGit\o/@example.org"
+
+        printf 'test-git\n========\n' > README.md
+        git add README.md
+        git commit -m 'added readme (o\w/o)' -m 'in markdown, no \r\n, only \n' -m 'a very "simple" readme'
+        testChars="$(printf 'tab [%b] form feed [%b] line feed [%b] carriage return [%b]' '\x09' '\x0C' '\x0A' '\x0D')"
+        git notes add -m 'Some notes' -m 'out of ascii: été au cœur' -m "$testChars"
+        git log
+    } >/dev/null 2>&1
+fi