mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
d61c812247
* The current implementation of the calendar heatmap by author contains multidimensional arrays. This works with newer versions of awk, but can cause issues with systems that use an older variant which cannot easily handle these calculations. macOS is especially impacted by this. By flattening the arrays from a multidimensional array to a single dimensional array, we can maintain greater compatibility across awk variants without requiring the user to install additional versions of awk. Addresses issue #194
1500 lines
57 KiB
Bash
Executable File
1500 lines
57 KiB
Bash
Executable File
#!/usr/bin/env bash
|
||
#
|
||
# Simple and efficient way to access various statistics in a git repository
|
||
################################################################################
|
||
# GLOBALS AND SHELL OPTIONS
|
||
|
||
# NOTE: Should we look into allowing for a customized config file so that the
|
||
# user does not have to customize their shell's run command file or
|
||
# manually override these every time they want to change them?
|
||
set -o nounset
|
||
set -o errexit
|
||
|
||
# Global color variables using tput setaf
|
||
COLOR_NORMAL=$(tput sgr0)
|
||
COLOR_CYANL=$(tput setaf 6)
|
||
COLOR_BOLD=$(tput bold)
|
||
COLOR_RED=$(tput setaf 1)
|
||
COLOR_YELLOW=$(tput setaf 3)
|
||
COLOR_WHITE=$(tput setaf 7)
|
||
COLOR_BRIGHT_YELLOW=$(tput setaf 226)
|
||
COLOR_GOLD=$(tput setaf 220)
|
||
COLOR_ORANGE=$(tput setaf 214)
|
||
COLOR_DARK_ORANGE=$(tput setaf 208)
|
||
COLOR_RED_ORANGE=$(tput setaf 202)
|
||
COLOR_DARK_RED=$(tput setaf 160)
|
||
COLOR_DEEP_RED=$(tput setaf 88)
|
||
COLOR_DARKEST_RED=$(tput setaf 52)
|
||
COLOR_GRAY=$(tput setaf 240)
|
||
COLOR_RESET=$(tput sgr0)
|
||
|
||
# Beginning git log date. Respects all git datetime formats
|
||
# If $_GIT_SINCE is never set, look at the repository to find the first date.
|
||
# NOTE: previously this put the date at the fixed GIT epoch (May 2005)
|
||
_since=${_GIT_SINCE:-}
|
||
if [[ -n "${_since}" ]]; then
|
||
_since="--since=$_since"
|
||
else
|
||
_since="--since=$(git log --reverse --format='%ad' --date=iso | head -n1)"
|
||
fi
|
||
|
||
# End of git log date. Respects all git datetime formats
|
||
# If $_GIT_UNTIL is never set, choose the latest system
|
||
# time from the user's current environment
|
||
_until=${_GIT_UNTIL:-}
|
||
if [[ -n "${_until}" ]]; then
|
||
_until="--until=$_until"
|
||
else
|
||
_until="--until=$(LC_TIME=C date '+%a, %d %b %Y %H:%M:%S %Z')"
|
||
fi
|
||
|
||
# Set files or directories to be excluded in stats
|
||
# If $_GIT_PATHSPEC is not set, shift over the option completely
|
||
_pathspec=${_GIT_PATHSPEC:-}
|
||
if [[ -n "${_pathspec}" ]]; then
|
||
_pathspec="-- $_pathspec"
|
||
else
|
||
_pathspec="--"
|
||
fi
|
||
|
||
# Set merge commit view strategy. Default is to show no merge commits
|
||
# Exclusive shows only merge commits
|
||
# Enable shows regular commits together with normal commits
|
||
_merges=${_GIT_MERGE_VIEW:-}
|
||
_merges=$(echo "$_merges" | awk '{print tolower($0)}')
|
||
if [[ "${_merges}" == "exclusive" ]]; then
|
||
_merges="--merges"
|
||
elif [[ "${_merges}" == "enable" ]]; then
|
||
_merges=""
|
||
else
|
||
_merges="--no-merges"
|
||
fi
|
||
|
||
# Limit git log output
|
||
_limit=${_GIT_LIMIT:-}
|
||
if [[ -n "${_limit}" ]]; then
|
||
_limit=$_limit
|
||
else
|
||
_limit=10
|
||
fi
|
||
|
||
# Log options
|
||
_log_options=${_GIT_LOG_OPTIONS:-}
|
||
if [[ -n "${_log_options}" ]]; then
|
||
_log_options=$_log_options
|
||
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
|
||
|
||
# Number of days to display in the heatmap
|
||
_commit_days=${_GIT_DAYS:-30}
|
||
# If the user has not set a number of days, default to 30
|
||
if ! [[ "$_commit_days" =~ ^[0-9]+$ ]] || (( _commit_days <= 0 )); then
|
||
echo "Invalid number of days: $_commit_days. Defaulting to 30."
|
||
_commit_days=30
|
||
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 * 12 + 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 * 12 + 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";
|
||
}
|
||
'
|
||
}
|
||
|
||
# DESC: Shows a heatmap of commits per hour of each day for the last 30 days
|
||
function commitsHeatmap() {
|
||
optionPicked "Commit Heatmap for the last $_commit_days days"
|
||
|
||
color_for_count() {
|
||
local n=$1
|
||
if (( n == 1 )); then
|
||
echo -n "${COLOR_BRIGHT_YELLOW}"
|
||
elif (( n < 2 )); then
|
||
echo -n "${COLOR_GOLD}"
|
||
elif (( n < 3 )); then
|
||
echo -n "${COLOR_ORANGE}"
|
||
elif (( n < 4 )); then
|
||
echo -n "${COLOR_DARK_ORANGE}"
|
||
elif (( n < 5 )); then
|
||
echo -n "${COLOR_RED_ORANGE}"
|
||
elif (( n < 6 )); then
|
||
echo -n "${COLOR_RED}"
|
||
elif (( n < 8 )); then
|
||
echo -n "${COLOR_DARK_RED}"
|
||
elif (( n < 10 )); then
|
||
echo -n "${COLOR_DEEP_RED}"
|
||
else
|
||
echo -n "${COLOR_DARKEST_RED}"
|
||
fi
|
||
}
|
||
|
||
printf "Day | Date/Hours |"
|
||
local h
|
||
for h in {0..23}; do
|
||
printf " %2d" "$h"
|
||
done
|
||
echo
|
||
echo "------------------------------------------------------------------------------------------"
|
||
|
||
local i
|
||
for i in $(seq $((_commit_days-1)) -1 0); do
|
||
local day=$(date -d "-$i days" +"%Y-%m-%d")
|
||
if [[ $(date -d "$day" +%u) -gt 5 ]]; then
|
||
echo -en "${COLOR_GRAY}"
|
||
else
|
||
echo -en "${COLOR_RESET}"
|
||
fi
|
||
|
||
local dayName=$(date -d "$day" +%a)
|
||
printf "%s | %s |" "$dayName" "$day"
|
||
|
||
declare -a commits_per_hour
|
||
local h
|
||
for h in {0..23}; do
|
||
commits_per_hour[$h]=0
|
||
done
|
||
|
||
IFS=$'\n' commits_per_hour=($(
|
||
git log --since="$day 00:00" --until="$day 23:59" --pretty=format:"%ci" 2>/dev/null |
|
||
awk '{split($2, t, ":"); h = t[1]+0; c[h]++} END {for(i=0;i<24;i++) print c[i]+0}'
|
||
))
|
||
unset IFS
|
||
|
||
local h
|
||
for h in {0..23}; do
|
||
local count=${commits_per_hour[$h]}
|
||
local color=$(color_for_count "$count")
|
||
if (( count == 0 )); then
|
||
echo -en " ${COLOR_GRAY}.${COLOR_RESET} "
|
||
else
|
||
echo -en "${color} █ ${COLOR_RESET}"
|
||
fi
|
||
done
|
||
echo
|
||
done
|
||
echo "------------------------------------------------------------------------------------------"
|
||
|
||
echo -e "\nLegend:"
|
||
echo -e " ${COLOR_BRIGHT_YELLOW}█${COLOR_RESET} 1 commit"
|
||
echo -e " ${COLOR_GOLD}█${COLOR_RESET} 2 commits"
|
||
echo -e " ${COLOR_ORANGE}█${COLOR_RESET} 3 commits"
|
||
echo -e " ${COLOR_DARK_ORANGE}█${COLOR_RESET} 4 commits"
|
||
echo -e " ${COLOR_RED_ORANGE}█${COLOR_RESET} 5 commits"
|
||
echo -e " ${COLOR_RED}█${COLOR_RESET} 6 commits"
|
||
echo -e " ${COLOR_DARK_RED}█${COLOR_RESET} 7–8 commits"
|
||
echo -e " ${COLOR_DEEP_RED}█${COLOR_RESET} 9–10 commits"
|
||
echo -e " ${COLOR_DARKEST_RED}█${COLOR_RESET} 11+ commits"
|
||
echo -e " ${COLOR_GRAY}.${COLOR_RESET} = no commits"
|
||
echo
|
||
}
|
||
|
||
################################################################################
|
||
# HELPER AND MENU FUNCTIONS
|
||
|
||
################################################################################
|
||
# DESC: Checks to make sure the user has the appropriate utilities installed
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function checkUtils() {
|
||
readonly MSG="not found. Please make sure this is installed and in PATH."
|
||
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
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Prints a formatted message of the selected option by the user to stdout
|
||
# ARGS: $* (required): String to print (usually provided by other functions)
|
||
# OUTS: None
|
||
################################################################################
|
||
function optionPicked() {
|
||
local msg=${*:-"Error: No message passed"}
|
||
|
||
echo -e "${msg}\n"
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Help information printed to stdout during non-interactive mode
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function usage() {
|
||
readonly PROGRAM=$(basename "$0")
|
||
|
||
echo "
|
||
NAME
|
||
${PROGRAM} - Simple and efficient way to access various stats in a git repo
|
||
|
||
SYNOPSIS
|
||
For non-interactive mode: ${PROGRAM} [OPTIONS]
|
||
For interactive mode: ${PROGRAM}
|
||
|
||
DESCRIPTION
|
||
Any git repository contains tons of information about commits, contributors,
|
||
and files. Extracting this information is not always trivial, mostly because
|
||
of a gadzillion options to a gadzillion git commands.
|
||
|
||
This program allows you to see detailed information about a git repository.
|
||
|
||
GENERATE OPTIONS
|
||
-T, --detailed-git-stats
|
||
give a detailed list of git stats
|
||
-R, --git-stats-by-branch
|
||
see detailed list of git stats by branch
|
||
-c, --changelogs
|
||
see changelogs
|
||
-L, --changelogs-by-author
|
||
see changelogs by author
|
||
-S, --my-daily-stats
|
||
see your current daily stats
|
||
-V, --csv-output-by-branch
|
||
output daily stats by branch in CSV format
|
||
-j, --json-output
|
||
save git log as a JSON formatted file to a specified area
|
||
|
||
LIST OPTIONS
|
||
-b, --branch-tree
|
||
show an ASCII graph of the git repo branch history
|
||
-D, --branches-by-date
|
||
show branches by date
|
||
-C, --contributors
|
||
see a list of everyone who contributed to the repo
|
||
-n, --new-contributors
|
||
list everyone who made their first contribution since a specified date
|
||
-a, --commits-per-author
|
||
displays a list of commits per author
|
||
-d, --commits-per-day
|
||
displays a list of commits per day
|
||
-m, --commits-by-month
|
||
displays a list of commits per month
|
||
-Y, --commits-by-year
|
||
displays a list of commits per year
|
||
-w, --commits-by-weekday
|
||
displays a list of commits per weekday
|
||
-W, --commits-by-author-by-weekday
|
||
displays a list of commits per weekday by author
|
||
-o, --commits-by-hour
|
||
displays a list of commits per hour
|
||
-A, --commits-by-author-by-hour
|
||
displays a list of commits per hour by author
|
||
-z, --commits-by-timezone
|
||
displays a list of commits per timezone
|
||
-Z, --commits-by-author-by-timezone
|
||
displays a list of commits per timezone by author
|
||
|
||
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
|
||
|
||
ADDITIONAL USAGE
|
||
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log
|
||
ex: export _GIT_SINCE=\"2017-01-20\"
|
||
You can set _GIT_LIMIT for limited output log
|
||
ex: export _GIT_LIMIT=20
|
||
You can set _GIT_LOG_OPTIONS for git log options
|
||
ex: export _GIT_LOG_OPTIONS=\"--ignore-all-space --ignore-blank-lines\"
|
||
You can exclude directories or files from the stats by using pathspec
|
||
ex: export _GIT_PATHSPEC=':!pattern'
|
||
You can set _GIT_MERGE_VIEW to view merge commits with normal commits
|
||
ex: export _GIT_MERGE_VIEW=enable
|
||
You can also set _GIT_MERGE_VIEW to only show merge commits
|
||
ex: export _GIT_MERGE_VIEW=exclusive
|
||
You can change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
|
||
You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
|
||
ex: export _MENU_THEME=legacy
|
||
You can set _GIT_BRANCH to set the branch of the stats
|
||
ex: export _GIT_BRANCH=master
|
||
You can set _GIT_IGNORE_AUTHORS to filter out specific authors
|
||
ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
|
||
You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
|
||
ex: export _GIT_SORT_BY=\"name-asc\"
|
||
You can set _GIT_DAYS to set the number of days for the heatmap
|
||
ex: export _GIT_DAYS=30"
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays the interactive menu and saves the user supplied option
|
||
# ARGS: None
|
||
# OUTS: $opt: Option selected by the user based on menu choice
|
||
################################################################################
|
||
function showMenu() {
|
||
# These are "global" and can be overriden from users if so desired
|
||
TITLES=""
|
||
TEXT=""
|
||
NUMS=""
|
||
HELP_TXT=""
|
||
EXIT_TXT=""
|
||
|
||
# Adjustable color menu option
|
||
case "${_theme}" in
|
||
"legacy" )
|
||
TITLES="${COLOR_BOLD}${COLOR_RED}"
|
||
TEXT="${COLOR_NORMAL}${COLOR_CYANL}"
|
||
NUMS="${COLOR_BOLD}${COLOR_YELLOW}"
|
||
HELP_TXT="${COLOR_NORMAL}${COLOR_YELLOW}"
|
||
EXIT_TXT="${COLOR_BOLD}${COLOR_RED}"
|
||
;;
|
||
"none" )
|
||
TITLES="${COLOR_BOLD}"
|
||
TEXT="${COLOR_NORMAL}"
|
||
NUMS="${COLOR_BOLD}"
|
||
HELP_TXT="${COLOR_NORMAL}"
|
||
EXIT_TXT="${COLOR_BOLD}"
|
||
;;
|
||
*)
|
||
TITLES="${COLOR_BOLD}${COLOR_CYANL}"
|
||
TEXT="${COLOR_NORMAL}${COLOR_WHITE}"
|
||
NUMS="${COLOR_NORMAL}${COLOR_BOLD}${COLOR_WHITE}"
|
||
HELP_TXT="${COLOR_NORMAL}${COLOR_CYANL}"
|
||
EXIT_TXT="${COLOR_BOLD}${COLOR_CYANL}"
|
||
;;
|
||
esac
|
||
|
||
printf %b "\\n${TITLES} Generate:${COLOR_NORMAL}\\n"
|
||
printf %b "${NUMS} 1)${TEXT} Contribution stats (by author)\\n"
|
||
printf %b "${NUMS} 2)${TEXT} Contribution stats (by author) on a specific branch\\n"
|
||
printf %b "${NUMS} 3)${TEXT} Git changelogs (last $_limit days)\\n"
|
||
printf %b "${NUMS} 4)${TEXT} Git changelogs by author\\n"
|
||
printf %b "${NUMS} 5)${TEXT} My daily status\\n"
|
||
printf %b "${NUMS} 6)${TEXT} Output daily stats by branch in CSV format\\n"
|
||
printf %b "${NUMS} 7)${TEXT} Save git log output in JSON format\\n"
|
||
printf %b "\\n${TITLES} List:\\n"
|
||
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} 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} 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 "${NUMS} 24)${TEXT} Activity heatmap for the last $_commit_days days\\n"
|
||
printf %b "\\n${HELP_TXT}Please enter a menu option or ${EXIT_TXT}press Enter to exit.\\n"
|
||
printf %b "${TEXT}> ${COLOR_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.
|
||
# ARGS: $branch (optional): Users can specify an alternative branch instead of
|
||
# the current default one
|
||
# OUTS: None
|
||
################################################################################
|
||
function detailedGitStats() {
|
||
local is_branch_existing=false
|
||
local branch="${1:-}"
|
||
local _branch=""
|
||
|
||
# Check if requesting for a specific branch
|
||
if [[ -n "${branch}" ]]; then
|
||
# Check if branch exist
|
||
if [[ $(git show-ref refs/heads/"${branch}") ]] ; then
|
||
is_branch_existing=true
|
||
_branch="${branch}"
|
||
else
|
||
is_branch_existing=false
|
||
_branch=""
|
||
fi
|
||
fi
|
||
|
||
# Prompt message
|
||
if [[ "${is_branch_existing}" && -n "${_branch}" ]]; then
|
||
optionPicked "Contribution stats (by author) on ${_branch} branch:"
|
||
elif [[ -n "${branch}" && -z "${_branch}" ]]; then
|
||
optionPicked "Branch ${branch} does not exist."
|
||
optionPicked "Contribution stats (by author) on the current branch:"
|
||
else
|
||
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 '
|
||
# This first awk script extracts raw data into a delimited format
|
||
/^Author:/ {
|
||
$1 = ""; author = $0;
|
||
commits[author] += 1;
|
||
}
|
||
/^Date:/ {
|
||
$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;
|
||
}
|
||
END {
|
||
for (author in commits) {
|
||
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
|
||
}
|
||
{
|
||
# 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;
|
||
}'
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays the latest commit history in an easy to read format by date
|
||
# ARGS: $author (optional): Can focus on a single author. Default is all authors
|
||
# OUTS: None
|
||
################################################################################
|
||
function changelogs() {
|
||
local _author=""
|
||
local commits=""
|
||
local author="${1:-}"
|
||
local next=$(date +%F)
|
||
|
||
if [[ -z "${author}" ]]; then
|
||
optionPicked "Git changelogs:"
|
||
_author="--author=**"
|
||
else
|
||
optionPicked "Git changelogs for author '${author}':"
|
||
_author="--author=${author}"
|
||
fi
|
||
|
||
git -c log.showSignature=false log \
|
||
--use-mailmap \
|
||
$_merges \
|
||
--format="%cd" \
|
||
--date=short "${_author}" "$_since" "$_until" $_log_options $_pathspec \
|
||
| sort -u -r | head -n $_limit \
|
||
| while read DATE; do
|
||
commits=$(git -c log.showSignature=false log \
|
||
--use-mailmap $_merges \
|
||
--format=" * %s (%aN)" "${_author}" \
|
||
--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
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Shows git shortstats on the current user's changes for current day
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function myDailyStats() {
|
||
optionPicked "My daily status:"
|
||
git diff --shortstat '@{0 day ago}' | sort -nr | tr ',' '\n' | LC_ALL=C awk '
|
||
{ args[NR] = $0; }
|
||
END {
|
||
for (i = 1; i <= NR; ++i) {
|
||
printf "\t%s\n", args[i]
|
||
}
|
||
}'
|
||
|
||
echo -e "\t" $(git -c log.showSignature=false log --use-mailmap \
|
||
--author="$(git config user.name)" $_merges \
|
||
--since=$(date "+%Y-%m-%dT00:00:00") \
|
||
--until=$(date "+%Y-%m-%dT23:59:59") --reverse $_log_options \
|
||
| grep -cE "commit [a-f0-9]{40}") "commits"
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Shows detailed contribution stats per author by parsing every commit in
|
||
# the repo and outputting their contribution stats
|
||
# ARGS: $branch (optional): Users can specify an alternative branch instead of
|
||
# the current default one
|
||
# OUTS: None
|
||
################################################################################
|
||
function csvOutput() {
|
||
# TODO: Look into if we can refactor this to work as an option for the user
|
||
# so they can choose between JSON or CSV or possibly other formats
|
||
# like XML, YAML, and so on.
|
||
# TODO: Look into allowing the user to adjust the separator value
|
||
local is_branch_existing=false
|
||
local branch="${1:-}"
|
||
local _branch=""
|
||
|
||
# Check if requesting for a specific branch
|
||
if [[ -n "${branch}" ]]; then
|
||
# Check if branch exist
|
||
if [[ $(git show-ref refs/heads/"${branch}") ]] ;
|
||
then
|
||
is_branch_existing=true
|
||
_branch="${branch}"
|
||
else
|
||
is_branch_existing=false
|
||
_branch=""
|
||
fi
|
||
fi
|
||
|
||
printf "author,insertions,insertions_per,deletions,deletions_per,files,"
|
||
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 | 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) {
|
||
printf "%d,%.0f%%,", file[author], \
|
||
(file[author] / file["total"] * 100)
|
||
}
|
||
|
||
if(commits["total"] > 0) {
|
||
printf "%d,%.0f%%,", commits[author], \
|
||
(commits[author] / commits["total"] * 100)
|
||
}
|
||
|
||
if (first[author] != "") {
|
||
if ( ((more["total"] + less["total"]) * 100) > 0) {
|
||
printf "%d,", more[author] + less[author]
|
||
printf "%.0f%%\n", ((more[author] + less[author]) / \
|
||
(more["total"] + less["total"]) * 100)
|
||
}
|
||
}
|
||
}
|
||
|
||
/^Author:/ {
|
||
$1 = ""
|
||
author = $0
|
||
commits[author] += 1
|
||
commits["total"] += 1
|
||
}
|
||
|
||
/^Date:/ {
|
||
$1="";
|
||
first[author] = substr($0, 2)
|
||
if(last[author] == "" ) { last[author] = first[author] }
|
||
}
|
||
|
||
/^[0-9]/ {
|
||
more[author] += $1
|
||
less[author] += $2
|
||
|
||
file[author] += 1
|
||
more["total"] += $1
|
||
less["total"] += $2
|
||
file["total"] += 1
|
||
}
|
||
|
||
END {
|
||
for (author in commits) {
|
||
if (author != "total") {
|
||
printStats(author)
|
||
}
|
||
}
|
||
|
||
}'
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Transforms special multiline string sequence to a JSON string property.
|
||
# {propTag}{optional white space indentation}{property}
|
||
# {line1}
|
||
# {line2}
|
||
# ...
|
||
# {propTag}, (the final comma is optional)
|
||
# Generates: "{property}": "{line1}\n{line2}\n...",
|
||
# The final comma is added if present after the ending tag.
|
||
# Caveat: the content should not contain {propTag} at the
|
||
# beginning of a line.
|
||
# ARGS: $propTag (optional) : tag at the beginning of the line to mark the
|
||
# beginning and the end of a special sequence. It must not contain
|
||
# regular expression special characters, i.e. use [a-zA-Z0-9_]+.
|
||
# This tag should be sufficiently random to avoid collision with
|
||
# the actual content. Defaults to __JSONPROP__.
|
||
# OUTS: content with JSON string properties
|
||
################################################################################
|
||
function toJsonProp() {
|
||
local propTag="${1:-__JSONPROP__}"
|
||
sed -n -E '
|
||
# transforms the special sequence.
|
||
/^'"$propTag"'[^\r]/ {
|
||
# remove the special prefix, keep the property name followed by :
|
||
s/^'"$propTag"'([^\r]+)\r?$/\1:/g;
|
||
# hold in buffer, get the next line.
|
||
h;n
|
||
# loop
|
||
b eos
|
||
:eos {
|
||
# add in hold buffer and loop while the string is not finished.
|
||
/^'"$propTag"',?\r?$/ ! { H; n; b eos; }
|
||
# end of the string, flip buffer to current pattern.
|
||
# keeps the comma if any, or a space as an empty placeholder.
|
||
/,\r?$/ ! { x; s/\r?$/ / }
|
||
/,\r?$/ { x; s/\r?$/,/ }
|
||
}
|
||
# replace special JSON string chars.
|
||
s/["\\]/\\&/g;
|
||
# replace control chars, carriage returns, line feeds, tabulations, etc.
|
||
s/\x00/\\u0000/g; s/\x01/\\u0001/g; s/\x02/\\u0002/g; s/\x03/\\u0003/g;
|
||
s/\x04/\\u0004/g; s/\x05/\\u0005/g; s/\x06/\\u0006/g; s/\x07/\\u0007/g;
|
||
s/\x08/\\b/g; s/\x09/\\t/g; s/\x0a/\\n/g; s/\x0b/\\u000b/g;
|
||
s/\x0c/\\f/g; s/\x0d/\\r/g; s/\x0e/\\u000e/g; s/\x0f/\\u000f/g;
|
||
s/\x10/\\u0010/g; s/\x11/\\u0011/g; s/\x12/\\u0012/g; s/\x13/\\u0013/g;
|
||
s/\x14/\\u0014/g; s/\x15/\\u0015/g; s/\x16/\\u0016/g; s/\x17/\\u0017/g;
|
||
s/\x18/\\u0018/g; s/\x19/\\u0019/g; s/\x1a/\\u001a/g; s/\x1b/\\u001b/g;
|
||
s/\x1c/\\u001c/g; s/\x1d/\\u001d/g; s/\x1e/\\u001e/g; s/\x1f/\\u001f/g;
|
||
s/\x7f/\\u007f/g;
|
||
|
||
# format the JSON property name, optionally indented, open quote for value.
|
||
s/^(\s*)([^:]+):\\n/\1"\2": "/g;
|
||
# handle the final comma if present, and close the quote for value.
|
||
/,$/ { s/,$/",/g; }
|
||
# otherwise remove final space placeholder and close the quote for value.
|
||
/,$/ ! { s/ $/"/g; }
|
||
}
|
||
# print lines.
|
||
p'
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Saves the git log output in a JSON format
|
||
# ARGS: $json_path (required): Path to where the file is saved
|
||
# OUTS: A JSON formatted file
|
||
################################################################################
|
||
function jsonOutput() {
|
||
optionPicked "Output log saved to file at: ${json_path}/output.json"
|
||
local propTag="__JSONPROP${RANDOM}__"
|
||
git -c log.showSignature=false log --use-mailmap $_merges "$_since" "$_until" $_log_options \
|
||
--pretty=format:'{%n "commit": "%H",%n "abbreviated_commit": "%h",%n "tree": "%T",%n'\
|
||
' "abbreviated_tree": "%t",%n "parent": "%P",%n "abbreviated_parent": "%p",%n "refs": "%D",%n "encoding": "%e",%n'\
|
||
"$propTag"' subject%n%s%n'"$propTag"',%n "sanitized_subject_line": "%f",%n'\
|
||
"$propTag"' body%n%b%n'"$propTag"',%n'\
|
||
"$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 "committer": {%n'\
|
||
"$propTag"' name%n%cN%n'"$propTag"',%n'\
|
||
"$propTag"' email%n%cE%n'"$propTag"',%n'\
|
||
' "date": "%cD"%n }%n},' \
|
||
| toJsonProp "$propTag" \
|
||
| sed "$ s/,$//" \
|
||
| sed ':a;N;$!ba;s/\r\n\([^{]\)/\\n\1/g' \
|
||
| awk 'BEGIN { print("[") } { print($0) } END { print("]") }' \
|
||
> "${json_path}/output.json"
|
||
}
|
||
|
||
################################################################################
|
||
# FUNCTIONS FOR LISTING STATS
|
||
|
||
################################################################################
|
||
# DESC: Shows an abbreviated ASCII graph based off of commit history
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function branchTree() {
|
||
optionPicked "Branching tree view:"
|
||
# TODO: Can we shorten this pretty format line? Quick experiment shows that
|
||
# it does not properly respect \ and interprets them literally.
|
||
git -c log.showSignature=false log --use-mailmap --graph --abbrev-commit \
|
||
"$_since" "$_until" --decorate \
|
||
--format=format:'--+ Commit: %h %n | Date: %aD (%ar) %n'' | Message: %s %d %n'' + Author: %aN %n' \
|
||
--all $_log_options | head -n $((_limit*5))
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Lists all branches sorted by their most recent commit
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function branchesByDate() {
|
||
optionPicked "All branches (sorted by most recent commit):"
|
||
git for-each-ref --sort=committerdate refs/heads/ \
|
||
--format='[%(authordate:relative)] %(authorname) %(refname:short)' | cat -n
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Lists all contributors to a repo sorted by alphabetical order
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function contributors() {
|
||
optionPicked "All contributors (sorted by name):"
|
||
git -c log.showSignature=false log --use-mailmap $_merges "$_since" "$_until" \
|
||
--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
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays the number of commits and percentage contributed to the repo
|
||
# per author and sorts them by contribution percentage
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
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-)
|
||
local coAuthorCommits=$(git -c log.showSignature=false log --use-mailmap \
|
||
$_merges "$_since" "$_until" $_log_options \
|
||
| grep -i '^ Co-Authored-by:' | cut -c21-)
|
||
|
||
if [[ -z "${coAuthorCommits}" ]]; then
|
||
allCommits="${authorCommits}"
|
||
else
|
||
allCommits="${authorCommits}\n${coAuthorCommits}"
|
||
fi
|
||
|
||
echo -e "${allCommits}" | awk '
|
||
{ $NF=""; author[NR] = $0 }
|
||
END {
|
||
for(i in author) {
|
||
sum[author[i]]++; name[author[i]] = author[i]; total++;
|
||
}
|
||
for(i in sum) {
|
||
printf "\t%d:%s:%2.1f%%\n", sum[i], name[i], (100 * sum[i] / total)
|
||
}
|
||
}' | sort -n -r | column -t -s:
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Shows the number of commits that were committed per date recorded in the
|
||
# repo's log history
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function commitsPerDay() {
|
||
optionPicked "Git commits per date:";
|
||
git -c log.showSignature=false log --use-mailmap $_merges "$_since" "$_until" \
|
||
--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
|
||
# OUTS: None
|
||
################################################################################
|
||
function commitsByYear() {
|
||
optionPicked "Git commits by year:"
|
||
local year startYear endYear __since __until
|
||
|
||
# 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"
|
||
# Add time strings to make these a touch more robust
|
||
for year in $(seq "$startYear" "$endYear");
|
||
do
|
||
if [[ "$year" = "$startYear" ]]; then
|
||
__since=$_since
|
||
__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 00:00:00"
|
||
__until="--until=$year-12-31 23:59:59"
|
||
fi
|
||
|
||
# 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
|
||
}
|
||
END{
|
||
for (year in count) {
|
||
s="|";
|
||
if (total > 0) {
|
||
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 );
|
||
}
|
||
}
|
||
}' | sort
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays a horizontal bar graph based on total commits per month
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function commitsByMonth() {
|
||
optionPicked "Git commits by month:"
|
||
echo -e "\tmonth\tsum"
|
||
local i
|
||
for i in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
|
||
do
|
||
echo -en "\t$i\t"
|
||
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||
"$_since" "$_until" $_log_options |
|
||
grep -cE " \w\w\w $i [0-9]{1,2} " || continue
|
||
done | awk '{
|
||
count[$1] = $2
|
||
total += $2
|
||
}
|
||
END{
|
||
for (month in count) {
|
||
s="|";
|
||
if (total > 0) {
|
||
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 );
|
||
}
|
||
}
|
||
}' | LC_TIME="en_EN.UTF-8" sort -M
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays a horizontal bar graph based on total commits per weekday
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
function commitsByWeekday() {
|
||
local author="${1:-}"
|
||
local _author=""
|
||
|
||
if [[ -z "${author}" ]]; then
|
||
optionPicked "Git commits by weekday:"
|
||
_author="--author=**"
|
||
else
|
||
optionPicked "Git commits by weekday for author '${author}':"
|
||
_author="--author=${author}"
|
||
fi
|
||
|
||
echo -e "\tday\tsum"
|
||
local i counter=1
|
||
for i in Mon Tue Wed Thu Fri Sat Sun
|
||
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
|
||
counter=$((counter+1))
|
||
done | awk '{
|
||
}
|
||
NR == FNR {
|
||
count[$1" "$2] = $3; total += $3;
|
||
next
|
||
}
|
||
END{
|
||
for (day in count) {
|
||
s="|"; if (total > 0) {
|
||
percent = ((count[day] / total) * 100) / 1.25;
|
||
for (i = 1; i <= percent; ++i) {
|
||
s=s"█"
|
||
}
|
||
printf("\t%s\t%s\t%-0s\t%s\n", substr(day,0,1), substr(day,3,5), count[day], s);
|
||
}
|
||
}
|
||
}' | sort -k 1 -n | awk '{$1=""}1' | awk '{$1=$1}1' \
|
||
| awk '{printf("\t%s\t%s\t%s\n", $1, $2, $3)}'
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays a horizontal bar graph based on total commits per hour
|
||
# ARGS: $author (optional): Can focus on a single author. Default is all authors
|
||
# OUTS: None
|
||
################################################################################
|
||
function commitsByHour() {
|
||
local author="${1:-}"
|
||
local _author=""
|
||
|
||
if [[ -z "${author}" ]]; then
|
||
optionPicked "Git commits by hour:"
|
||
_author="--author=**"
|
||
else
|
||
optionPicked "Git commits by hour for author '${author}':"
|
||
_author="--author=${author}"
|
||
fi
|
||
echo -e "\thour\tsum"
|
||
|
||
local i
|
||
for i in $(seq -w 0 23)
|
||
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
|
||
done | awk '{
|
||
count[$1] = $2
|
||
total += $2
|
||
}
|
||
END{
|
||
for (hour in count) {
|
||
s="|";
|
||
if (total > 0) {
|
||
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 );
|
||
}
|
||
}
|
||
}' | sort
|
||
}
|
||
|
||
################################################################################
|
||
# DESC: Displays number of commits per timezone
|
||
# ARGS: $author (optional): Can focus on a single author. Default is all authors
|
||
# OUTS: None
|
||
################################################################################
|
||
function commitsByTimezone() {
|
||
local author="${1:-}"
|
||
local _author=""
|
||
|
||
if [[ -z "${author}" ]]; then
|
||
optionPicked "Git commits by timezone:"
|
||
_author="--author=**"
|
||
else
|
||
optionPicked "Git commits by timezone for author '${author}':"
|
||
_author="--author=${author}"
|
||
fi
|
||
|
||
echo -e "Commits\tTimeZone"
|
||
git -c log.showSignature=false log $_merges --format='%ad %s' \
|
||
"${_author}" "$_since" "$_until" --date=iso $_log_options $_pathspec \
|
||
| cut -d " " -f 3 | grep -v -e '^[[:space:]]*$' | sort -n | uniq -c
|
||
}
|
||
|
||
################################################################################
|
||
# FUNCTIONS FOR SUGGESTION STATS
|
||
|
||
################################################################################
|
||
# DESC: Displays the authors in order of total contribution to the repo
|
||
# ARGS: None
|
||
# OUTS: None
|
||
################################################################################
|
||
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 \
|
||
| filter_ignored_authors | sort -nr | LC_ALL=C awk '
|
||
{ args[NR] = $0; }
|
||
END {
|
||
for (i = 1; i <= NR; ++i) {
|
||
printf "%s\n", args[i]
|
||
}
|
||
}' | column -t -s,
|
||
}
|
||
|
||
################################################################################
|
||
# MAIN
|
||
|
||
# Check to make sure all utilities required for this script are installed
|
||
checkUtils
|
||
|
||
# Check if we are currently in a git repo.
|
||
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-interactive commands
|
||
if [[ "$#" -eq 1 ]]; then
|
||
case "$1" in
|
||
# GENERATE OPTIONS
|
||
-T|--detailed-git-stats) detailedGitStats;;
|
||
-R|--git-stats-by-branch)
|
||
branch="${_GIT_BRANCH:-}"
|
||
while [[ -z "${branch}" ]]; do
|
||
read -r -p "Which branch? " branch
|
||
done
|
||
detailedGitStats "${branch}";;
|
||
-c|--changelogs) changelogs;;
|
||
-L|--changelogs-by-author)
|
||
author="${_GIT_AUTHOR:-}"
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
changelogs "${author}";;
|
||
-S|--my-daily-stats) myDailyStats;;
|
||
-V|--csv-output-by-branch)
|
||
branch="${_GIT_BRANCH:-}"
|
||
while [[ -z "${branch}" ]]; do
|
||
read -r -p "Which branch? " branch
|
||
done
|
||
csvOutput "${branch}";;
|
||
-j|--json-output)
|
||
json_path=""
|
||
while [[ -z "${json_path}" ]]; do
|
||
echo "NOTE: This feature is in beta!"
|
||
echo "The file name will be saved as \"output.json\"."
|
||
echo "The full path must be provided."
|
||
echo "Variables or shorthands such as ~ are not valid."
|
||
echo "You do not need the final slash at the end of a directory path."
|
||
echo "You must have write permission to the folder you are trying to save this to."
|
||
echo "This feature only works interactively and cannot be combined with other options."
|
||
echo -e "Example of a valid path: /home/$(whoami)\n"
|
||
read -r -p "Please provide the full path to directory to save JSON file: " json_path
|
||
if [[ ! -w "${json_path}" ]]; then
|
||
echo "Invalid path or permission denied to write to given area."
|
||
json_path=""
|
||
fi
|
||
done
|
||
jsonOutput "${json_path}";;
|
||
# LIST OPTIONS
|
||
-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;;
|
||
-m|--commits-by-month) commitsByMonth;;
|
||
-w|--commits-by-weekday) commitsByWeekday;;
|
||
-W|--commits-by-author-by-weekday)
|
||
author="${_GIT_AUTHOR:-}"
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsByWeekday "${author}";;
|
||
-o|--commits-by-hour) commitsByHour;;
|
||
-A|--commits-by-author-by-hour)
|
||
author="${_GIT_AUTHOR:-}"
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsByHour "${author}";;
|
||
-z|--commits-by-timezone) commitsByTimezone;;
|
||
-Z|--commits-by-author-by-timezone)
|
||
author="${_GIT_AUTHOR:-}"
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsByTimezone "${author}";;
|
||
# CALENDAR OPTIONS
|
||
-k|--commits-calendar-by-author)
|
||
author="${_GIT_AUTHOR:-}"
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsCalendarByAuthor "${author}";;
|
||
-H|--commits-heatmap) commitsHeatmap;;
|
||
# SUGGEST OPTIONS
|
||
-r|--suggest-reviewers) suggestReviewers;;
|
||
-h|-\?|--help) usage;;
|
||
*) 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
|
||
|
||
while [[ "${opt}" != "" ]]; do
|
||
clear
|
||
case "${opt}" in
|
||
1) detailedGitStats; showMenu;;
|
||
2) branch=""
|
||
while [[ -z "${branch}" ]]; do
|
||
read -r -p "Which branch? " branch
|
||
done
|
||
detailedGitStats "${branch}"; showMenu;;
|
||
3) changelogs; showMenu;;
|
||
4) author=""
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
changelogs "${author}"; showMenu;;
|
||
5) myDailyStats; showMenu;;
|
||
6) branch=""
|
||
while [[ -z "${branch}" ]]; do
|
||
read -r -p "Which branch? " branch
|
||
done
|
||
csvOutput "${branch}"; showMenu;;
|
||
7) json_path=""
|
||
while [[ -z "${json_path}" ]]; do
|
||
echo "NOTE: This feature is in beta!"
|
||
echo "The file name will be saved as \"output.json\"."
|
||
echo "The full path must be provided."
|
||
echo "Variables, subshell commands, or shorthands such as ~ may not be valid."
|
||
echo "You do not need the final slash at the end of a directory path."
|
||
echo "You must have write permission to the folder you are trying to save this to."
|
||
echo "This feature only works interactively and cannot be combined with other options."
|
||
echo -e "Example of a valid path: /home/$(whoami)\n"
|
||
read -r -p "Please provide the full path to directory to save JSON file: " json_path
|
||
if [[ ! -w "${json_path}" ]]; then
|
||
echo "Invalid path or permission denied to write to given area."
|
||
json_path=""
|
||
fi
|
||
done
|
||
jsonOutput "${json_path}"; showMenu;;
|
||
8) branchTree; showMenu;;
|
||
9) branchesByDate; showMenu;;
|
||
10) contributors; showMenu;;
|
||
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;;
|
||
18) commitsByHour; showMenu;;
|
||
19) author=""
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsByHour "${author}"; showMenu;;
|
||
20) commitsByTimezone; showMenu;;
|
||
21) author=""
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsByTimezone "${author}"; showMenu;;
|
||
22) suggestReviewers; showMenu;;
|
||
23) author=""
|
||
while [[ -z "${author}" ]]; do
|
||
read -r -p "Which author? " author
|
||
done
|
||
commitsCalendarByAuthor "${author}"; showMenu;;
|
||
24) commitsHeatmap; showMenu;;
|
||
q|"\n") exit;;
|
||
*) clear; optionPicked "Pick an option from the menu"; showMenu;;
|
||
esac
|
||
done
|
||
fi
|