mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
Compare commits
47 Commits
2.5.4
...
134-featur
| Author | SHA1 | Date | |
|---|---|---|---|
|
376887a394 | ||
|
cebb5a8f48 | ||
|
|
343351b762 | ||
|
|
95136d3f92 | ||
|
|
79c735c814 | ||
|
|
ec6a95d2ef | ||
|
|
b65b100cd8 | ||
|
|
dd7719c3b0 | ||
|
|
c34ceb4c0e | ||
|
|
850b7453eb | ||
|
5063d1aad7 | ||
|
|
53b9971cf7 | ||
|
|
eec6d53ce9 | ||
|
|
d06a7ca090 | ||
|
|
462439a855 | ||
|
|
c467a9694b | ||
|
|
d4f71cfdad | ||
|
|
88e369503e | ||
|
|
afd61ce9c2 | ||
|
|
e1e02024a1 | ||
|
|
d1641f7bf3 | ||
|
|
8de8c43212 | ||
|
f4ec72073d | ||
|
|
b0003bef49 | ||
|
|
a833a5f431 | ||
|
|
886f64f086 | ||
|
115b21a48d | ||
|
|
4d515b88b3 | ||
|
|
9b3c0e5db1 | ||
|
|
86ad0af8bb | ||
|
fb488abe3e | ||
|
|
3cce04ddad | ||
|
|
d4e56cf557 | ||
|
cf239e5523 | ||
|
|
a0f495894b | ||
|
|
4faf233ad1 | ||
|
7d5087795e | ||
|
|
fe2df31c36 | ||
|
615563459f | ||
|
|
8c1d81a29d | ||
|
|
9f96cecf42 | ||
|
|
5b01b5e055 | ||
|
|
32a84903ff | ||
|
cd6d67df06 | ||
|
|
00d13c0b79 | ||
|
|
b525ed3b5c | ||
|
|
41a8542aaa |
5
.github/FUNDING.yml
vendored
5
.github/FUNDING.yml
vendored
@@ -1,6 +1 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: [arzzen]
|
||||
open_collective: git-quick-stats
|
||||
ko_fi: lukasmestan
|
||||
custom: ['https://lukasmestan.com/thanks/']
|
||||
|
||||
4
.mailmap
4
.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
|
||||
|
||||
|
||||
@@ -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" ]
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021 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
|
||||
|
||||
4
Makefile
4
Makefile
@@ -30,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)
|
||||
|
||||
|
||||
137
README.md
137
README.md
@@ -1,13 +1,12 @@
|
||||
|
||||
# GIT quick statistics [](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)
|
||||
[](#backers) [](#sponsors) [](https://formulae.brew.sh/formula/git-quick-stats#default)
|
||||
|
||||
[](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 :).
|
||||
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -15,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)
|
||||
|
||||
@@ -50,14 +49,14 @@
|
||||
|
||||
[**Contributors**](#contributors)
|
||||
|
||||
* [**Backers**](#backers)
|
||||
* [**Sponsors**](#sponsors)
|
||||
- [**Backers**](#backers)
|
||||
- [**Sponsors**](#sponsors)
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -117,6 +116,8 @@ LIST OPTIONS
|
||||
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
|
||||
@@ -203,15 +204,34 @@ You can set the variable `_GIT_BRANCH` to set the branch of the stats. Works wit
|
||||
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 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"
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -226,7 +246,7 @@ 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
|
||||
```
|
||||
|
||||
@@ -244,18 +264,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.
|
||||
|
||||
@@ -263,20 +299,21 @@ 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:
|
||||
- An OS with a Bash shell
|
||||
- Tools we use:
|
||||
|
||||
```bash
|
||||
awk
|
||||
basename
|
||||
cat
|
||||
column
|
||||
date
|
||||
echo
|
||||
git
|
||||
grep
|
||||
@@ -291,17 +328,21 @@ 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?
|
||||
_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"`
|
||||
_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
|
||||
@@ -315,13 +356,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
|
||||
@@ -343,15 +384,15 @@ 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.
|
||||
|
||||
[](https://github.com/arzzen/git-quick-stats/graphs/contributors)
|
||||
[](https://github.com/git-quick-stats/git-quick-stats/graphs/contributors)
|
||||
|
||||
### Backers
|
||||
|
||||
|
||||
594
git-quick-stats
594
git-quick-stats
@@ -17,7 +17,7 @@ _since=${_GIT_SINCE:-}
|
||||
if [[ -n "${_since}" ]]; then
|
||||
_since="--since=$_since"
|
||||
else
|
||||
_since="--since=$(git log --reverse --format='%ad' | head -n1)"
|
||||
_since="--since=$(git log --reverse --format='%ad' --date=iso | head -n1)"
|
||||
fi
|
||||
|
||||
# End of git log date. Respects all git datetime formats
|
||||
@@ -27,7 +27,7 @@ _until=${_GIT_UNTIL:-}
|
||||
if [[ -n "${_until}" ]]; then
|
||||
_until="--until=$_until"
|
||||
else
|
||||
_until="--until=$(date '+%a, %d %b %Y %H:%M:%S %Z')"
|
||||
_until="--until=$(LC_TIME=C date '+%a, %d %b %Y %H:%M:%S %Z')"
|
||||
fi
|
||||
|
||||
# Set files or directories to be excluded in stats
|
||||
@@ -68,10 +68,79 @@ else
|
||||
_log_options=""
|
||||
fi
|
||||
|
||||
# Ignore author regex
|
||||
_ignore_authors=${_GIT_IGNORE_AUTHORS:-}
|
||||
if [[ -n "${_ignore_authors}" ]]; then
|
||||
_ignore_authors=$_ignore_authors
|
||||
else
|
||||
_ignore_authors=""
|
||||
fi
|
||||
|
||||
# Sort by field and order for contribution stats
|
||||
_GIT_SORT_BY=${_GIT_SORT_BY:-name-asc}
|
||||
# If the user has not set a sort order, default to name-asc
|
||||
if [[ ! "$_GIT_SORT_BY" =~ ^(name|commits|insertions|deletions|lines)-(asc|desc)$ ]]; then
|
||||
echo "Invalid sort option: $_GIT_SORT_BY. Defaulting to 'name-asc'."
|
||||
_GIT_SORT_BY="name-asc"
|
||||
fi
|
||||
|
||||
# Default menu theme
|
||||
# Set the legacy theme by typing "export _MENU_THEME=legacy"
|
||||
_theme="${_MENU_THEME:=default}"
|
||||
|
||||
# DESC: Shows a calendar heatmap of commits per day-of-week per month for a given author
|
||||
# ARGS: $author (required)
|
||||
function commitsCalendarByAuthor() {
|
||||
local author="${1:-}"
|
||||
[[ -z "$author" ]] && { echo "Usage: commitsCalendarByAuthor <author>"; return 1; }
|
||||
|
||||
optionPicked "Commit Activity Calendar for '$author'"
|
||||
|
||||
# Print header
|
||||
printf "\n Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec\n"
|
||||
|
||||
# Gather commit counts
|
||||
git -c log.showSignature=false log --use-mailmap $_merges \
|
||||
--date=iso --author="$author" "$_since" "$_until" $_log_options \
|
||||
--pretty='%ad' $_pathspec | awk '
|
||||
{
|
||||
split($0, a, " ");
|
||||
# a[1] = YYYY-MM-DD
|
||||
split(a[1], date_fields, "-");
|
||||
mon = date_fields[2] + 0;
|
||||
cmd = "date -d \"" a[1] "\" +%u";
|
||||
cmd | getline weekday;
|
||||
close(cmd);
|
||||
# weekday: 1=Mon, ..., 7=Sun
|
||||
count[weekday][mon]++;
|
||||
}
|
||||
END {
|
||||
# Output matrix
|
||||
for (d=1; d<=7; d++) {
|
||||
if (d==1) printf "Mon ";
|
||||
else if (d==2) printf "Tue ";
|
||||
else if (d==3) printf "Wed ";
|
||||
else if (d==4) printf "Thu ";
|
||||
else if (d==5) printf "Fri ";
|
||||
else if (d==6) printf "Sat ";
|
||||
else if (d==7) printf "Sun ";
|
||||
for (m=1; m<=12; m++) {
|
||||
c = count[d][m]+0;
|
||||
if (c==0)
|
||||
out="...";
|
||||
else if (c<=9)
|
||||
out="░░░";
|
||||
else if (c<=19)
|
||||
out="▒▒▒";
|
||||
else
|
||||
out="▓▓▓";
|
||||
printf "%s%s", out, (m<12?" ":"\n"); }
|
||||
}
|
||||
printf "\nLegend: ... = 0 ░░░ = 1–9 ▒▒▒ = 10–19 ▓▓▓ = 20+ commits\n";
|
||||
}
|
||||
'
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# HELPER AND MENU FUNCTIONS
|
||||
|
||||
@@ -82,13 +151,29 @@ _theme="${_MENU_THEME:=default}"
|
||||
################################################################################
|
||||
function checkUtils() {
|
||||
readonly MSG="not found. Please make sure this is installed and in PATH."
|
||||
readonly UTILS="awk basename cat column echo git grep head printf seq sort \
|
||||
tput tr uniq"
|
||||
readonly UTILS="awk basename cat column date echo git grep head printf seq \
|
||||
sort tput tr uniq"
|
||||
|
||||
for u in $UTILS
|
||||
do
|
||||
command -v "$u" >/dev/null 2>&1 || { echo >&2 "$u ${MSG}"; exit 1; }
|
||||
done
|
||||
|
||||
# NOTE: The --version flag is only available in GNU date which is required
|
||||
# for how the current date/time strings are used in this shell script.
|
||||
# To fully support the legacy BSD date found in a default install within
|
||||
# macOS and older distributions of Linux and Unix, a handful of helper
|
||||
# functions can probably be created to handle every case of incompatibility
|
||||
# between the two. Until that's implemented, it is probably best to warn
|
||||
# the user that this will not work rather than having it silently bomb out
|
||||
# during runtime.
|
||||
if ! date --version >/dev/null 2>&1; then
|
||||
echo "ERROR: GNU date is required."
|
||||
echo "If you're on macOS, please install it using 'brew install coreutils'."
|
||||
echo "Ensure that your PATH is configured to use GNU date as well."
|
||||
echo "See the README.md for further details."
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
################################################################################
|
||||
@@ -102,23 +187,6 @@ function optionPicked() {
|
||||
echo -e "${msg}\n"
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Format date string
|
||||
# ARGS: $* (required): String
|
||||
# OUTS: String
|
||||
################################################################################
|
||||
format_date() {
|
||||
local date="${1}"
|
||||
local outf="${2}"
|
||||
local datef="${3:-"%b %d %H:%M:%S %Y %Z"}" # Tue Oct 24 13:34:22 2023 +0300
|
||||
if [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
||||
local resp="$(date -d "${date}" "+${outf}")"
|
||||
elif [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
local resp="$(date -j -f "${datef}" "${date}" "+${outf}")"
|
||||
fi
|
||||
printf "%s" "${resp}"
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Help information printed to stdout during non-interactive mode
|
||||
# ARGS: None
|
||||
@@ -165,6 +233,8 @@ LIST OPTIONS
|
||||
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
|
||||
@@ -205,10 +275,15 @@ 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
|
||||
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"
|
||||
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\""
|
||||
}
|
||||
|
||||
################################################################################
|
||||
@@ -231,19 +306,29 @@ function showMenu() {
|
||||
EXIT_TXT=""
|
||||
|
||||
# Adjustable color menu option
|
||||
if [[ "${_theme}" == "legacy" ]]; then
|
||||
case "${_theme}" in
|
||||
"legacy" )
|
||||
TITLES="${BOLD}${RED}"
|
||||
TEXT="${NORMAL}${CYAN}"
|
||||
NUMS="${BOLD}${YELLOW}"
|
||||
HELP_TXT="${NORMAL}${YELLOW}"
|
||||
EXIT_TXT="${BOLD}${RED}"
|
||||
else
|
||||
;;
|
||||
"none" )
|
||||
TITLES="${BOLD}"
|
||||
TEXT="${NORMAL}"
|
||||
NUMS="${BOLD}"
|
||||
HELP_TXT="${NORMAL}"
|
||||
EXIT_TXT="${BOLD}"
|
||||
;;
|
||||
*)
|
||||
TITLES="${BOLD}${CYAN}"
|
||||
TEXT="${NORMAL}${WHITE}"
|
||||
NUMS="${NORMAL}${BOLD}${WHITE}"
|
||||
HELP_TXT="${NORMAL}${CYAN}"
|
||||
EXIT_TXT="${BOLD}${CYAN}"
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
printf %b "\\n${TITLES} Generate:${NORMAL}\\n"
|
||||
printf %b "${NUMS} 1)${TEXT} Contribution stats (by author)\\n"
|
||||
@@ -257,29 +342,40 @@ function showMenu() {
|
||||
printf %b "${NUMS} 8)${TEXT} Branch tree view (last $_limit)\\n"
|
||||
printf %b "${NUMS} 9)${TEXT} All branches (sorted by most recent commit)\\n"
|
||||
printf %b "${NUMS} 10)${TEXT} All contributors (sorted by name)\\n"
|
||||
printf %b "${NUMS} 11)${TEXT} Git commits per author\\n"
|
||||
printf %b "${NUMS} 12)${TEXT} Git commits per date\\n"
|
||||
printf %b "${NUMS} 13)${TEXT} Git commits per month\\n"
|
||||
printf %b "${NUMS} 14)${TEXT} Git commits per year\\n"
|
||||
printf %b "${NUMS} 15)${TEXT} Git commits per weekday\\n"
|
||||
printf %b "${NUMS} 16)${TEXT} Git commits per weekday by author\\n"
|
||||
printf %b "${NUMS} 17)${TEXT} Git commits per hour\\n"
|
||||
printf %b "${NUMS} 18)${TEXT} Git commits per hour by author\\n"
|
||||
printf %b "${NUMS} 19)${TEXT} Git commits per timezone\\n"
|
||||
printf %b "${NUMS} 20)${TEXT} Git commits per timezone by author\\n"
|
||||
printf %b "${NUMS} 11)${TEXT} New contributors (sorted by email)\\n"
|
||||
printf %b "${NUMS} 12)${TEXT} Git commits per author\\n"
|
||||
printf %b "${NUMS} 13)${TEXT} Git commits per date\\n"
|
||||
printf %b "${NUMS} 14)${TEXT} Git commits per month\\n"
|
||||
printf %b "${NUMS} 15)${TEXT} Git commits per year\\n"
|
||||
printf %b "${NUMS} 16)${TEXT} Git commits per weekday\\n"
|
||||
printf %b "${NUMS} 17)${TEXT} Git commits per weekday by author\\n"
|
||||
printf %b "${NUMS} 18)${TEXT} Git commits per hour\\n"
|
||||
printf %b "${NUMS} 19)${TEXT} Git commits per hour by author\\n"
|
||||
printf %b "${NUMS} 20)${TEXT} Git commits per timezone\\n"
|
||||
printf %b "${NUMS} 21)${TEXT} Git commits per timezone by author\\n"
|
||||
printf %b "\\n${TITLES} Suggest:\\n"
|
||||
printf %b "${NUMS} 21)${TEXT} Code reviewers (based on git history)\\n"
|
||||
printf %b "${NUMS} 22)${TEXT} Code reviewers (based on git history)\\n"
|
||||
printf %b "\\n${TITLES} Calendar:\\n"
|
||||
printf %b "${NUMS} 23)${TEXT} Activity calendar by author\\n"
|
||||
printf %b "\\n${HELP_TXT}Please enter a menu option or ${EXIT_TXT}press Enter to exit.\\n"
|
||||
printf %b "${TEXT}> ${NORMAL}"
|
||||
read -r opt
|
||||
}
|
||||
|
||||
filter_ignored_authors() {
|
||||
if [[ -n "$_ignore_authors" ]]; then
|
||||
grep -Ev "$_ignore_authors"
|
||||
else
|
||||
cat
|
||||
fi
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# FUNCTIONS FOR GENERATING STATS
|
||||
|
||||
################################################################################
|
||||
# DESC: Shows detailed contribution stats per author by parsing every commit in
|
||||
# the repo and outputting their contribution stats
|
||||
# the repo and outputting their contribution stats.
|
||||
# ARGS: $branch (optional): Users can specify an alternative branch instead of
|
||||
# the current default one
|
||||
# OUTS: None
|
||||
@@ -311,78 +407,151 @@ function detailedGitStats() {
|
||||
optionPicked "Contribution stats (by author) on the current branch:"
|
||||
fi
|
||||
|
||||
local sort_by="${_GIT_SORT_BY:-name-asc}"
|
||||
local sort_field
|
||||
local sort_order
|
||||
local sort_command
|
||||
|
||||
sort_field=$(echo "$sort_by" | awk -F- '{print $1}')
|
||||
sort_order=$(echo "$sort_by" | awk -F- '{print $2}')
|
||||
|
||||
local sort_key
|
||||
case "$sort_field" in
|
||||
name) sort_key=1 ;;
|
||||
commits) sort_key=2 ;;
|
||||
insertions) sort_key=3 ;;
|
||||
deletions) sort_key=4 ;;
|
||||
lines) sort_key=5 ;;
|
||||
*)
|
||||
echo "Invalid sort field: $sort_field. Defaulting to 'name'."
|
||||
sort_key=1
|
||||
;;
|
||||
esac
|
||||
|
||||
echo -e "Sorting by: $sort_field ($sort_order)\n"
|
||||
|
||||
local sort_flags="-t'|' -k${sort_key},${sort_key}"
|
||||
if [[ "$sort_field" != "name" ]]; then
|
||||
sort_flags="${sort_flags}n"
|
||||
fi
|
||||
if [[ "$sort_order" == "desc" ]]; then
|
||||
sort_flags="${sort_flags}r"
|
||||
fi
|
||||
sort_command="sort ${sort_flags}"
|
||||
|
||||
# 1. git log -> awk (extract data) -> sort -> awk (format output with graphs)
|
||||
git -c log.showSignature=false log ${_branch} --use-mailmap $_merges --numstat \
|
||||
--pretty="format:commit %H%nAuthor: %aN <%aE>%nDate: %ad%n%n%w(0,4,4)%B%n" \
|
||||
"$_since" "$_until" $_log_options $_pathspec | LC_ALL=C awk '
|
||||
function printStats(author) {
|
||||
printf "\t%s:\n", author
|
||||
|
||||
if(more["total"] > 0) {
|
||||
printf "\t insertions: %d\t(%.0f%%)\n", more[author], \
|
||||
(more[author] / more["total"] * 100)
|
||||
}
|
||||
|
||||
if(less["total"] > 0) {
|
||||
printf "\t deletions: %d\t(%.0f%%)\n", less[author], \
|
||||
(less[author] / less["total"] * 100)
|
||||
}
|
||||
|
||||
if(file["total"] > 0) {
|
||||
printf "\t files: %d\t(%.0f%%)\n", file[author], \
|
||||
(file[author] / file["total"] * 100)
|
||||
}
|
||||
|
||||
if(commits["total"] > 0) {
|
||||
printf "\t commits: %d\t(%.0f%%)\n", commits[author], \
|
||||
(commits[author] / commits["total"] * 100)
|
||||
}
|
||||
|
||||
if (first[author] != "") {
|
||||
if ( ((more["total"] + less["total"]) * 100) > 0) {
|
||||
printf "\t lines changed: %d\t", more[author] + less[author]
|
||||
printf "(%.0f%%)\n", ((more[author] + less[author]) / \
|
||||
(more["total"] + less["total"]) * 100)
|
||||
}
|
||||
else {
|
||||
printf "\t lines changed: %d\t(0%%)\n", (more[author] + less[author])
|
||||
}
|
||||
printf "\t first commit: %s\n", first[author]
|
||||
printf "\t last commit: %s\n", last[author]
|
||||
}
|
||||
|
||||
printf "\n"
|
||||
}
|
||||
|
||||
"$_since" "$_until" $_log_options $_pathspec |
|
||||
LC_ALL=C awk '
|
||||
# This first awk script extracts raw data into a delimited format
|
||||
/^Author:/ {
|
||||
$1 = ""
|
||||
author = $0
|
||||
commits[author] += 1
|
||||
commits["total"] += 1
|
||||
$1 = ""; author = $0;
|
||||
commits[author] += 1;
|
||||
}
|
||||
|
||||
/^Date:/ {
|
||||
$1="";
|
||||
first[author] = substr($0, 2)
|
||||
if(last[author] == "" ) { last[author] = first[author] }
|
||||
$1=""; current_date = substr($0, 2);
|
||||
if (last[author] == "") { last[author] = current_date; }
|
||||
first[author] = current_date;
|
||||
}
|
||||
|
||||
/^[0-9]/ {
|
||||
more[author] += $1
|
||||
less[author] += $2
|
||||
|
||||
file[author] += 1
|
||||
more["total"] += $1
|
||||
less["total"] += $2
|
||||
file["total"] += 1
|
||||
more[author] += $1;
|
||||
less[author] += $2;
|
||||
file[author] += 1;
|
||||
}
|
||||
|
||||
END {
|
||||
for (author in commits) {
|
||||
if (author != "total") {
|
||||
printStats(author)
|
||||
lines_changed = more[author] + less[author];
|
||||
printf "%s|%d|%d|%d|%d|%d|%s|%s\n",
|
||||
author, commits[author]+0, more[author]+0, less[author]+0,
|
||||
lines_changed, file[author]+0, first[author], last[author];
|
||||
}
|
||||
}' |
|
||||
eval "$sort_command" | filter_ignored_authors |
|
||||
LC_ALL=C awk '
|
||||
# This second awk script stores data, calculates totals, and then formats output with graphs
|
||||
BEGIN {
|
||||
FS = "|";
|
||||
total_commits = 0; total_insertions = 0; total_deletions = 0;
|
||||
total_lines = 0; total_files = 0;
|
||||
num_authors = 0; # Counter for stored authors
|
||||
}
|
||||
printStats("total")
|
||||
{
|
||||
# Store all data for a second pass after totals are known
|
||||
authors[num_authors] = $1;
|
||||
commits_arr[num_authors] = $2;
|
||||
insertions_arr[num_authors] = $3;
|
||||
deletions_arr[num_authors] = $4;
|
||||
lines_changed_arr[num_authors] = $5;
|
||||
files_arr[num_authors] = $6;
|
||||
first_commit_arr[num_authors] = $7;
|
||||
last_commit_arr[num_authors] = $8;
|
||||
|
||||
# Accumulate overall totals
|
||||
total_commits += $2;
|
||||
total_insertions += $3;
|
||||
total_deletions += $4;
|
||||
total_lines += $5;
|
||||
total_files += $6;
|
||||
num_authors++;
|
||||
}
|
||||
END {
|
||||
for (j = 0; j < num_authors; j++) {
|
||||
author = authors[j];
|
||||
current_commits = commits_arr[j];
|
||||
current_insertions = insertions_arr[j];
|
||||
current_deletions = deletions_arr[j];
|
||||
current_lines_changed = lines_changed_arr[j];
|
||||
current_files = files_arr[j];
|
||||
current_first_commit = first_commit_arr[j];
|
||||
current_last_commit = last_commit_arr[j];
|
||||
|
||||
printf "\t%s:\n", author;
|
||||
|
||||
# Commits graph
|
||||
if (total_commits > 0) {
|
||||
commit_percent = (current_commits * 100.0) / total_commits;
|
||||
printf "\t commits: %d (%.1f%%)\n", current_commits, commit_percent;
|
||||
} else {
|
||||
printf "\t commits: %d\n", current_commits;
|
||||
}
|
||||
|
||||
# Insertions graph
|
||||
if (total_insertions > 0) {
|
||||
insert_percent = (current_insertions * 100.0) / total_insertions;
|
||||
printf "\t insertions: %d (%.1f%%)\n", current_insertions, insert_percent;
|
||||
} else {
|
||||
printf "\t insertions: %d\n", current_insertions;
|
||||
}
|
||||
|
||||
# Deletions graph
|
||||
if (total_deletions > 0) {
|
||||
delete_percent = (current_deletions * 100.0) / total_deletions;
|
||||
printf "\t deletions: %d (%.1f%%)\n", current_deletions, delete_percent;
|
||||
} else {
|
||||
printf "\t deletions: %d\n", current_deletions;
|
||||
}
|
||||
|
||||
# Lines changed graph
|
||||
if (total_lines > 0) {
|
||||
lines_percent = (current_lines_changed * 100.0) / total_lines;
|
||||
printf "\t lines changed: %d (%.1f%%)\n", current_lines_changed, lines_percent;
|
||||
} else {
|
||||
printf "\t lines changed: %d\n", current_lines_changed;
|
||||
}
|
||||
|
||||
printf "\t files: %d\n", current_files;
|
||||
printf "\t first commit: %s\n", current_first_commit;
|
||||
printf "\t last commit: %s\n\n", current_last_commit;
|
||||
}
|
||||
|
||||
# Print overall totals
|
||||
printf "\t%s:\n", " total";
|
||||
printf "\t commits: %d\n", total_commits;
|
||||
printf "\t insertions: %d\n", total_insertions;
|
||||
printf "\t deletions: %d\n", total_deletions;
|
||||
printf "\t lines changed: %d\n", total_lines;
|
||||
printf "\t files: %d\n\n", total_files;
|
||||
}'
|
||||
}
|
||||
|
||||
@@ -392,8 +561,9 @@ function detailedGitStats() {
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function changelogs() {
|
||||
local author="${1:-}"
|
||||
local _author=""
|
||||
local commits=""
|
||||
local author="${1:-}"
|
||||
local next=$(date +%F)
|
||||
|
||||
if [[ -z "${author}" ]]; then
|
||||
@@ -411,12 +581,18 @@ function changelogs() {
|
||||
--date=short "${_author}" "$_since" "$_until" $_log_options $_pathspec \
|
||||
| sort -u -r | head -n $_limit \
|
||||
| while read DATE; do
|
||||
day=$(format_date "$DATE" "%A" "%Y-%m-%d")
|
||||
echo -e "\n[$DATE - $day]"
|
||||
GIT_PAGER=cat git -c log.showSignature=false log \
|
||||
commits=$(git -c log.showSignature=false log \
|
||||
--use-mailmap $_merges \
|
||||
--format=" * %s (%aN)" "${_author}" \
|
||||
--since==$(date -d "$DATE - 1 day" +"%Y-%m-%d") --until=$next
|
||||
--since="$DATE 00:00:00" --until="$DATE 23:59:59" \
|
||||
--date-order)
|
||||
|
||||
if [[ -n "$commits" ]]; then
|
||||
echo -e "\n[$DATE]"
|
||||
echo "$commits"
|
||||
else
|
||||
echo "No commits found on $DATE"
|
||||
fi
|
||||
next=$DATE
|
||||
done
|
||||
}
|
||||
@@ -462,7 +638,8 @@ function csvOutput() {
|
||||
# Check if requesting for a specific branch
|
||||
if [[ -n "${branch}" ]]; then
|
||||
# Check if branch exist
|
||||
if [[ $(git show-ref refs/heads/"${branch}") ]] ; then
|
||||
if [[ $(git show-ref refs/heads/"${branch}") ]] ;
|
||||
then
|
||||
is_branch_existing=true
|
||||
_branch="${branch}"
|
||||
else
|
||||
@@ -475,17 +652,21 @@ function csvOutput() {
|
||||
printf "files_per,commits,commits_per,lines_changed,lines_changed_per\n"
|
||||
git -c log.showSignature=false log ${_branch} --use-mailmap $_merges --numstat \
|
||||
--pretty="format:commit %H%nAuthor: %aN <%aE>%nDate: %ad%n%n%w(0,4,4)%B%n" \
|
||||
"$_since" "$_until" $_log_options $_pathspec | LC_ALL=C awk '
|
||||
"$_since" "$_until" $_log_options $_pathspec | filter_ignored_authors | LC_ALL=C awk '
|
||||
function printStats(author) {
|
||||
printf "%s,", author
|
||||
if(more["total"] > 0) {
|
||||
printf "%d,%.0f%%,", more[author], \
|
||||
(more[author] / more["total"] * 100)
|
||||
} else {
|
||||
printf "0,0%%,"
|
||||
}
|
||||
|
||||
if(less["total"] > 0) {
|
||||
printf "%d,%.0f%%,", less[author], \
|
||||
(less[author] / less["total"] * 100)
|
||||
} else {
|
||||
printf "0,0%%,"
|
||||
}
|
||||
|
||||
if(file["total"] > 0) {
|
||||
@@ -617,7 +798,7 @@ function jsonOutput() {
|
||||
"$propTag"' commit_notes%n%N%n'"$propTag"',%n "author": {%n'\
|
||||
"$propTag"' name%n%aN%n'"$propTag"',%n'\
|
||||
"$propTag"' email%n%aE%n'"$propTag"',%n'\
|
||||
' "date": "%aD"%n },%n "commiter": {%n'\
|
||||
' "date": "%aD"%n },%n "committer": {%n'\
|
||||
"$propTag"' name%n%cN%n'"$propTag"',%n'\
|
||||
"$propTag"' email%n%cE%n'"$propTag"',%n'\
|
||||
' "date": "%cD"%n }%n},' \
|
||||
@@ -665,7 +846,27 @@ function branchesByDate() {
|
||||
function contributors() {
|
||||
optionPicked "All contributors (sorted by name):"
|
||||
git -c log.showSignature=false log --use-mailmap $_merges "$_since" "$_until" \
|
||||
--format='%aN' $_log_options $_pathspec | sort -u | cat -n
|
||||
--format='%aN' $_log_options $_pathspec | filter_ignored_authors | sort -u | cat -n
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Lists all new contributors to a repo since the specified time
|
||||
# ARGS: $newDate (required): Cutoff date for being considered "new"
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function newContributors() {
|
||||
optionPicked "New contributors since $newDate:"
|
||||
local contributors=$(git -c log.showSignature=false log --use-mailmap $_merges \
|
||||
"$_since" "$_until" --format='%aE' $_log_options \
|
||||
$_pathspec | sort -u)
|
||||
for c in $contributors; do
|
||||
local firstCommit=$(git -c log.showSignature=false log --author="$c" \
|
||||
--reverse --use-mailmap $_merges "$_since" "$_until" \
|
||||
--format='%at' $_log_options $_pathspec | filter_ignored_authors | head -n 1)
|
||||
if [[ $firstCommit -ge $(date -d "$newDate" +%s) ]]; then
|
||||
echo "$c"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
################################################################################
|
||||
@@ -678,10 +879,10 @@ function commitsPerAuthor() {
|
||||
optionPicked "Git commits per author:"
|
||||
local authorCommits=$(git -c log.showSignature=false log --use-mailmap \
|
||||
$_merges "$_since" "$_until" $_log_options \
|
||||
| grep -i Author: | cut -c9-)
|
||||
| grep -i '^Author:' | cut -c9-)
|
||||
local coAuthorCommits=$(git -c log.showSignature=false log --use-mailmap \
|
||||
$_merges "$_since" "$_until" $_log_options \
|
||||
| grep -i Co-Authored-by: | cut -c21-)
|
||||
| grep -i '^ Co-Authored-by:' | cut -c21-)
|
||||
|
||||
if [[ -z "${coAuthorCommits}" ]]; then
|
||||
allCommits="${authorCommits}"
|
||||
@@ -713,6 +914,47 @@ function commitsPerDay() {
|
||||
--date=short --format='%ad' $_log_options $_pathspec | sort | uniq -c
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Convert a timestamp to a date string to handle git's date formats
|
||||
# ARGS: $1: Timestamp
|
||||
# OUTS: Echoes a four-digit year
|
||||
################################################################################
|
||||
function parse_year() {
|
||||
local date_str="$1"
|
||||
local year
|
||||
local timestamp
|
||||
local default_git_date_regex
|
||||
|
||||
# Handle the raw UNIX timestamp format i.e. 1697375696 +0000
|
||||
if [[ "$date_str" =~ ^[0-9]+(\ [+-][0-9]{4})?$ ]]; then
|
||||
timestamp=$(echo "$date_str" | awk '{print $1}')
|
||||
year=$(date -d "@$timestamp" '+%Y' 2>/dev/null)
|
||||
else
|
||||
# Default case can get funky. We need to create a clever regex to
|
||||
# handle the default case which is like Mon Oct 15 12:34:56 2023 +0000
|
||||
# Let's make this explicit for future devs to follow along.
|
||||
default_git_date_regex='^' # Start from the beginning of the string
|
||||
default_git_date_regex+='[A-Za-z]{3}\ ' # Day abbrev
|
||||
default_git_date_regex+='[A-Za-z]{3}\ ' # Month abbrev
|
||||
default_git_date_regex+='[0-9]{1,2}\ ' # Day of the month
|
||||
default_git_date_regex+='[0-9]{2}:[0-9]{2}:[0-9]{2}\ ' # Time HH:MM:SS
|
||||
default_git_date_regex+='[0-9]{4}\ ' # Year
|
||||
default_git_date_regex+='[+-][0-9]{4}$' # Timezone offset
|
||||
|
||||
if [[ "$date_str" =~ $default_git_date_regex ]]; then
|
||||
# Move the year before the time to match a format that Date can parse
|
||||
date_str=$(echo "$date_str" | awk '{print $1, $2, $3, $5, $4, $6}')
|
||||
elif [[ "$date_str" =~ ^[0-9]{1,2}/[0-9]{1,2}/[0-9]{2,4} ]]; then
|
||||
# Handle DD/MM/YYYY format
|
||||
date_str=$(echo "$date_str" | awk -F'/' '{print $2"/"$1"/"$3}')
|
||||
fi
|
||||
# Extract the final date
|
||||
year=$(date -d "$date_str" '+%Y' 2>/dev/null)
|
||||
fi
|
||||
|
||||
echo "$year"
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Displays a horizontal bar graph based on total commits per year
|
||||
# ARGS: None
|
||||
@@ -721,30 +963,39 @@ function commitsPerDay() {
|
||||
function commitsByYear() {
|
||||
optionPicked "Git commits by year:"
|
||||
local year startYear endYear __since __until
|
||||
startYear=$(echo "$_since" | sed -E 's/^.* ([0-9]{4})( .*)?$/\1/')
|
||||
endYear=$(echo "$_until" | sed -E 's/^.* ([0-9]{4})( .*)?$/\1/')
|
||||
|
||||
# Extract the date strings from $_since and $_until
|
||||
since_date="${_since#--since=}"
|
||||
until_date="${_until#--until=}"
|
||||
|
||||
# Grab the four digit year from $_since and $_until
|
||||
startYear=$(parse_year "$since_date")
|
||||
endYear=$(parse_year "$until_date")
|
||||
|
||||
echo -e "\tyear\tsum"
|
||||
for year in $(seq "$startYear" "$endYear")
|
||||
# Add time strings to make these a touch more robust
|
||||
for year in $(seq "$startYear" "$endYear");
|
||||
do
|
||||
if [ "$year" = "$startYear" ]
|
||||
then
|
||||
if [[ "$year" = "$startYear" ]]; then
|
||||
__since=$_since
|
||||
__until="--until=$year-12-31"
|
||||
elif [ "$year" = "$endYear" ]
|
||||
then
|
||||
__since="--since=$year-01-01"
|
||||
__until="--until=$year-12-31 23:59:59"
|
||||
elif [[ "$year" = "$endYear" ]]; then
|
||||
__since="--since=$year-01-01 00:00:00"
|
||||
__until=$_until
|
||||
else
|
||||
__since="--since=$year-01-01"
|
||||
__until="--until=$year-12-31"
|
||||
__since="--since=$year-01-01 00:00:00"
|
||||
__until="--until=$year-12-31 23:59:59"
|
||||
fi
|
||||
|
||||
echo -en "\t$year\t"
|
||||
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||||
"$__since" "$__until" $_log_options | grep -cE \
|
||||
" \w\w\w [0-9]{1,2} [0-9][0-9]:[0-9][0-9]:[0-9][0-9] $year " \
|
||||
|| continue
|
||||
# Count commits directly using git rev-list instead of git log
|
||||
commit_count=$(
|
||||
git rev-list --count $_merges \
|
||||
"$__since" "$__until" HEAD $_log_options
|
||||
)
|
||||
echo -e "\t$year\t$commit_count"
|
||||
# TODO: The bar graph can get funky when there are only a handful of
|
||||
# commits. We can set a max length to try to fix this, but this is a
|
||||
# bit of a problem across all the bar graphs.
|
||||
done | awk '{
|
||||
count[$1] = $2
|
||||
total += $2
|
||||
@@ -753,8 +1004,7 @@ function commitsByYear() {
|
||||
for (year in count) {
|
||||
s="|";
|
||||
if (total > 0) {
|
||||
percent = ((count[year] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
percent = ((count[year] / total) * 100) / 1.25; for (i = 1; i <= percent; ++i) {
|
||||
s=s"█"
|
||||
}
|
||||
printf( "\t%s\t%-0s\t%s\n", year, count[year], s );
|
||||
@@ -786,8 +1036,7 @@ function commitsByMonth() {
|
||||
for (month in count) {
|
||||
s="|";
|
||||
if (total > 0) {
|
||||
percent = ((count[month] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
percent = ((count[month] / total) * 100) / 1.25; for (i = 1; i <= percent; ++i) {
|
||||
s=s"█"
|
||||
}
|
||||
printf( "\t%s\t%-0s\t%s\n", month, count[month], s );
|
||||
@@ -819,20 +1068,17 @@ function commitsByWeekday() {
|
||||
do
|
||||
echo -en "\t$counter\t$i\t"
|
||||
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||||
"${_author}" "$_since" "$_until" $_log_options |
|
||||
grep -cE "^ * $i \w\w\w [0-9]{1,2} " || continue
|
||||
"${_author}" "$_since" "$_until" $_log_options | grep -cE "^ * $i \w\w\w [0-9]{1,2} " || continue
|
||||
counter=$((counter+1))
|
||||
done | awk '{
|
||||
}
|
||||
NR == FNR {
|
||||
count[$1" "$2] = $3;
|
||||
total += $3;
|
||||
count[$1" "$2] = $3; total += $3;
|
||||
next
|
||||
}
|
||||
END{
|
||||
for (day in count) {
|
||||
s="|";
|
||||
if (total > 0) {
|
||||
s="|"; if (total > 0) {
|
||||
percent = ((count[day] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
s=s"█"
|
||||
@@ -867,8 +1113,7 @@ function commitsByHour() {
|
||||
do
|
||||
echo -ne "\t$i\t"
|
||||
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||||
"${_author}" "$_since" "$_until" $_log_options |
|
||||
grep -cE '[0-9] '$i':[0-9]' || continue
|
||||
"${_author}" "$_since" "$_until" $_log_options | grep -cE '[0-9] '$i':[0-9]' || continue
|
||||
done | awk '{
|
||||
count[$1] = $2
|
||||
total += $2
|
||||
@@ -877,8 +1122,7 @@ function commitsByHour() {
|
||||
for (hour in count) {
|
||||
s="|";
|
||||
if (total > 0) {
|
||||
percent = ((count[hour] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
percent = ((count[hour] / total) * 100) / 1.25; for (i = 1; i <= percent; ++i) {
|
||||
s=s"█"
|
||||
}
|
||||
printf( "\t%s\t%-0s\t%s\n", hour, count[hour], s );
|
||||
@@ -922,7 +1166,7 @@ function suggestReviewers() {
|
||||
optionPicked "Suggested code reviewers (based on git history):"
|
||||
git -c log.showSignature=false log --use-mailmap $_merges "$_since" "$_until" \
|
||||
--pretty=%aN $_log_options $_pathspec | head -n 100 | sort | uniq -c \
|
||||
| sort -nr | LC_ALL=C awk '
|
||||
| filter_ignored_authors | sort -nr | LC_ALL=C awk '
|
||||
{ args[NR] = $0; }
|
||||
END {
|
||||
for (i = 1; i <= NR; ++i) {
|
||||
@@ -938,9 +1182,14 @@ function suggestReviewers() {
|
||||
checkUtils
|
||||
|
||||
# Check if we are currently in a git repo.
|
||||
git rev-parse --is-inside-work-tree > /dev/null
|
||||
if ! git rev-parse --is-inside-work-tree > /dev/null; then
|
||||
echo "ERROR: You need to be inside a git repo to parse stats!"
|
||||
usage
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Parse non-interative commands
|
||||
|
||||
# Parse non-interactive commands
|
||||
if [[ "$#" -eq 1 ]]; then
|
||||
case "$1" in
|
||||
# GENERATE OPTIONS
|
||||
@@ -987,6 +1236,20 @@ if [[ "$#" -eq 1 ]]; then
|
||||
-b|--branch-tree) branchTree;;
|
||||
-D|--branches-by-date) branchesByDate;;
|
||||
-C|--contributors) contributors;;
|
||||
-n|--new-contributors)
|
||||
newDate=""
|
||||
while [[ -z "${newDate}" ]]; do
|
||||
read -r -p "Since what date? (e.g. '2023-04-13', '13 April 2023', 'last Thursday') " newDate
|
||||
# Test if the date provide is valid and try again if it isn't.
|
||||
# date(1) is pretty accepting of time stamps but you never know
|
||||
# what people may try. This script doesn't provide any additional
|
||||
# output for a bad date since `date`'s STDERR already contains
|
||||
# useful information.
|
||||
if ! date -d "${newDate}" +%s > /dev/null 2>&1; then
|
||||
newDate=""
|
||||
fi
|
||||
done
|
||||
newContributors "${newDate}";;
|
||||
-a|--commits-per-author) commitsPerAuthor;;
|
||||
-d|--commits-per-day) commitsPerDay;;
|
||||
-Y|--commits-by-year ) commitsByYear;;
|
||||
@@ -1012,15 +1275,24 @@ if [[ "$#" -eq 1 ]]; then
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsByTimezone "${author}";;
|
||||
# ACTIVITY OPTIONS
|
||||
-k|--commits-calendar-by-author)
|
||||
author="${_GIT_AUTHOR:-}"
|
||||
while [[ -z "${author}" ]]; do
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsCalendarByAuthor "${author}";;
|
||||
# SUGGEST OPTIONS
|
||||
-r|--suggest-reviewers) suggestReviewers;;
|
||||
-h|-\?|--help) usage;;
|
||||
*) echo "Invalid argument"; usage; exit 1;;
|
||||
*) echo "Invalid argument: $1"; usage; exit 1;;
|
||||
esac
|
||||
exit 0;
|
||||
fi
|
||||
[[ "$#" -gt 1 ]] && { echo "Invalid arguments"; usage; exit 1; }
|
||||
|
||||
# If no args, run interactive mode
|
||||
if [[ "$#" -eq 0 ]]; then
|
||||
# Parse interactive commands
|
||||
clear
|
||||
showMenu
|
||||
@@ -1066,30 +1338,44 @@ while [[ "${opt}" != "" ]]; do
|
||||
8) branchTree; showMenu;;
|
||||
9) branchesByDate; showMenu;;
|
||||
10) contributors; showMenu;;
|
||||
11) commitsPerAuthor; showMenu;;
|
||||
12) commitsPerDay; showMenu;;
|
||||
13) commitsByMonth; showMenu;;
|
||||
14) commitsByYear; showMenu;;
|
||||
15) commitsByWeekday; showMenu;;
|
||||
16) author=""
|
||||
11) newDate=""
|
||||
while [[ -z "${newDate}" ]]; do
|
||||
read -r -p "Since what date? (e.g. '2023-04-13', '13 April 2023', 'last Thursday') " newDate
|
||||
if ! date -d "${newDate}" +%s > /dev/null 2>&1; then
|
||||
newDate=""
|
||||
fi
|
||||
done
|
||||
newContributors "${newDate}"; showMenu;;
|
||||
12) commitsPerAuthor; showMenu;;
|
||||
13) commitsPerDay; showMenu;;
|
||||
14) commitsByMonth; showMenu;;
|
||||
15) commitsByYear; showMenu;;
|
||||
16) commitsByWeekday; showMenu;;
|
||||
17) author=""
|
||||
while [[ -z "${author}" ]]; do
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsByWeekday "${author}"; showMenu;;
|
||||
17) commitsByHour; showMenu;;
|
||||
18) author=""
|
||||
18) commitsByHour; showMenu;;
|
||||
19) author=""
|
||||
while [[ -z "${author}" ]]; do
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsByHour "${author}"; showMenu;;
|
||||
19) commitsByTimezone; showMenu;;
|
||||
20) author=""
|
||||
20) commitsByTimezone; showMenu;;
|
||||
21) author=""
|
||||
while [[ -z "${author}" ]]; do
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsByTimezone "${author}"; showMenu;;
|
||||
21) suggestReviewers; showMenu;;
|
||||
22) suggestReviewers; showMenu;;
|
||||
23) author=""
|
||||
while [[ -z "${author}" ]]; do
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsCalendarByAuthor "${author}"; showMenu;;
|
||||
q|"\n") exit;;
|
||||
*) clear; optionPicked "Pick an option from the menu"; showMenu;;
|
||||
esac
|
||||
done
|
||||
fi
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.TH git-quick-stats "1" "June 2021" "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.
|
||||
@@ -70,6 +70,11 @@ show branches by date
|
||||
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
|
||||
@@ -95,7 +100,7 @@ displays a list of commits per year
|
||||
displays a list of commits per weekday
|
||||
.HP
|
||||
.PP
|
||||
\fB\-W\fR, \fB\-\-commits\-by\author\-by\-weekday\fR
|
||||
\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
|
||||
.IP
|
||||
displays a list of commits per weekday by author
|
||||
.HP
|
||||
@@ -119,6 +124,11 @@ displays a list of commits per timezone
|
||||
.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
|
||||
@@ -155,12 +165,49 @@ 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
|
||||
.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
|
||||
@@ -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
|
||||
@@ -42,6 +50,8 @@ LIST OPTIONS
|
||||
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
|
||||
@@ -82,17 +92,22 @@ 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
|
||||
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"
|
||||
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)"
|
||||
assert_success "$src --suggest-reviewers"
|
||||
|
||||
assert_contains "$src --detailed-git-stats" "Contribution stats"
|
||||
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"
|
||||
|
||||
@@ -1,17 +1,16 @@
|
||||
#!/bin/sh
|
||||
# Initialises a new local Git repo for test purpose.
|
||||
if test -d ../test-git/.git; then rm -Rf ../test-git/.git; fi
|
||||
#mkdir test-git
|
||||
cd ../test-git
|
||||
# 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 '\n[user]\nname = test-git\nemail = test-git@example.org\n'> .git/config
|
||||
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')"
|
||||
#printf '# testChars [%s]\n' "$testChars">&2
|
||||
git notes add -m 'Some notes' -m 'out of ascii: été au cœur' -m "$testChars"
|
||||
git log
|
||||
} >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user