mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
Compare commits
22 Commits
task/issue
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
125eec7136 | ||
|
d61c812247 | ||
|
|
261262ab4e | ||
|
|
e968ef62b9 | ||
|
74261c1e50 | ||
|
|
4eade09673 | ||
|
|
47a9151886 | ||
|
|
916d5e1e0f | ||
|
|
17a9d1427b | ||
|
|
091562d4f8 | ||
|
|
748576b541 | ||
|
|
f43ab22172 | ||
|
|
4d2e52aa6d | ||
|
|
08c0ca1d85 | ||
|
|
e8843da10e | ||
|
|
376887a394 | ||
|
|
cebb5a8f48 | ||
|
|
95136d3f92 | ||
|
|
79c735c814 | ||
|
|
ec6a95d2ef | ||
|
|
b65b100cd8 | ||
|
|
dd7719c3b0 |
25
CITATION.cff
Normal file
25
CITATION.cff
Normal file
@@ -0,0 +1,25 @@
|
||||
cff-version: 1.2.0
|
||||
title: Git Quick Stats
|
||||
message: >-
|
||||
If you use this software, please cite it using the
|
||||
metadata from this file.
|
||||
type: software
|
||||
authors:
|
||||
- name-particle: tomice
|
||||
- name-particle: arzzen
|
||||
identifiers:
|
||||
- type: url
|
||||
value: "https://github.com/git-quick-stats"
|
||||
description: >-
|
||||
Simple and efficient way to access various statistics
|
||||
in a git repository
|
||||
repository-code: "https://github.com/git-quick-stats/git-quick-stats"
|
||||
url: "https://git-quick-stats.sh/"
|
||||
abstract: >-
|
||||
Git-quick-stats is a simple and efficient way to access
|
||||
various statistics in a git repository.
|
||||
keywords:
|
||||
- git
|
||||
- stats
|
||||
license: MIT
|
||||
version: 2.6.2
|
||||
@@ -4,7 +4,7 @@ FROM alpine
|
||||
COPY . /app
|
||||
|
||||
# Install required packages & build git-quick-stats
|
||||
RUN apk add --no-cache bash git make ncurses util-linux \
|
||||
RUN apk add --no-cache bash git make ncurses coreutils util-linux \
|
||||
&& cd /app \
|
||||
&& make install \
|
||||
&& rm -rf /app \
|
||||
|
||||
817
README.md
817
README.md
@@ -1,406 +1,411 @@
|
||||
# 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)
|
||||
|
||||
[](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 :).
|
||||
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
[**Screenshots**](#screenshots)
|
||||
|
||||
[**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)
|
||||
|
||||
[**Installation**](#installation)
|
||||
|
||||
- [**UNIX and Linux**](#unix-and-linux)
|
||||
- [**macOS**](#macos-homebrew)
|
||||
- [**Windows**](#windows)
|
||||
- [**Docker**](#docker)
|
||||
|
||||
[**System requirements**](#system-requirements)
|
||||
|
||||
- [**Dependencies**](#dependencies)
|
||||
|
||||
[**FAQ**](#faq)
|
||||
|
||||
[**Contribution**](#contribution)
|
||||
|
||||
- [**Code reviews**](#code-reviews)
|
||||
- [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
|
||||
- [**Formatting**](#formatting)
|
||||
|
||||
[**Tests**](#tests)
|
||||
|
||||
[**Licensing**](#licensing)
|
||||
|
||||
[**Contributors**](#contributors)
|
||||
|
||||
- [**Backers**](#backers)
|
||||
- [**Sponsors**](#sponsors)
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
### Interactive
|
||||
|
||||
`git-quick-stats` has a built-in interactive menu that can be executed as such:
|
||||
|
||||
```bash
|
||||
git-quick-stats
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```bash
|
||||
git quick-stats
|
||||
```
|
||||
|
||||
### Non-interactive
|
||||
|
||||
For those who prefer to utilize command-line options, `git-quick-stats` also has a non-interactive mode supporting both short and long options:
|
||||
|
||||
```bash
|
||||
git-quick-stats <optional-command-to-execute-directly>
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```bash
|
||||
git quick-stats <optional-command-to-execute-directly>
|
||||
```
|
||||
|
||||
### Command-line arguments
|
||||
|
||||
Possible arguments in short and long form:
|
||||
|
||||
```bash
|
||||
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
|
||||
-Y, --commits-by-year
|
||||
displays a list of commits per year
|
||||
-m, --commits-by-month
|
||||
displays a list of commits per month
|
||||
-w, --commits-by-weekday
|
||||
displays a list of commits per weekday
|
||||
-W, --commits-by-author-by-weekday
|
||||
displays a list of commits per weekday by author
|
||||
-o, --commits-by-hour
|
||||
displays a list of commits per hour
|
||||
-A, --commits-by-author-by-hour
|
||||
displays a list of commits per hour by author
|
||||
-z, --commits-by-timezone
|
||||
displays a list of commits per timezone
|
||||
-Z, --commits-by-author-by-timezone
|
||||
displays a list of commits per timezone by author
|
||||
|
||||
SUGGEST OPTIONS
|
||||
-r, --suggest-reviewers
|
||||
show the best people to contact to review code
|
||||
-h, -?, --help
|
||||
display this help text in the terminal
|
||||
```
|
||||
|
||||
### Git log since and until
|
||||
|
||||
You can set the variables `_GIT_SINCE` and/or `_GIT_UNTIL` before running `git-quick-stats` to limit the git log. These work similar to git's built-in `--since` and `--until` log options.
|
||||
|
||||
```bash
|
||||
export _GIT_SINCE="2017-01-20"
|
||||
export _GIT_UNTIL="2017-01-22"
|
||||
```
|
||||
|
||||
Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
|
||||
|
||||
### Git log limit
|
||||
|
||||
You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
|
||||
|
||||
```bash
|
||||
export _GIT_LIMIT=20
|
||||
```
|
||||
|
||||
### Git log options
|
||||
|
||||
You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
|
||||
|
||||
```bash
|
||||
export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||||
```
|
||||
|
||||
### Git pathspec
|
||||
|
||||
You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
|
||||
|
||||
```bash
|
||||
export _GIT_PATHSPEC=':!directory'
|
||||
```
|
||||
|
||||
You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
|
||||
|
||||
```bash
|
||||
export _GIT_PATHSPEC=':!package-lock.json'
|
||||
```
|
||||
|
||||
### Git merge view strategy
|
||||
|
||||
You can set the variable `_GIT_MERGE_VIEW` to enable merge commits to be part of the stats by setting `_GIT_MERGE_VIEW` to `enable`. You can also choose to only show merge commits by setting `_GIT_MERGE_VIEW` to `exclusive`. Default is to not show merge commits. These work similar to git's built-in `--merges` and `--no-merges` log options.
|
||||
|
||||
```bash
|
||||
export _GIT_MERGE_VIEW="enable"
|
||||
export _GIT_MERGE_VIEW="exclusive"
|
||||
```
|
||||
|
||||
### Git branch
|
||||
|
||||
You can set the variable `_GIT_BRANCH` to set the branch of the stats. Works with commands `--git-stats-by-branch` and `--csv-output-by-branch`.
|
||||
|
||||
```bash
|
||||
export _GIT_BRANCH="master"
|
||||
```
|
||||
|
||||
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)"
|
||||
```
|
||||
|
||||
### Color themes
|
||||
|
||||
You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`.
|
||||
You can completely disable the color theme by setting the `_MENU_THEME` variable to `none`.
|
||||
|
||||
```bash
|
||||
export _MENU_THEME="legacy"
|
||||
# or
|
||||
export _MENU_THEME="none"
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Debian and Ubuntu
|
||||
|
||||
If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
|
||||
|
||||
```bash
|
||||
apt install git-quick-stats
|
||||
```
|
||||
|
||||
### UNIX and Linux
|
||||
|
||||
```bash
|
||||
git clone https://github.com/git-quick-stats/git-quick-stats.git && cd git-quick-stats
|
||||
sudo make install
|
||||
```
|
||||
|
||||
For uninstalling, open up the cloned directory and run
|
||||
|
||||
```bash
|
||||
sudo make uninstall
|
||||
```
|
||||
|
||||
For update/reinstall
|
||||
|
||||
```bash
|
||||
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)
|
||||
|
||||
If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
|
||||
|
||||
### Docker
|
||||
|
||||
You can use the Docker image provided:
|
||||
|
||||
- Build: `docker build -t arzzen/git-quick-stats .`
|
||||
- Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
|
||||
- Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
|
||||
|
||||
## System requirements
|
||||
|
||||
- An OS with a Bash shell
|
||||
- Tools we use:
|
||||
|
||||
```bash
|
||||
awk
|
||||
basename
|
||||
cat
|
||||
column
|
||||
date
|
||||
echo
|
||||
git
|
||||
grep
|
||||
head
|
||||
printf
|
||||
seq
|
||||
sort
|
||||
tput
|
||||
tr
|
||||
uniq
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
- [`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`
|
||||
|
||||
_A:_ You can run the dos2unix app in cygwin as follows: `/bin/dos2unix.exe /usr/local/bin/git-quick-stats`. This will convert the script from the CR-LF convention that Microsoft uses to the LF convention that UNIX, OS X, and Linux use. You should then should be able to run it as normal.
|
||||
|
||||
_Q:_ How they could be used in a project with many git projects and statistics would show a summary of all git projects?
|
||||
|
||||
_A:_ If you want to include submodule logs, you can try using the following: `export _GIT_LOG_OPTIONS="-p --submodule=log"`
|
||||
(more info about [git log --submodule](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
|
||||
|
||||
## Contribution
|
||||
|
||||
Want to contribute? Great! First, read this page.
|
||||
|
||||
### Code reviews
|
||||
|
||||
All submissions, including submissions by project members, require review.</br>
|
||||
We use GitHub pull requests for this purpose.
|
||||
|
||||
### Some tips for good pull requests
|
||||
|
||||
- Use our code </br>
|
||||
When in doubt, try to stay true to the existing code of the project.
|
||||
- Write a descriptive commit message. What problem are you solving and what
|
||||
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 /
|
||||
fixes to your first commit, consider squashing them into a single commit
|
||||
(`git rebase -i`) such that your PR is a single commit on top of the current
|
||||
HEAD. This make reviewing the code so much easier, and our history more
|
||||
readable.
|
||||
|
||||
### Formatting
|
||||
|
||||
This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
|
||||
|
||||
## Tests
|
||||
|
||||
[](https://codecov.io/gh/arzzen/git-quick-stats)
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
|
||||
## Licensing
|
||||
|
||||
MIT see [LICENSE][] for the full license text.
|
||||
|
||||
[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/git-quick-stats/git-quick-stats/graphs/contributors)
|
||||
|
||||
### Backers
|
||||
|
||||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
|
||||
|
||||
[](https://opencollective.com/git-quick-stats#backers)
|
||||
|
||||
### Sponsors
|
||||
|
||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-quick-stats#sponsor)]
|
||||
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/0/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/1/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/2/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/3/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/4/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/5/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/6/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/7/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/8/website)
|
||||
[](https://opencollective.com/git-quick-stats/sponsor/9/website)
|
||||
# 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)
|
||||
|
||||
[](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 :).
|
||||
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
[**Screenshots**](#screenshots)
|
||||
|
||||
[**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)
|
||||
|
||||
[**Installation**](#installation)
|
||||
|
||||
- [**UNIX and Linux**](#unix-and-linux)
|
||||
- [**macOS**](#macos-homebrew)
|
||||
- [**Windows**](#windows)
|
||||
- [**Docker**](#docker)
|
||||
|
||||
[**System requirements**](#system-requirements)
|
||||
|
||||
- [**Dependencies**](#dependencies)
|
||||
|
||||
[**FAQ**](#faq)
|
||||
|
||||
[**Contribution**](#contribution)
|
||||
|
||||
- [**Code reviews**](#code-reviews)
|
||||
- [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
|
||||
- [**Formatting**](#formatting)
|
||||
|
||||
[**Tests**](#tests)
|
||||
|
||||
[**Licensing**](#licensing)
|
||||
|
||||
[**Contributors**](#contributors)
|
||||
|
||||
- [**Backers**](#backers)
|
||||
- [**Sponsors**](#sponsors)
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
### Interactive
|
||||
|
||||
`git-quick-stats` has a built-in interactive menu that can be executed as such:
|
||||
|
||||
```bash
|
||||
git-quick-stats
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```bash
|
||||
git quick-stats
|
||||
```
|
||||
|
||||
### Non-interactive
|
||||
|
||||
For those who prefer to utilize command-line options, `git-quick-stats` also has a non-interactive mode supporting both short and long options:
|
||||
|
||||
```bash
|
||||
git-quick-stats <optional-command-to-execute-directly>
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```bash
|
||||
git quick-stats <optional-command-to-execute-directly>
|
||||
```
|
||||
|
||||
### Command-line arguments
|
||||
|
||||
Possible arguments in short and long form:
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
### Git log since and until
|
||||
|
||||
You can set the variables `_GIT_SINCE` and/or `_GIT_UNTIL` before running `git-quick-stats` to limit the git log. These work similar to git's built-in `--since` and `--until` log options.
|
||||
|
||||
```bash
|
||||
export _GIT_SINCE="2017-01-20"
|
||||
export _GIT_UNTIL="2017-01-22"
|
||||
```
|
||||
|
||||
Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
|
||||
|
||||
### Git log limit
|
||||
|
||||
You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
|
||||
|
||||
```bash
|
||||
export _GIT_LIMIT=20
|
||||
```
|
||||
|
||||
### Git log options
|
||||
|
||||
You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
|
||||
|
||||
```bash
|
||||
export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||||
```
|
||||
|
||||
### Git pathspec
|
||||
|
||||
You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
|
||||
|
||||
```bash
|
||||
export _GIT_PATHSPEC=':!directory'
|
||||
```
|
||||
|
||||
You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
|
||||
|
||||
```bash
|
||||
export _GIT_PATHSPEC=':!package-lock.json'
|
||||
```
|
||||
|
||||
### Git merge view strategy
|
||||
|
||||
You can set the variable `_GIT_MERGE_VIEW` to enable merge commits to be part of the stats by setting `_GIT_MERGE_VIEW` to `enable`. You can also choose to only show merge commits by setting `_GIT_MERGE_VIEW` to `exclusive`. Default is to not show merge commits. These work similar to git's built-in `--merges` and `--no-merges` log options.
|
||||
|
||||
```bash
|
||||
export _GIT_MERGE_VIEW="enable"
|
||||
export _GIT_MERGE_VIEW="exclusive"
|
||||
```
|
||||
|
||||
### Git branch
|
||||
|
||||
You can set the variable `_GIT_BRANCH` to set the branch of the stats. Works with commands `--git-stats-by-branch` and `--csv-output-by-branch`.
|
||||
|
||||
```bash
|
||||
export _GIT_BRANCH="master"
|
||||
```
|
||||
|
||||
### Ignore authors
|
||||
|
||||
You can set the variable `_GIT_IGNORE_AUTHORS` to filter out specific authors. It will affect the "All contributors", ""Suggested code reviewers" and "New contributors" options.
|
||||
|
||||
```bash
|
||||
export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
|
||||
```
|
||||
|
||||
### Sorting contribution stats
|
||||
|
||||
You can sort contribution stats by field `name`, `commits`, `insertions`, `deletions`, or `lines` (total lines changed) and order (`asc`, `desc`). e.g.: `commits-desc`
|
||||
|
||||
```bash
|
||||
export _GIT_SORT_BY="name-asc"
|
||||
```
|
||||
|
||||
### Commit days
|
||||
|
||||
You can set \_GIT_DAYS to set the number of days for the heatmap
|
||||
|
||||
```bash
|
||||
export _GIT_DAYS=30
|
||||
```
|
||||
|
||||
### Color themes
|
||||
|
||||
You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`.
|
||||
You can completely disable the color theme by setting the `_MENU_THEME` variable to `none`.
|
||||
|
||||
```bash
|
||||
export _MENU_THEME="legacy"
|
||||
# or
|
||||
export _MENU_THEME="none"
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Debian and Ubuntu
|
||||
|
||||
If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
|
||||
|
||||
```bash
|
||||
apt install git-quick-stats
|
||||
```
|
||||
|
||||
### UNIX and Linux
|
||||
|
||||
```bash
|
||||
git clone https://github.com/git-quick-stats/git-quick-stats.git && cd git-quick-stats
|
||||
sudo make install
|
||||
```
|
||||
|
||||
For uninstalling, open up the cloned directory and run
|
||||
|
||||
```bash
|
||||
sudo make uninstall
|
||||
```
|
||||
|
||||
For update/reinstall
|
||||
|
||||
```bash
|
||||
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)
|
||||
|
||||
If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
|
||||
|
||||
### Docker
|
||||
|
||||
You can use the Docker image provided:
|
||||
|
||||
- Build: `docker build -t arzzen/git-quick-stats .`
|
||||
- Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
|
||||
- Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
|
||||
|
||||
## System requirements
|
||||
|
||||
- An OS with a Bash shell
|
||||
- Tools we use:
|
||||
|
||||
```bash
|
||||
awk
|
||||
basename
|
||||
cat
|
||||
column
|
||||
date
|
||||
echo
|
||||
git
|
||||
grep
|
||||
head
|
||||
printf
|
||||
seq
|
||||
sort
|
||||
tput
|
||||
tr
|
||||
uniq
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
- [`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`
|
||||
|
||||
_A:_ You can run the dos2unix app in cygwin as follows: `/bin/dos2unix.exe /usr/local/bin/git-quick-stats`. This will convert the script from the CR-LF convention that Microsoft uses to the LF convention that UNIX, OS X, and Linux use. You should then should be able to run it as normal.
|
||||
|
||||
_Q:_ How they could be used in a project with many git projects and statistics would show a summary of all git projects?
|
||||
|
||||
_A:_ If you want to include submodule logs, you can try using the following: `export _GIT_LOG_OPTIONS="-p --submodule=log"`
|
||||
(more info about [git log --submodule](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
|
||||
|
||||
## Contribution
|
||||
|
||||
Want to contribute? Great! First, read this page.
|
||||
|
||||
### Code reviews
|
||||
|
||||
All submissions, including submissions by project members, require review.</br>
|
||||
We use GitHub pull requests for this purpose.
|
||||
|
||||
### Some tips for good pull requests
|
||||
|
||||
- Use our code </br>
|
||||
When in doubt, try to stay true to the existing code of the project.
|
||||
- Write a descriptive commit message. What problem are you solving and what
|
||||
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 /
|
||||
fixes to your first commit, consider squashing them into a single commit
|
||||
(`git rebase -i`) such that your PR is a single commit on top of the current
|
||||
HEAD. This make reviewing the code so much easier, and our history more
|
||||
readable.
|
||||
|
||||
### Formatting
|
||||
|
||||
This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
|
||||
|
||||
## Tests
|
||||
|
||||
[](https://codecov.io/gh/arzzen/git-quick-stats)
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
|
||||
## Licensing
|
||||
|
||||
MIT see [LICENSE][] for the full license text.
|
||||
|
||||
[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/git-quick-stats/git-quick-stats/graphs/contributors)
|
||||
|
||||
640
git-quick-stats
640
git-quick-stats
@@ -10,6 +10,24 @@
|
||||
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)
|
||||
@@ -76,6 +94,22 @@ 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}"
|
||||
@@ -96,40 +130,130 @@ function commitsCalendarByAuthor() {
|
||||
--date=iso --author="$author" "$_since" "$_until" $_log_options \
|
||||
--pretty='%ad' $_pathspec | awk '
|
||||
{
|
||||
split($0, a, " ");
|
||||
split($0, a, " ");
|
||||
# a[1] = YYYY-MM-DD
|
||||
split(a[1], date_fields, "-");
|
||||
split(a[1], date_fields, "-");
|
||||
mon = date_fields[2] + 0;
|
||||
cmd = "date -d \"" a[1] "\" +%u";
|
||||
cmd | getline weekday;
|
||||
close(cmd);
|
||||
close(cmd);
|
||||
# weekday: 1=Mon, ..., 7=Sun
|
||||
count[weekday][mon]++;
|
||||
count[weekday * 12 + mon]++;
|
||||
}
|
||||
END {
|
||||
# Output matrix
|
||||
for (d=1; d<=7; d++) {
|
||||
if (d==1) printf "Mon ";
|
||||
if (d==1) printf "Mon ";
|
||||
else if (d==2) printf "Tue ";
|
||||
else if (d==3) printf "Wed ";
|
||||
else if (d==3) printf "Wed ";
|
||||
else if (d==4) printf "Thu ";
|
||||
else if (d==5) printf "Fri ";
|
||||
else if (d==5) printf "Fri ";
|
||||
else if (d==6) printf "Sat ";
|
||||
else if (d==7) printf "Sun ";
|
||||
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");
|
||||
}
|
||||
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";
|
||||
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
|
||||
|
||||
@@ -196,7 +320,7 @@ 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
|
||||
@@ -245,6 +369,12 @@ LIST OPTIONS
|
||||
-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
|
||||
@@ -270,7 +400,11 @@ ADDITIONAL USAGE
|
||||
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)\""
|
||||
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"
|
||||
}
|
||||
|
||||
################################################################################
|
||||
@@ -280,12 +414,6 @@ ADDITIONAL USAGE
|
||||
################################################################################
|
||||
function showMenu() {
|
||||
# These are "global" and can be overriden from users if so desired
|
||||
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=""
|
||||
@@ -295,29 +423,29 @@ function showMenu() {
|
||||
# Adjustable color menu option
|
||||
case "${_theme}" in
|
||||
"legacy" )
|
||||
TITLES="${BOLD}${RED}"
|
||||
TEXT="${NORMAL}${CYAN}"
|
||||
NUMS="${BOLD}${YELLOW}"
|
||||
HELP_TXT="${NORMAL}${YELLOW}"
|
||||
EXIT_TXT="${BOLD}${RED}"
|
||||
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="${BOLD}"
|
||||
TEXT="${NORMAL}"
|
||||
NUMS="${BOLD}"
|
||||
HELP_TXT="${NORMAL}"
|
||||
EXIT_TXT="${BOLD}"
|
||||
TITLES="${COLOR_BOLD}"
|
||||
TEXT="${COLOR_NORMAL}"
|
||||
NUMS="${COLOR_BOLD}"
|
||||
HELP_TXT="${COLOR_NORMAL}"
|
||||
EXIT_TXT="${COLOR_BOLD}"
|
||||
;;
|
||||
*)
|
||||
TITLES="${BOLD}${CYAN}"
|
||||
TEXT="${NORMAL}${WHITE}"
|
||||
NUMS="${NORMAL}${BOLD}${WHITE}"
|
||||
HELP_TXT="${NORMAL}${CYAN}"
|
||||
EXIT_TXT="${BOLD}${CYAN}"
|
||||
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:${NORMAL}\\n"
|
||||
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"
|
||||
@@ -344,8 +472,9 @@ function showMenu() {
|
||||
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}> ${NORMAL}"
|
||||
printf %b "${TEXT}> ${COLOR_NORMAL}"
|
||||
read -r opt
|
||||
}
|
||||
|
||||
@@ -362,7 +491,7 @@ filter_ignored_authors() {
|
||||
|
||||
################################################################################
|
||||
# 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
|
||||
@@ -394,82 +523,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)
|
||||
} else {
|
||||
printf "\t insertions: %d\t(%.0f%%)\n", 0, 0
|
||||
}
|
||||
|
||||
if(less["total"] > 0) {
|
||||
printf "\t deletions: %d\t(%.0f%%)\n", less[author], \
|
||||
(less[author] / less["total"] * 100)
|
||||
} else {
|
||||
printf "\t deletions: %d\t(%.0f%%)\n", 0, 0
|
||||
}
|
||||
|
||||
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)
|
||||
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
|
||||
}
|
||||
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;
|
||||
}'
|
||||
}
|
||||
|
||||
@@ -554,9 +752,10 @@ function csvOutput() {
|
||||
local _branch=""
|
||||
|
||||
# Check if requesting for a specific branch
|
||||
if [[ -n "${branch}" ]]; then
|
||||
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
|
||||
@@ -671,7 +870,7 @@ function toJsonProp() {
|
||||
# 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.
|
||||
# keeps the comma if any, or a space as an empty placeholder.
|
||||
/,\r?$/ ! { x; s/\r?$/ / }
|
||||
/,\r?$/ { x; s/\r?$/,/ }
|
||||
}
|
||||
@@ -891,7 +1090,8 @@ function commitsByYear() {
|
||||
|
||||
echo -e "\tyear\tsum"
|
||||
# Add time strings to make these a touch more robust
|
||||
for year in $(seq "$startYear" "$endYear"); do
|
||||
for year in $(seq "$startYear" "$endYear");
|
||||
do
|
||||
if [[ "$year" = "$startYear" ]]; then
|
||||
__since=$_since
|
||||
__until="--until=$year-12-31 23:59:59"
|
||||
@@ -918,13 +1118,12 @@ function commitsByYear() {
|
||||
}
|
||||
END{
|
||||
for (year in count) {
|
||||
s="|";
|
||||
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 );
|
||||
printf( "\t%s\t%-0s\t%s\n", year, count[year], s );
|
||||
}
|
||||
}
|
||||
}' | sort
|
||||
@@ -951,13 +1150,12 @@ function commitsByMonth() {
|
||||
}
|
||||
END{
|
||||
for (month in count) {
|
||||
s="|";
|
||||
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 );
|
||||
printf( "\t%s\t%-0s\t%s\n", month, count[month], s );
|
||||
}
|
||||
}
|
||||
}' | LC_TIME="en_EN.UTF-8" sort -M
|
||||
@@ -986,25 +1184,22 @@ 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) {
|
||||
percent = ((count[day] / total) * 100) / 1.25;
|
||||
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);
|
||||
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' \
|
||||
@@ -1034,21 +1229,19 @@ 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
|
||||
}
|
||||
END{
|
||||
for (hour in count) {
|
||||
s="|";
|
||||
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 );
|
||||
printf( "\t%s\t%-0s\t%s\n", hour, count[hour], s );
|
||||
}
|
||||
}
|
||||
}' | sort
|
||||
@@ -1111,7 +1304,8 @@ if ! git rev-parse --is-inside-work-tree > /dev/null; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Parse non-interative commands
|
||||
|
||||
# Parse non-interactive commands
|
||||
if [[ "$#" -eq 1 ]]; then
|
||||
case "$1" in
|
||||
# GENERATE OPTIONS
|
||||
@@ -1197,105 +1391,109 @@ if [[ "$#" -eq 1 ]]; then
|
||||
read -r -p "Which author? " author
|
||||
done
|
||||
commitsByTimezone "${author}";;
|
||||
# ACTIVITY OPTIONS
|
||||
# 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"; usage; exit 1;;
|
||||
*) echo "Invalid argument: $1"; usage; exit 1;;
|
||||
esac
|
||||
exit 0;
|
||||
fi
|
||||
[[ "$#" -gt 1 ]] && { echo "Invalid arguments"; usage; exit 1; }
|
||||
|
||||
# Parse interactive commands
|
||||
clear
|
||||
showMenu
|
||||
|
||||
while [[ "${opt}" != "" ]]; do
|
||||
# If no args, run interactive mode
|
||||
if [[ "$#" -eq 0 ]]; then
|
||||
# Parse interactive commands
|
||||
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
|
||||
# Test if the date provide is valid and try again if it isn't.
|
||||
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;;
|
||||
q|"\n") exit;;
|
||||
*) clear; optionPicked "Pick an option from the menu"; showMenu;;
|
||||
esac
|
||||
done
|
||||
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
|
||||
|
||||
@@ -1,209 +1,206 @@
|
||||
.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.
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
For non\-interactive mode:
|
||||
.B git\-quick\-stats [OPTIONS]
|
||||
.PP
|
||||
For interactive mode:
|
||||
.B git-quick-stats
|
||||
.PP
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
.SH GENERATE OPTIONS
|
||||
.PP
|
||||
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
||||
.IP
|
||||
give a detailed list of git stats
|
||||
.HP
|
||||
.PP
|
||||
\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
|
||||
.IP
|
||||
see detailed list of git stats by branch
|
||||
.HP
|
||||
.PP
|
||||
\fB\-c\fR, \fB\-\-changelogs\fR
|
||||
.IP
|
||||
see changelogs
|
||||
.HP
|
||||
.PP
|
||||
\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
|
||||
.IP
|
||||
see changelogs by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
|
||||
.IP
|
||||
see your current daily stats
|
||||
.HP
|
||||
.PP
|
||||
\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
|
||||
.IP
|
||||
output daily stats by branch in CSV format
|
||||
.HP
|
||||
.PP
|
||||
\fB\-j\fR, \fB\-\-json\-output\fR
|
||||
.IP
|
||||
save git log as a JSON formatted file to a specified area
|
||||
.HP
|
||||
.SH LIST OPTIONS
|
||||
.PP
|
||||
\fB\-b\fR, \fB\-\-branch\-tree\fR
|
||||
.IP
|
||||
show an ASCII graph of the git repo branch history
|
||||
.HP
|
||||
.PP
|
||||
\fB\-D\fR, \fB\-\-branches\-by\-date\fR
|
||||
.IP
|
||||
show branches by date
|
||||
.HP
|
||||
.PP
|
||||
\fB\-C\fR, \fB\-\-contributors\fR
|
||||
.IP
|
||||
see a list of everyone who contributed to the repo
|
||||
.HP
|
||||
.PP
|
||||
\fB\-n\fR, \fB\-\-new\-contributors\fR
|
||||
.IP
|
||||
list everyone who made their first contribution since a specified date
|
||||
.HP
|
||||
.PP
|
||||
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
||||
.IP
|
||||
displays a list of commits per author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-d\fR, \fB\-\-commits\-per\-day\fR
|
||||
.IP
|
||||
displays a list of commits per day
|
||||
.HP
|
||||
.PP
|
||||
\fB\-m\fR, \fB\-\-commits\-by\-month\fR
|
||||
.IP
|
||||
displays a list of commits per month
|
||||
.HP
|
||||
.PP
|
||||
\fB\-Y\fR, \fB\-\-commits\-by\-year\fR
|
||||
.IP
|
||||
displays a list of commits per year
|
||||
.HP
|
||||
.PP
|
||||
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
||||
.IP
|
||||
displays a list of commits per weekday
|
||||
.HP
|
||||
.PP
|
||||
\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
|
||||
.IP
|
||||
displays a list of commits per weekday by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
|
||||
.IP
|
||||
displays a list of commits per hour
|
||||
.HP
|
||||
.PP
|
||||
\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
|
||||
.IP
|
||||
displays a list of commits per hour by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-z\fR, \fB\-\-commits\-by\-timezone\fR
|
||||
.IP
|
||||
displays a list of commits per timezone
|
||||
.HP
|
||||
.PP
|
||||
\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
|
||||
.IP
|
||||
displays a list of commits per timezone by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-\-activity\-calendar\fR
|
||||
.IP
|
||||
displays a calendar-style grid of commit activity per day-of-week and month for a selected author.
|
||||
.HP
|
||||
.SH SUGGEST OPTIONS
|
||||
.PP
|
||||
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
||||
.IP
|
||||
show the best people to contact to review code
|
||||
.HP
|
||||
.PP
|
||||
\fB\-h\fR, \-?, \fB\-\-help\fR
|
||||
.IP
|
||||
display this help text in the terminal
|
||||
.PP
|
||||
.SH ADDITIONAL USAGE
|
||||
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
|
||||
.PP
|
||||
.B export _GIT_SINCE="2017\-01\-20"
|
||||
.PP
|
||||
You can set _GIT_LIMIT for limited output log, example:
|
||||
.PP
|
||||
.B export _GIT_LIMIT=20
|
||||
.PP
|
||||
You can set _GIT_LOG_OPTIONS for git log options, example:
|
||||
.PP
|
||||
.B export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||||
.PP
|
||||
You can exclude directories or files from the stats by using pathspec, example:
|
||||
.PP
|
||||
.B export _GIT_PATHSPEC=':!pattern'
|
||||
.PP
|
||||
You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
|
||||
.PP
|
||||
.B export _GIT_MERGE_VIEW="enable"
|
||||
.PP
|
||||
You can also set _GIT_MERGE_VIEW to only show merge commits, example:
|
||||
.PP
|
||||
.B export _GIT_MERGE_VIEW="exclusive"
|
||||
.PP
|
||||
You can 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
|
||||
.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.
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
For non\-interactive mode:
|
||||
.B git\-quick\-stats [OPTIONS]
|
||||
.PP
|
||||
For interactive mode:
|
||||
.B git-quick-stats
|
||||
.PP
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
.SH GENERATE OPTIONS
|
||||
.PP
|
||||
\fB\-h\fR, \-?, \fB\-\-help\fR
|
||||
.IP
|
||||
display this help text in the terminal
|
||||
.PP
|
||||
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
||||
.IP
|
||||
give a detailed list of git stats
|
||||
.HP
|
||||
.PP
|
||||
\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
|
||||
.IP
|
||||
see detailed list of git stats by branch
|
||||
.HP
|
||||
.PP
|
||||
\fB\-c\fR, \fB\-\-changelogs\fR
|
||||
.IP
|
||||
see changelogs
|
||||
.HP
|
||||
.PP
|
||||
\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
|
||||
.IP
|
||||
see changelogs by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
|
||||
.IP
|
||||
see your current daily stats
|
||||
.HP
|
||||
.PP
|
||||
\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
|
||||
.IP
|
||||
output daily stats by branch in CSV format
|
||||
.HP
|
||||
.PP
|
||||
\fB\-j\fR, \fB\-\-json\-output\fR
|
||||
.IP
|
||||
save git log as a JSON formatted file to a specified area
|
||||
.HP
|
||||
.SH LIST OPTIONS
|
||||
.PP
|
||||
\fB\-b\fR, \fB\-\-branch\-tree\fR
|
||||
.IP
|
||||
show an ASCII graph of the git repo branch history
|
||||
.HP
|
||||
.PP
|
||||
\fB\-D\fR, \fB\-\-branches\-by\-date\fR
|
||||
.IP
|
||||
show branches by date
|
||||
.HP
|
||||
.PP
|
||||
\fB\-C\fR, \fB\-\-contributors\fR
|
||||
.IP
|
||||
see a list of everyone who contributed to the repo
|
||||
.HP
|
||||
.PP
|
||||
\fB\-n\fR, \fB\-\-new\-contributors\fR
|
||||
.IP
|
||||
list everyone who made their first contribution since a specified date
|
||||
.HP
|
||||
.PP
|
||||
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
||||
.IP
|
||||
displays a list of commits per author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-d\fR, \fB\-\-commits\-per\-day\fR
|
||||
.IP
|
||||
displays a list of commits per day
|
||||
.HP
|
||||
.PP
|
||||
\fB\-m\fR, \fB\-\-commits\-by\-month\fR
|
||||
.IP
|
||||
displays a list of commits per month
|
||||
.HP
|
||||
.PP
|
||||
\fB\-Y\fR, \fB\-\-commits\-by\-year\fR
|
||||
.IP
|
||||
displays a list of commits per year
|
||||
.HP
|
||||
.PP
|
||||
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
||||
.IP
|
||||
displays a list of commits per weekday
|
||||
.HP
|
||||
.PP
|
||||
\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
|
||||
.IP
|
||||
displays a list of commits per weekday by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
|
||||
.IP
|
||||
displays a list of commits per hour
|
||||
.HP
|
||||
.PP
|
||||
\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
|
||||
.IP
|
||||
displays a list of commits per hour by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-z\fR, \fB\-\-commits\-by\-timezone\fR
|
||||
.IP
|
||||
displays a list of commits per timezone
|
||||
.HP
|
||||
.PP
|
||||
\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
|
||||
.IP
|
||||
displays a list of commits per timezone by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-\-activity\-calendar\fR
|
||||
.IP
|
||||
displays a calendar-style grid of commit activity per day-of-week and month for a selected author.
|
||||
.HP
|
||||
.SH SUGGEST OPTIONS
|
||||
.PP
|
||||
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
||||
.IP
|
||||
show the best people to contact to review code
|
||||
.HP
|
||||
.PP
|
||||
.SH CALENDAR OPTIONS
|
||||
.PP
|
||||
\fB\-k\fR, \fB\-\-commits\-calendar\-by\-author\fR outputs a visual grid of commit activity for a selected author, grouped by day-of-week (rows: Mon..Sun) and month (columns: Jan..Dec). Each cell is 3 characters wide, separated by one space.
|
||||
.PP
|
||||
.PP
|
||||
\fB\-H\fR, \fB\-\-commits\-heatmap\fR shows a heatmap of commits per day per hour for the last 30 days
|
||||
.PP
|
||||
.SH ADDITIONAL USAGE
|
||||
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
|
||||
.PP
|
||||
.B export _GIT_SINCE="2017\-01\-20"
|
||||
.PP
|
||||
You can set _GIT_LIMIT for limited output log, example:
|
||||
.PP
|
||||
.B export _GIT_LIMIT=20
|
||||
.PP
|
||||
You can set _GIT_LOG_OPTIONS for git log options, example:
|
||||
.PP
|
||||
.B export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||||
.PP
|
||||
You can exclude directories or files from the stats by using pathspec, example:
|
||||
.PP
|
||||
.B export _GIT_PATHSPEC=':!pattern'
|
||||
.PP
|
||||
You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
|
||||
.PP
|
||||
.B export _GIT_MERGE_VIEW="enable"
|
||||
.PP
|
||||
You can also set _GIT_MERGE_VIEW to only show merge commits, example:
|
||||
.PP
|
||||
.B export _GIT_MERGE_VIEW="exclusive"
|
||||
.PP
|
||||
You can sort contribution stats by field "name", "commits", "insertions", "deletions", or "lines" (total lines changed) and order ("asc", "desc"). e.g.: "commits-desc"
|
||||
.PP
|
||||
.B export _GIT_SORT_BY="name-asc"
|
||||
.PP
|
||||
You can change to the legacy color scheme by toggling the variable "_MENU_THEME" between "default" and "legacy". You can completely disable the color theme by setting the "_MENU_THEME" variable to "none", example:
|
||||
.PP
|
||||
.B export _MENU_THEME=legacy
|
||||
.PP
|
||||
or
|
||||
.B export _MENU_THEME=none
|
||||
.PP
|
||||
You can set _GIT_BRANCH to set the branch of the stats, example:
|
||||
.PP
|
||||
.B export _GIT_BRANCH="master"
|
||||
.PP
|
||||
You can set _GIT_IGNORE_AUTHORS to filter out specific authors, example:
|
||||
.PP
|
||||
.B export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
|
||||
.PP
|
||||
You can set _GIT_DAYS to set the number of days for the heatmap, example:
|
||||
.PP
|
||||
.B export _GIT_DAYS=30"
|
||||
.
|
||||
.fi
|
||||
|
||||
.PP
|
||||
.SH SEE ALSO
|
||||
.BR git (1)
|
||||
.PP
|
||||
Project homepage:
|
||||
.UR https://github.com/git-quick-stats/git-quick-stats
|
||||
.UE
|
||||
@@ -11,7 +11,7 @@
|
||||
. 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
|
||||
@@ -24,7 +24,7 @@ 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
|
||||
@@ -73,6 +73,12 @@ LIST OPTIONS
|
||||
-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
|
||||
@@ -98,14 +104,18 @@ ADDITIONAL USAGE
|
||||
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)\""
|
||||
ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
|
||||
You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
|
||||
ex: export _GIT_SORT_BY=\"name-asc\"
|
||||
You can set _GIT_DAYS to set the number of days for the heatmap
|
||||
ex: export _GIT_DAYS=30"
|
||||
|
||||
assert_raises "$src fail" 1
|
||||
|
||||
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
|
||||
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"
|
||||
|
||||
Reference in New Issue
Block a user