#!/usr/bin/env bash # # Simple and efficient way to access various statistics in a git repository ################################################################################ # GLOBALS AND SHELL OPTIONS set -o nounset set -o errexit # Beginning git log date. Respects all git datetime formats # If $_GIT_SINCE is never set, choose epoch time as that is # as far back as git will allow you to go _since=${_GIT_SINCE:-} if [[ -n "${_since}" ]]; then _since="--since=$_since" else _since="--since=2005-04-07" 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=$(date)" 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 # Default menu theme # Set the legacy theme by typing "export _MENU_THEME=legacy" _theme="${_MENU_THEME:=default}" ################################################################################ # DESC: Checks to make sure the user has the appropriate utilities installed # ARGS: None # OUTS: None ################################################################################ checkUtils() { readonly MSG="not found. Please make sure this is installed and in PATH." readonly UTILS="awk basename cat column echo git grep head seq sort tput \ tr uniq wc" for u in $UTILS do command -v "$u" >/dev/null 2>&1 || { echo >&2 "$u ${MSG}"; exit 1; } done } ################################################################################ # DESC: Help information printed to stdout during non-interactive mode # ARGS: None # OUTS: None ################################################################################ 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. OPTIONS -r, --suggest-reviewers show the best people to contact to review code -T, --detailed-git-stats give a detailed list of git stats -R, --git-stats-by-branch see detailed list of git stats by branch -d, --commits-per-day displays a list of commits per day -m, --commits-by-month displays a list of commits per month -w, --commits-by-weekday displays a list of commits per weekday -o, --commits-by-hour displays a list of commits per hour -A, --commits-by-author-by-hour displays a list of commits per hour by author -a, --commits-per-author displays a list of commits per author -S, --my-daily-stats see your current daily stats -C, --contributors see a list of everyone who contributed to the repo -b, --branch-tree show an ASCII graph of the git repo branch history -D, --branches-by-date show branches by date -c, --changelogs see changelogs -L, --changelogs-by-author see changelogs by author -j, --json-output save git log as a JSON formatted file to a specified area -h, -?, --help display this help text in the terminal ADDITIONAL USAGE You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log ex: export _GIT_SINCE=\"2017-01-20\" You can set _GIT_LIMIT for limited output log ex: export _GIT_LIMIT=20 You can set _GIT_LOG_OPTIONS for git log options ex: export _GIT_LOG_OPTIONS=\"--ignore-all-space --ignore-blank-lines\" You can exclude directories or files from the stats by using pathspec ex: export _GIT_PATHSPEC=':!pattern' You can set _GIT_MERGE_VIEW to view merge commits with normal commits ex: export _GIT_MERGE_VIEW=enable You can also set _GIT_MERGE_VIEW to only show merge commits ex: export _GIT_MERGE_VIEW=exclusive You can set _MENU_THEME to display the legacy color scheme ex: export _MENU_THEME=legacy" } ################################################################################ # DESC: Displays the interactive menu and saves the user supplied option # ARGS: None # OUTS: $opt: Option selected by the user based on menu choice ################################################################################ showMenu() { NORMAL=$(tput sgr0) CYAN=$(tput setaf 6) BOLD=$(tput bold) RED=$(tput setaf 1) YELLOW=$(tput setaf 3) WHITE=$(tput setaf 7) TITLES="" TEXT="" NUMS="" HELP_TXT="" EXIT_TXT="" # Adjustable color menu option if [[ "${_theme}" == "legacy" ]]; then TITLES="${BOLD}${RED}" TEXT="${NORMAL}${CYAN}" NUMS="${BOLD}${YELLOW}" HELP_TXT="${NORMAL}${YELLOW}" EXIT_TXT="${BOLD}${RED}" else TITLES="${BOLD}${CYAN}" TEXT="${NORMAL}${WHITE}" NUMS="${NORMAL}${BOLD}${WHITE}" HELP_TXT="${NORMAL}${CYAN}" EXIT_TXT="${BOLD}${CYAN}" fi printf %b "\\n${TITLES} Generate:${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} Save git log output in JSON format\\n" printf %b "\\n${TITLES} List:\\n" printf %b "${NUMS} 7)${TEXT} Branch tree view (last $_limit)\\n" printf %b "${NUMS} 8)${TEXT} All branches (sorted by most recent commit)\\n" printf %b "${NUMS} 9)${TEXT} All contributors (sorted by name)\\n" printf %b "${NUMS} 10)${TEXT} Git commits per author\\n" printf %b "${NUMS} 11)${TEXT} Git commits per date\\n" printf %b "${NUMS} 12)${TEXT} Git commits per month\\n" printf %b "${NUMS} 13)${TEXT} Git commits per weekday\\n" printf %b "${NUMS} 14)${TEXT} Git commits per hour\\n" printf %b "${NUMS} 15)${TEXT} Git commits by author per hour\\n" printf %b "\\n${TITLES} Suggest:\\n" printf %b "${NUMS} 16)${TEXT} Code reviewers (based on git history)\\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 } ################################################################################ # 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: 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.\nContribution stats (by author) on the current branch:" else optionPicked "Contribution stats (by author) on the current branch:" fi 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" } /^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) } } printStats("total") }' } ################################################################################ # 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 | sort -nr | LC_ALL=C awk ' { args[NR] = $0; } END { for (i = 1; i <= NR; ++i) { printf "%s\n", args[i] } }' | column -t -s, } ################################################################################ # 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" 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 "subject": "%s",%n "sanitized_subject_line": "%f",%n "body": "%b",%n "commit_notes": "%N",%n "author": {%n "name": "%aN",%n "email": "%aE",%n "date": "%aD"%n },%n "commiter": {%n "name": "%cN",%n "email": "%cE",%n "date": "%cD"%n }%n},' \ | sed "$ s/,$//" \ | sed ':a;N;$!ba;s/\r\n\([^{]\)/\\n\1/g' \ | awk 'BEGIN { print("[") } { print($0) } END { print("]") }' \ > "${json_path}/output.json" } ################################################################################ # 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 startYear=$(echo "$_since" | grep -Eo "[0-9]{4}") local endYear=$(echo "$_until" | grep -Eo "[0-9]{4}") 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 -E "($startYear|$endYear)" | grep " $i " | wc -l 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() { optionPicked "Git commits by weekday:" echo -e "\tday\tsum" local startYear=$(echo "$_since" | grep -Eo "[0-9]{4}") local endYear=$(echo "$_until" | grep -Eo "[0-9]{4}") local 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' \ "$_since" "$_until" $_log_options | grep -E "($startYear|$endYear)" | grep "$i " | wc -l 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 startYear=$(echo "$_since" | grep -Eo "[0-9]{4}") local endYear=$(echo "$_until" | grep -Eo "[0-9]{4}") 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 -E "($startYear|$endYear)" | grep ' '$i: | wc -l 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: 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: 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 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 commit | wc -l) "commits" } ################################################################################ # 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 | sort -u | cat -n } ################################################################################ # DESC: Shows an abbreviated ASCII graph based off of commit history # ARGS: None # OUTS: None ################################################################################ function branchTree() { optionPicked "Branching tree view:" 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: 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="${1:-}" local _author="" 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 echo -e "\n[$DATE]" GIT_PAGER=cat git -c log.showSignature=false log \ --use-mailmap $_merges \ --format=" * %s (%aN)" "${_author}" \ --since=$DATE --until=$next next=$DATE done } ################################################################################ # MAIN # Check to make sure all utilities required for this script are installed checkUtils # Check if we are currently in a git repo. git rev-parse --is-inside-work-tree > /dev/null # Parse non-interative commands if [[ "$#" -eq 1 ]]; then case "$1" in -r|--suggest-reviewers) suggestReviewers;; -T|--detailed-git-stats) detailedGitStats;; -R|--git-stats-by-branch) branch="" while [[ -z "${branch}" ]]; do read -r -p "Which branch? " branch done detailedGitStats "${branch}";; -b|--branch-tree) branchTree;; -d|--commits-per-day) commitsPerDay;; -a|--commits-per-author) commitsPerAuthor;; -S|--my-daily-stats) myDailyStats;; -C|--contributors) contributors;; -D|--branches-by-date) branchesByDate;; -c|--changelogs) changelogs;; -L|--changelogs-by-author) author="${_GIT_AUTHOR:-}" while [[ -z "${author}" ]]; do read -r -p "Which author? " author done changelogs "${author}";; -w|--commits-by-weekday) commitsByWeekday;; -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}";; -m|--commits-by-month) commitsByMonth;; -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}";; -h|-\?|--help) usage;; *) echo "Invalid argument"; usage; exit 1;; esac exit 0; fi [[ "$#" -gt 1 ]] && { echo "Invalid arguments"; usage; exit 1; } # 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) 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;; 7) branchTree; showMenu;; 8) branchesByDate; showMenu;; 9) contributors; showMenu;; 10) commitsPerAuthor; showMenu;; 11) commitsPerDay; showMenu;; 12) commitsByMonth; showMenu;; 13) commitsByWeekday; showMenu;; 14) commitsByHour; showMenu;; 15) author="" while [[ -z "${author}" ]]; do read -r -p "Which author? " author done commitsByHour "${author}"; showMenu;; 16) suggestReviewers; showMenu;; q|"\n") exit;; *) clear; optionPicked "Pick an option from the menu"; showMenu;; esac done