Merge pull request #195 from tomice/issues/194-flatten-awk-arrays-for-bsd-awk-compat

Flatten arrays for wider awk compatibility

.github/FUNDING.yml

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

.gitignore

@@ -8,3 +8,6 @@
 .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 Mestan <lukas.mestan@gmail.com> arzzen 
+Lukas <test@gmail.com> Lukáš <arzzen@users.noreply.github.com> 
+Lukas <lukas@gmail.com> arzzen 
 

CITATION.cff

@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+title: Git Quick Stats
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - name-particle: tomice
+  - name-particle: arzzen
+identifiers:
+  - type: url
+    value: "https://github.com/git-quick-stats"
+    description: >-
+      Simple and efficient way to access various statistics
+      in a git repository
+repository-code: "https://github.com/git-quick-stats/git-quick-stats"
+url: "https://git-quick-stats.sh/"
+abstract: >-
+  Git-quick-stats is a simple and efficient way to access
+  various statistics in a git repository.
+keywords:
+  - git
+  - stats
+license: MIT
+version: 2.6.2

Dockerfile

@@ -4,7 +4,7 @@ FROM alpine
 COPY . /app
 
 # Install required packages & build git-quick-stats
-RUN     apk add --no-cache bash git make ncurses util-linux \
+RUN     apk add --no-cache bash git make ncurses coreutils util-linux \
     &&  cd /app \
     &&  make install \
     &&  rm -rf /app \
@@ -23,5 +23,6 @@ ENV _GIT_SINCE= \
     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) 2020 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

@@ -3,6 +3,7 @@ _INSTDIR ?= $(DESTDIR)$(PREFIX)
 BINDIR ?= $(_INSTDIR)/bin
 MANDIR ?= $(_INSTDIR)/share/man
 TASK_DONE = echo -e "\n✓ $@ done\n"
+SHELL := $(shell which bash)
 
 .PHONY: test
 
@@ -29,8 +30,8 @@ uninstall:
 	@$(TASK_DONE)
 
 reinstall:
-	@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
+	@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats
+	@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats.1
 	$(MAKE) install
 	@$(TASK_DONE)
 

README.md

@@ -1,11 +1,12 @@
+# 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)
+[![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](https://formulae.brew.sh/formula/git-quick-stats#default)
 
 > `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 :).
+> 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 :).
 
-![mainMenuScreenshot](https://user-images.githubusercontent.com/8818630/58364013-61e53800-7e7b-11e9-87f9-790d6744fbd5.png)
+![mainImageScreenshot](https://github.com/user-attachments/assets/7d8637a4-5a67-49f6-8724-ca7548b987c6)
 
 ## Table of Contents
 
@@ -13,34 +14,34 @@
 
 [**Usage**](#usage)
 
-* [**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)
-* [**Git merge view strategy**](#git-merge-view-strategy)
-* [**Color themes**](#color-themes)
+- [**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)
+- [**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)
+- [**UNIX and Linux**](#unix-and-linux)
+- [**macOS**](#macos-homebrew)
+- [**Windows**](#windows)
+- [**Docker**](#docker)
 
 [**System requirements**](#system-requirements)
 
-* [**Dependencies**](#dependencies)
+- [**Dependencies**](#dependencies)
 
 [**FAQ**](#faq)
 
 [**Contribution**](#contribution)
 
-* [**Code reviews**](#code-reviews)
-* [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
-* [**Formatting**](#formatting)
+- [**Code reviews**](#code-reviews)
+- [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
+- [**Formatting**](#formatting)
 
 [**Tests**](#tests)
 
@@ -48,20 +49,22 @@
 
 [**Contributors**](#contributors)
 
-* [**Backers**](#backers)
-* [**Sponsors**](#sponsors)
+- [**Backers**](#backers)
+- [**Sponsors**](#sponsors)
 
 ## Screenshots
 
-![commitsByWeekdayScreenshot](https://user-images.githubusercontent.com/8818630/58364011-61e53800-7e7b-11e9-9417-16cbb241ac2e.png)
+![commitsByWeekdayScreenshot](https://github.com/user-attachments/assets/3496d245-6385-47d1-878a-726e79100eb1)
 
-![commitsByHourScreenshot](https://user-images.githubusercontent.com/8818630/58364010-61e53800-7e7b-11e9-8711-a40b50aebf52.png)
+![commitsByHourScreenshot](https://github.com/user-attachments/assets/9f1d69d9-46e0-411d-a5ed-905ffdfb887a)
+
+![commitActivityScreenshot](https://github.com/user-attachments/assets/693fff31-65c7-4b9f-a011-6114a2d10a26)
 
 ## Usage
 
 ### Interactive
 
-git-quick-stats has a built-in interactive menu that can be executed as such:
+`git-quick-stats` has a built-in interactive menu that can be executed as such:
 
 ```bash
 git-quick-stats
@@ -92,38 +95,61 @@ git quick-stats <optional-command-to-execute-directly>
 Possible arguments in short and long form:
 
 ```bash
--r, --suggest-reviewers
-    show the best people to contact to review code
+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
--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
+    -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
+
+CALENDAR OPTIONS
+    -k, --commits-calendar-by-author
+        shows a calendar heatmap of commits per day-of-week per month for a given author
+    -H, --commits-heatmap
+        shows a heatmap of commits per day-of-week per month for the last 30 days
+
+SUGGEST OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
     -h, -?, --help
         display this help text in the terminal
 ```
@@ -141,7 +167,7 @@ Once set, run `git quick-stats` as normal. Note that this affects all stats that
 
 ### Git log limit
 
-You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options.
+You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
 
 ```bash
 export _GIT_LIMIT=20
@@ -149,7 +175,7 @@ export _GIT_LIMIT=20
 
 ### Git log options
 
-You can set _GIT_LOG_OPTIONS for [git log options](https://git-scm.com/docs/git-log#_options):
+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"
@@ -178,22 +204,65 @@ export _GIT_MERGE_VIEW="enable"
 export _GIT_MERGE_VIEW="exclusive"
 ```
 
-### Color themes
+### Git branch
 
-You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`
+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 _MENU_THEME=legacy
+export _GIT_BRANCH="master"
 ```
 
-![legacyThemeScreenshot](https://user-images.githubusercontent.com/8818630/58364012-61e53800-7e7b-11e9-910a-aaff836260eb.png)
+### 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"
+```
+
+### Commit days
+
+You can set \_GIT_DAYS to set the number of days for the heatmap
+
+```bash
+export _GIT_DAYS=30
+```
+
+### 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
 
+### Debian and Ubuntu
+
+If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
+
+```bash
+apt install git-quick-stats
+```
+
 ### UNIX and Linux
 
 ```bash
-git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
+git clone https://github.com/git-quick-stats/git-quick-stats.git && cd git-quick-stats
 sudo make install
 ```
 
@@ -211,18 +280,34 @@ sudo make reinstall
 
 ### 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
 ```
 
 Or you can follow the UNIX and Linux instructions if you wish.
 
+If you would like to default to using the GNU coreutils (recommended), then you
+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)
+- [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.
 
@@ -230,24 +315,51 @@ If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
 
 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)
+- 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
 
-* An OS with a Bash shell
-* Tools we use: awk ; basename ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
+- An OS with a Bash shell
+- Tools we use:
+
+```bash
+awk
+basename
+cat
+column
+date
+echo
+git
+grep
+head
+printf
+seq
+sort
+tput
+tr
+uniq
+```
 
 ### Dependencies
 
-* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
+- [`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 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.
+_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
 
@@ -260,13 +372,13 @@ We use GitHub pull requests for this purpose.
 
 ### Some tips for good pull requests
 
-* Use our code </br>
+- 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
@@ -288,32 +400,12 @@ make test
 
 MIT see [LICENSE][] for the full license text.
 
-   [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
+[read this page]: http://github.com/git-quick-stats/git-quick-stats/blob/master/.github/CONTRIBUTING.md
+[landing page]: https://git-quick-stats.sh
+[LICENSE]: https://github.com/git-quick-stats/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>
+[![contributors](https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false)](https://github.com/git-quick-stats/git-quick-stats/graphs/contributors)

git-quick-stats.1

@@ -1,4 +1,4 @@
-.TH git-quick-stats "1" "January 2020" "git-quick-stats" "User Commands"
+.TH git-quick-stats "1" "June 2025" "git-quick-stats" "User Commands"
 .SH NAME
 .B git\-quick\-stats
 \- Simple and efficient way to access various stats in a git repository.
@@ -17,12 +17,11 @@ 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
+.SH GENERATE OPTIONS
+.PP
+\fB\-h\fR, \-?, \fB\-\-help\fR
 .IP
-show the best people to contact to review code
-.HP
+display this help text in the terminal
 .PP
 \fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
 .IP
@@ -34,56 +33,6 @@ give a detailed list of git stats
 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
@@ -94,14 +43,109 @@ 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\-h\fR, \-?, \fB\-\-help\fR
+\fB\-b\fR, \fB\-\-branch\-tree\fR
 .IP
-display this help text in the terminal
+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
+.SH CALENDAR OPTIONS
+.PP
+\fB\-k\fR, \fB\-\-commits\-calendar\-by\-author\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
+.PP
+\fB\-H\fR, \fB\-\-commits\-heatmap\fR shows a heatmap of commits per day per hour for the last 30 days
 .PP
 .SH ADDITIONAL USAGE
 You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
@@ -128,9 +172,35 @@ 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:
+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
+You can set _GIT_IGNORE_AUTHORS to filter out specific authors, example:
+.PP
+.B  export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
+.PP
+You can set _GIT_DAYS to set the number of days for the heatmap, example:
+.PP
+.B  export _GIT_DAYS=30"
 .
 .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
@@ -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,14 +129,19 @@ 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

tests/commands_test.sh

@@ -1,9 +1,17 @@
 #!/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
+assert "$src fail" "Invalid argument: fail
 
 NAME
     git-quick-stats - Simple and efficient way to access various stats in a git repo
@@ -19,39 +27,61 @@ DESCRIPTION
     
     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
+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
-    -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
+    -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
+
+CALENDAR OPTIONS
+    -k, --commits-calendar-by-author
+        shows a calendar heatmap of commits per day-of-week per month for a given author
+    -H, --commits-heatmap
+        shows a heatmap of commits per day-of-week per month for the last 30 days
+
+SUGGEST OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
     -h, -?, --help
         display this help text in the terminal
 
@@ -68,18 +98,34 @@ ADDITIONAL USAGE
         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"
+    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\"
+    You can set _GIT_DAYS to set the number of days for the heatmap
+        ex: export _GIT_DAYS=30"
 
 assert_raises "$src fail" 1
 
-assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
-assert_raises "$src --suggest-reviewers" 0
+assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
+assert_success "$src --suggest-reviewers"
 
-assert_contains "$src --detailed-git-stats" "Contribution stats" 127
-assert_raises "$src --detailed-git-stats" 0
+assert_contains "$src --detailed-git-stats" "Contribution stats (by author) on the current branch"
+assert_success "$src --detailed-git-stats"
 
-assert_contains "$src --commits-per-day" "Git commits per date" 127
-assert_raises "$src --commits-per-day" 0
+assert_contains "$src --commits-per-day" "Git commits per date"
+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