mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
Compare commits
102 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
17fc8f326c | ||
|
d5c17e43c0 | ||
|
|
75c8bdc0de | ||
|
|
1a9be34f4c | ||
|
4979eaa69f | ||
|
|
1ed838f532 | ||
|
0fd9171e11 | ||
|
|
b14f364b6a | ||
|
|
10ad00bcbb | ||
|
|
539f49bb68 | ||
|
10bc3106f6 | ||
|
|
7160e3c39d | ||
|
|
f17cbd0ff7 | ||
|
a3cd429850 | ||
|
|
e069deaf8a | ||
|
|
b1285b828e | ||
|
c11bce17bd | ||
|
|
5f0bc1c7cf | ||
|
|
5f71b785ac | ||
|
|
cdb3f20790 | ||
|
|
dd69477293 | ||
|
4aef465e6b | ||
|
|
81fce5cadf | ||
|
|
f3931eb1a3 | ||
|
|
bdfe3beb25 | ||
|
|
90d118f09f | ||
|
|
d12c1c6c4f | ||
|
|
1282e4b46f | ||
|
|
96de74cf4f | ||
|
096fd86324 | ||
|
|
dd6a23568e | ||
|
48c062f8fa | ||
|
|
c3194f77e3 | ||
|
|
52f4eff27c | ||
|
|
c7d456465e | ||
|
|
e9f085f20e | ||
|
|
625ec404bc | ||
|
|
e6ffee5850 | ||
|
|
2422a010c6 | ||
|
749367701d | ||
|
|
3d86fa9664 | ||
|
a6a65faa8d | ||
|
|
0cc67fd4ac | ||
|
3344a05237 | ||
|
|
da78123ca8 | ||
|
|
ad50a915b0 | ||
|
88f970632f | ||
|
|
7f3220abb7 | ||
|
|
7a9e9c7f85 | ||
|
|
190ae631e5 | ||
|
|
94ea505dbd | ||
|
|
601986fbe1 | ||
|
|
01f60821ea | ||
|
|
6579c31047 | ||
|
|
e82339b777 | ||
|
|
f3f0ab4730 | ||
|
|
258b52eda8 | ||
|
|
187c03ae98 | ||
|
|
5e00e35a30 | ||
|
|
c107529335 | ||
|
|
255f1a6976 | ||
|
|
2cc5cae1a8 | ||
|
|
4f95691967 | ||
|
|
36405591ec | ||
|
|
4e3f4ba826 | ||
|
|
83e96f8b80 | ||
|
|
206ebd8a76 | ||
|
|
2274ca1284 | ||
|
|
37f15f6381 | ||
|
|
337ead38e3 | ||
|
|
c38e4eb7b6 | ||
|
b767822eb3 | ||
|
|
08520bf068 | ||
|
374527dbe1 | ||
|
|
dba2d87206 | ||
|
|
8bfc58710a | ||
|
6f931ac9b5 | ||
|
|
42a657b0de | ||
|
|
a48347e0df | ||
|
f4930f152d | ||
|
e5727cf4e9 | ||
|
|
6b54e9d8df | ||
|
7f70c8b728 | ||
|
|
dc86f8b6ae | ||
|
36967bc6f4 | ||
|
|
cdfa6bf467 | ||
|
a496390884 | ||
|
|
e81d3ab9f4 | ||
|
|
b0e62d64c7 | ||
|
|
01b6e17007 | ||
|
|
ac730dbfbc | ||
|
37b37bb5c8 | ||
|
|
db8009ff6d | ||
|
|
5a275c87b8 | ||
|
|
98c0252e97 | ||
|
|
5a389f5071 | ||
|
|
382f6759cf | ||
|
|
6362149953 | ||
|
|
36cae305a4 | ||
|
|
90f6b631a9 | ||
|
|
6a894d9efe | ||
|
ef6120fa64 |
4
.github/FUNDING.yml
vendored
Normal file
4
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: [arzzen]
|
||||
open_collective: git-quick-stats
|
||||
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
*.json
|
||||
*.db
|
||||
.DS_Store*
|
||||
._*
|
||||
.*.swp
|
||||
.*.swo
|
||||
.Spotlight*
|
||||
.Trash*
|
||||
**/*~
|
||||
3
.mailmap
Normal file
3
.mailmap
Normal file
@@ -0,0 +1,3 @@
|
||||
Lukas Mestan <lukas.mestan@gmail.com> Lukáš Mešťan <arzzen@users.noreply.github.com>
|
||||
Lukas Mestan <lukas.mestan@gmail.com> arzzen
|
||||
|
||||
32
.travis.yml
32
.travis.yml
@@ -1,2 +1,32 @@
|
||||
language: bash
|
||||
language: generic
|
||||
|
||||
sudo: required
|
||||
|
||||
addons:
|
||||
apt:
|
||||
packages:
|
||||
- libcurl4-openssl-dev
|
||||
- libelf-dev
|
||||
- libdw-dev
|
||||
- cmake
|
||||
|
||||
install:
|
||||
- git rev-parse HEAD
|
||||
|
||||
script: make test
|
||||
|
||||
after_success: |
|
||||
wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz &&
|
||||
tar xzf master.tar.gz &&
|
||||
cd kcov-master &&
|
||||
mkdir build &&
|
||||
cd build &&
|
||||
cmake .. &&
|
||||
make &&
|
||||
sudo make install &&
|
||||
cd ../.. &&
|
||||
rm -rf kcov-master &&
|
||||
mkdir -p coverage &&
|
||||
kcov coverage git-quick-stats suggestReviewers && bash <(curl -s https://codecov.io/bash) -cF suggestReviewers &&
|
||||
kcov coverage git-quick-stats detailedGitStats && bash <(curl -s https://codecov.io/bash) -cF detailedGitStats &&
|
||||
kcov coverage git-quick-stats commitsPerDay && bash <(curl -s https://codecov.io/bash) -cF commitsPerDay
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Lukáš Mešťan
|
||||
Copyright (c) 2019 Lukáš Mešťan
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
37
Makefile
37
Makefile
@@ -1,38 +1,43 @@
|
||||
PREFIX=/usr/local
|
||||
TASK_DONE = echo "\n✓ $@ done\n"
|
||||
# files that need mode 755
|
||||
EXEC_FILES=git-quick-stats
|
||||
PREFIX ?= /usr/local
|
||||
_INSTDIR ?= $(DESTDIR)$(PREFIX)
|
||||
BINDIR ?= $(_INSTDIR)/bin
|
||||
MANDIR ?= $(_INSTDIR)/share/man
|
||||
TASK_DONE = echo -e "\n✓ $@ done\n"
|
||||
|
||||
.PHONY: test
|
||||
|
||||
all:
|
||||
@echo "usage: make install"
|
||||
@echo " make reinstall"
|
||||
@echo " make uninstall"
|
||||
@echo " make test"
|
||||
@echo "Usage:"
|
||||
@echo " make install"
|
||||
@echo " make reinstall"
|
||||
@echo " make uninstall"
|
||||
@echo " make test"
|
||||
|
||||
help:
|
||||
$(MAKE) all
|
||||
@$(TASK_DONE)
|
||||
|
||||
install:
|
||||
install -m 0755 $(EXEC_FILES) $(PREFIX)/bin
|
||||
git config --global alias.quick-stats '! $(PREFIX)/bin/$(EXEC_FILES)'
|
||||
install -d -m 0755 $(BINDIR)
|
||||
install -m 0755 git-quick-stats $(BINDIR)/git-quick-stats
|
||||
$(MAKE) man
|
||||
@$(TASK_DONE)
|
||||
|
||||
uninstall:
|
||||
test -d $(PREFIX)/bin && \
|
||||
cd $(PREFIX)/bin && \
|
||||
rm -f $(EXEC_FILES) && \
|
||||
git config --global --unset alias.quick-stats
|
||||
rm -f $(BINDIR)/git-quick-stats
|
||||
rm -f $(MANDIR)/man1/git-quick-stats.1
|
||||
@$(TASK_DONE)
|
||||
|
||||
reinstall:
|
||||
@curl -s https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats > git-quick-stats
|
||||
$(MAKE) uninstall && \
|
||||
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
|
||||
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
|
||||
$(MAKE) install
|
||||
@$(TASK_DONE)
|
||||
|
||||
man:
|
||||
install -d -m 0755 $(MANDIR)/man1/
|
||||
install -m 0644 git-quick-stats.1 $(MANDIR)/man1/
|
||||
|
||||
test:
|
||||
tests/commands_test.sh
|
||||
@$(TASK_DONE)
|
||||
|
||||
243
README.md
243
README.md
@@ -1,98 +1,176 @@
|
||||
|
||||
## GIT quick statistics
|
||||
# GIT quick statistics [](#backers) [](#sponsors) [](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://travis-ci.org/arzzen/git-quick-stats) [](http://braumeister.org/formula/git-quick-stats) [](https://repology.org/metapackage/git-quick-stats/packages)
|
||||
|
||||
[](https://travis-ci.org/arzzen/git-quick-stats)
|
||||
[]()
|
||||
> `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 :).
|
||||
|
||||
> `git quick-stats` is a simple and efficient way to access various statistics in git repository.
|
||||
|
||||
> Any git repository contains a tonne 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 – 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)
|
||||
|
||||
[**Installation**](#installation)
|
||||
* [**Unix OS**](#unix-like-os)
|
||||
* [**OS X**](#os-x-homebrew)
|
||||
* [**Windows**](#windows-cygwin)
|
||||
|
||||
[**Usage**](#usage)
|
||||
* [**Git log since/unitl**](#git-log-since-until)
|
||||
|
||||
* [**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 pathspec**](#git-pathspec)
|
||||
* [**Tests**](#tests)
|
||||
* [**Color themes**](#color-themes)
|
||||
|
||||
[**Installation**](#installation)
|
||||
|
||||
* [**UNIX and Linux**](#unix-and-linux)
|
||||
* [**macOS**](#macos-homebrew)
|
||||
* [**Windows**](#windows)
|
||||
|
||||
[**System requirements**](#system-requirements)
|
||||
* [**Dependences**](#dependences)
|
||||
|
||||
* [**Dependencies**](#dependencies)
|
||||
|
||||
[**FAQ**](#faq)
|
||||
|
||||
[**Contribution**](#contribution)
|
||||
|
||||
[**License**](#licensing)
|
||||
* [**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
|
||||
git-quick-stats
|
||||
```
|
||||
|
||||
Or you can use (non-interactive) direct execution:
|
||||
|
||||
`git quick-stats <optional-command-to-execute-directly>`
|
||||
|
||||
Possible arguments:
|
||||
> suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors,
|
||||
branchTree, branchesByDate, changelogs, changelogsByAuthor
|
||||
|
||||
|
||||
#### Git log since / until
|
||||
|
||||
You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
|
||||
Or
|
||||
|
||||
```bash
|
||||
export _GIT_SINCE="2017-20-01"
|
||||
export _GIT_UNTIL="2017-22-01"
|
||||
git quick-stats
|
||||
```
|
||||
|
||||
then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
|
||||
### 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:
|
||||
|
||||
#### Git log limit
|
||||
```bash
|
||||
git-quick-stats <optional-command-to-execute-directly>
|
||||
```
|
||||
|
||||
You can set variable `_GIT_LIMIT` for limited output (it will affect: "Git changelogs" and "Branch tree view" )
|
||||
Or
|
||||
|
||||
```bash
|
||||
git quick-stats <optional-command-to-execute-directly>
|
||||
```
|
||||
|
||||
### Command-line arguments
|
||||
|
||||
Possible arguments in short and long form:
|
||||
|
||||
```bash
|
||||
-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
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
```bash
|
||||
export _GIT_LIMIT=20
|
||||
```
|
||||
|
||||
#### Git pathspec
|
||||
### Git pathspec
|
||||
|
||||
You can exclude directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
|
||||
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'
|
||||
```
|
||||
|
||||
### Color themes
|
||||
|
||||
You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`
|
||||
|
||||
```bash
|
||||
export _MENU_THEME=legacy
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
#### Unix like OS
|
||||
### UNIX and Linux
|
||||
|
||||
```bash
|
||||
git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
|
||||
@@ -111,37 +189,50 @@ For update/reinstall
|
||||
sudo make reinstall
|
||||
```
|
||||
|
||||
#### OS X (homebrew)
|
||||
### macOS (homebrew)
|
||||
|
||||
```bash
|
||||
brew install git-quick-stats
|
||||
```
|
||||
|
||||
#### Windows (cygwin)
|
||||
Or you can follow the UNIX and Linux instructions if you wish.
|
||||
|
||||
* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
|
||||
### 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.
|
||||
|
||||
## System requirements
|
||||
|
||||
* Unix like OS with a proper shell
|
||||
* Tools we use: git ; awk ; sed ; tr ; echo ; grep ; cut ; sort ; head ; uniq ; column.
|
||||
* An OS with a Bash shell
|
||||
* Tools we use: awk ; basename ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
|
||||
|
||||
#### Dependences
|
||||
### Dependencies
|
||||
|
||||
* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
|
||||
|
||||
## Contribution
|
||||
## 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.
|
||||
|
||||
## Contribution
|
||||
|
||||
Want to contribute? Great! First, read this page.
|
||||
|
||||
#### Code reviews
|
||||
All submissions, including submissions by project members, require review.
|
||||
We use Github pull requests for this purpose.
|
||||
### Code reviews
|
||||
|
||||
#### Some tips for good pull requests:
|
||||
* Use our code
|
||||
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:
|
||||
@@ -153,20 +244,48 @@ We use Github pull requests for this purpose.
|
||||
HEAD. This make reviewing the code so much easier, and our history more
|
||||
readable.
|
||||
|
||||
#### Formatting
|
||||
### 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
|
||||
## 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/arzzen/git-quick-stats/blob/master/CONTRIBUTING.md
|
||||
[read this page]: http://github.com/arzzen/git-quick-stats/blob/master/docs/CONTRIBUTING.md
|
||||
[landing page]: http://arzzen.github.io/git-quick-stats
|
||||
[LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE.txt
|
||||
[LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
|
||||
|
||||
## Contributors
|
||||
|
||||
This project exists thanks to all the people who contribute.
|
||||
<a href="https://github.com/arzzen/git-quick-stats/graphs/contributors"><img src="https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false" /></a>
|
||||
|
||||
### Backers
|
||||
|
||||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
|
||||
|
||||
<a href="https://opencollective.com/git-quick-stats#backers" target="_blank"><img src="https://opencollective.com/git-quick-stats/backers.svg?width=890"></a>
|
||||
|
||||
### Sponsors
|
||||
|
||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-quick-stats#sponsor)]
|
||||
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/0/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/0/avatar.svg?v=1"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/1/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/1/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/2/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/2/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/3/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/3/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/4/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/4/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/5/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/5/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/6/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/6/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/7/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/8/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/git-quick-stats/sponsor/9/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg"></a>
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
||||
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
<meta http-equiv="refresh" content="0;url=https://lukasmestan.com/git-quick-stats/">
|
||||
</head>
|
||||
<body id="page-top">
|
||||
<header>
|
||||
|
||||
9
docs/issue_template.md
Normal file
9
docs/issue_template.md
Normal file
@@ -0,0 +1,9 @@
|
||||
#### Expected behavior and actual behavior.
|
||||
|
||||
|
||||
#### Steps to reproduce the problem.
|
||||
|
||||
|
||||
#### Specifications like the version of the project, operating system, or hardware.
|
||||
|
||||
|
||||
844
git-quick-stats
844
git-quick-stats
@@ -1,136 +1,308 @@
|
||||
#!/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
|
||||
|
||||
_since=${_GIT_SINCE:-}
|
||||
if [ ! -z ${_since} ]
|
||||
then _since="--since=$_since"
|
||||
fi
|
||||
[[ -n "${_since}" ]] && _since="--since=$_since"
|
||||
|
||||
_until=${_GIT_UNTIL:-}
|
||||
if [ ! -z ${_until} ]
|
||||
then _until="--until=$_until"
|
||||
fi
|
||||
[[ -n "${_until}" ]] && _until="--until=$_until"
|
||||
|
||||
_pathspec=${_GIT_PATHSPEC:-}
|
||||
if [ ! -z "${_pathspec}" ]
|
||||
then _pathspec="-- $_pathspec"
|
||||
fi
|
||||
[[ -n "${_pathspec}" ]] && _pathspec="-- $_pathspec"
|
||||
|
||||
|
||||
_limit=${_GIT_LIMIT:-}
|
||||
if [ ! -z ${_limit} ]
|
||||
if [[ -n "${_limit}" ]];
|
||||
then _limit=$_limit
|
||||
else
|
||||
_limit=10
|
||||
fi
|
||||
|
||||
function show_menu() {
|
||||
NORMAL=`echo "\033[m"`
|
||||
MENU=`echo "\033[36m"`
|
||||
NUMBER=`echo "\033[33m"`
|
||||
FGRED=`echo "\033[41m"`
|
||||
RED_TEXT=`echo "\033[31m"`
|
||||
ENTER_LINE=`echo "\033[33m"`
|
||||
# Default menu theme
|
||||
# Set the legacy theme by typing "export _MENU_THEME=legacy"
|
||||
_theme="${_MENU_THEME:=default}"
|
||||
|
||||
echo -e ""
|
||||
echo -e "${RED_TEXT} Generate: ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 1)${MENU} Contribution stats (by author) ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 2)${MENU} Git changelogs (last $_limit)${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 3)${MENU} Git changelogs by author ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 4)${MENU} My daily status ${NORMAL}"
|
||||
echo -e "${RED_TEXT} List: ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 5)${MENU} Branch tree view (last $_limit)${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 6)${MENU} All branches (sorted by most recent commit) ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 7)${MENU} All contributors (sorted by name) ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 8)${MENU} Git commits per author ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 9)${MENU} Git commits per date ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 10)${MENU} Git commits per month ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 11)${MENU} Git commits per weekday ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 12)${MENU} Git commits per hour ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 13)${MENU} Git commits by author per hour ${NORMAL}"
|
||||
echo -e "${RED_TEXT} Suggest: ${NORMAL}"
|
||||
echo -e "${MENU} ${NUMBER} 14)${MENU} Code reviewers (based on git history) ${NORMAL}"
|
||||
echo -e ""
|
||||
echo -e "${ENTER_LINE}Please enter a menu option or ${RED_TEXT}press enter to exit. ${NORMAL}"
|
||||
read opt
|
||||
################################################################################
|
||||
# DESC: Checks to make sure the user has the appropriate utilities installed
|
||||
# ARGS: None
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function checkUtils() {
|
||||
local -r msg="not found. Please make sure this is installed and in PATH."
|
||||
|
||||
command -v awk >/dev/null 2>&1 || { echo >&2 "awk ${msg}"; exit 1; }
|
||||
command -v basename >/dev/null 2>&1 || { echo >&2 "basename ${msg}"; exit 1; }
|
||||
command -v cat >/dev/null 2>&1 || { echo >&2 "cat ${msg}"; exit 1; }
|
||||
command -v column >/dev/null 2>&1 || { echo >&2 "column ${msg}"; exit 1; }
|
||||
command -v echo >/dev/null 2>&1 || { echo >&2 "echo ${msg}"; exit 1; }
|
||||
command -v git >/dev/null 2>&1 || { echo >&2 "git ${msg}"; exit 1; }
|
||||
command -v grep >/dev/null 2>&1 || { echo >&2 "grep ${msg}"; exit 1; }
|
||||
command -v head >/dev/null 2>&1 || { echo >&2 "head ${msg}"; exit 1; }
|
||||
command -v seq >/dev/null 2>&1 || { echo >&2 "seq ${msg}"; exit 1; }
|
||||
command -v sort >/dev/null 2>&1 || { echo >&2 "sort ${msg}"; exit 1; }
|
||||
command -v tput >/dev/null 2>&1 || { echo >&2 "tput ${msg}"; exit 1; }
|
||||
command -v tr >/dev/null 2>&1 || { echo >&2 "tr ${msg}"; exit 1; }
|
||||
command -v uniq >/dev/null 2>&1 || { echo >&2 "uniq ${msg}"; exit 1; }
|
||||
command -v wc >/dev/null 2>&1 || { echo >&2 "wc ${msg}"; exit 1; }
|
||||
}
|
||||
|
||||
function option_picked() {
|
||||
COLOR='\033[01;31m'
|
||||
RESET='\033[00;00m'
|
||||
MESSAGE=${@:-"${RESET}Error: No message passed"}
|
||||
echo -e "${COLOR}${MESSAGE}${RESET}"
|
||||
echo ""
|
||||
################################################################################
|
||||
# DESC: Help information printed to stdout during non-interactive mode
|
||||
# ARGS: None
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function usage() {
|
||||
local -r 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 exclude directories or files from the stats by using pathspec
|
||||
ex: export _GIT_PATHSPEC=':!pattern'
|
||||
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
|
||||
################################################################################
|
||||
function showMenu() {
|
||||
local -r normal=$(tput sgr0)
|
||||
local -r cyan=$(tput setaf 6)
|
||||
local -r bold=$(tput bold)
|
||||
local -r red=$(tput setaf 1)
|
||||
local -r yellow=$(tput setaf 3)
|
||||
local -r white=$(tput setaf 7)
|
||||
local titles=""
|
||||
local text=""
|
||||
local nums=""
|
||||
local help_txt=""
|
||||
local exit_txt=""
|
||||
|
||||
# Adjustable color menu option
|
||||
if [[ "${_theme}" == "legacy" ]]; then
|
||||
titles="${bold}${red}" && readonly titles
|
||||
text="${normal}${cyan}" && readonly text
|
||||
nums="${bold}${yellow}" && readonly nums
|
||||
help_txt="${normal}${yellow}" && readonly help_txt
|
||||
exit_txt="${bold}${red}" && readonly exit_txt
|
||||
else
|
||||
titles="${bold}${cyan}" && readonly titles
|
||||
text="${normal}${white}" && readonly text
|
||||
nums="${normal}${bold}${white}" && readonly nums
|
||||
help_txt="${normal}${cyan}" && readonly help_txt
|
||||
exit_txt="${bold}${cyan}" && readonly exit_txt
|
||||
fi
|
||||
|
||||
echo -e "\n${titles} Generate:${normal}"
|
||||
echo -e "${nums} 1)${text} Contribution stats (by author)"
|
||||
echo -e "${nums} 2)${text} Contribution stats (by author) on a specific branch"
|
||||
echo -e "${nums} 3)${text} Git changelogs (last $_limit days)"
|
||||
echo -e "${nums} 4)${text} Git changelogs by author"
|
||||
echo -e "${nums} 5)${text} My daily status"
|
||||
echo -e "${nums} 6)${text} Save git log output in JSON format"
|
||||
echo -e "\n${titles} List:"
|
||||
echo -e "${nums} 7)${text} Branch tree view (last $_limit)"
|
||||
echo -e "${nums} 8)${text} All branches (sorted by most recent commit)"
|
||||
echo -e "${nums} 9)${text} All contributors (sorted by name)"
|
||||
echo -e "${nums} 10)${text} Git commits per author"
|
||||
echo -e "${nums} 11)${text} Git commits per date"
|
||||
echo -e "${nums} 12)${text} Git commits per month"
|
||||
echo -e "${nums} 13)${text} Git commits per weekday"
|
||||
echo -e "${nums} 14)${text} Git commits per hour"
|
||||
echo -e "${nums} 15)${text} Git commits by author per hour"
|
||||
echo -e "\n${titles} Suggest:"
|
||||
echo -e "${nums} 16)${text} Code reviewers (based on git history)"
|
||||
echo -e "\n${help_txt}Please enter a menu option or ${exit_txt}press Enter to exit."
|
||||
echo -n "${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 -r bold=$(tput bold)
|
||||
local -r red=$(tput setaf 1)
|
||||
local -r reset=$(tput sgr0)
|
||||
local msg=${*:-"${reset}Error: No message passed"}
|
||||
|
||||
echo -e "${bold}${red}${msg}${reset}\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() {
|
||||
option_picked "Contribution stats (by author):"
|
||||
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
|
||||
|
||||
git log --use-mailmap --no-merges --numstat --pretty="format:commit %H%nAuthor: %aN <%ae>%nDate: %ad%n%n%w(0,4,4)%B%n" $_since $_until $_pathspec | LC_ALL=C awk '
|
||||
function printStats(author) {
|
||||
printf "\t%s:\n", author
|
||||
# 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
|
||||
|
||||
if( more["total"] > 0 ) {
|
||||
printf "\t insertions: %d (%.0f%%)\n", more[author], (more[author] / more["total"] * 100)
|
||||
}
|
||||
git -c log.showSignature=false log ${_branch} --use-mailmap --no-merges --numstat \
|
||||
--pretty="format:commit %H%nAuthor: %aN <%aE>%nDate: %ad%n%n%w(0,4,4)%B%n" \
|
||||
$_since $_until $_pathspec | LC_ALL=C awk '
|
||||
function printStats(author) {
|
||||
printf "\t%s:\n", author
|
||||
|
||||
if( less["total"] > 0 ) {
|
||||
printf "\t deletions: %d (%.0f%%)\n", less[author], (less[author] / less["total"] * 100)
|
||||
}
|
||||
|
||||
if( file["total"] > 0 ) {
|
||||
printf "\t files: %d (%.0f%%)\n", file[author], (file[author] / file["total"] * 100)
|
||||
}
|
||||
|
||||
if(commits["total"] > 0) {
|
||||
printf "\t commits: %d (%.0f%%)\n", commits[author], (commits[author] / commits["total"] * 100)
|
||||
}
|
||||
|
||||
if ( first[author] != "" ) {
|
||||
printf "\t lines changed: %s\n", more[author] + less[author]
|
||||
printf "\t first commit: %s\n", first[author]
|
||||
printf "\t last commit: %s\n", last[author]
|
||||
}
|
||||
|
||||
printf "\n"
|
||||
}
|
||||
|
||||
/^Author:/ {
|
||||
author = $2 " " $3
|
||||
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)
|
||||
if(more["total"] > 0) {
|
||||
printf "\t insertions: %d (%.0f%%)\n", more[author], \
|
||||
(more[author] / more["total"] * 100)
|
||||
}
|
||||
}
|
||||
printStats("total")
|
||||
}'
|
||||
|
||||
if(less["total"] > 0) {
|
||||
printf "\t deletions: %d (%.0f%%)\n", less[author], \
|
||||
(less[author] / less["total"] * 100)
|
||||
}
|
||||
|
||||
if(file["total"] > 0) {
|
||||
printf "\t files: %d (%.0f%%)\n", file[author], \
|
||||
(file[author] / file["total"] * 100)
|
||||
}
|
||||
|
||||
if(commits["total"] > 0) {
|
||||
printf "\t commits: %d (%.0f%%)\n", commits[author], \
|
||||
(commits[author] / commits["total"] * 100)
|
||||
}
|
||||
|
||||
if (first[author] != "") {
|
||||
printf "\t lines changed: %s\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() {
|
||||
option_picked "Suggested code reviewers (based on git history):"
|
||||
git log --use-mailmap --no-merges $_since $_until --pretty=%aN $_pathspec $* | head -n 100 | sort | uniq -c | sort -nr | LC_ALL=C awk '
|
||||
optionPicked "Suggested code reviewers (based on git history):"
|
||||
git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
|
||||
--pretty=%aN $_pathspec | head -n 100 | sort | uniq -c | sort -nr | LC_ALL=C awk '
|
||||
{ args[NR] = $0; }
|
||||
END {
|
||||
for (i = 1; i <= NR; ++i) {
|
||||
@@ -139,13 +311,34 @@ function suggestReviewers() {
|
||||
}' | 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 --no-merges $_since $_until \
|
||||
--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() {
|
||||
option_picked "Git commits by month:"
|
||||
optionPicked "Git commits by month:"
|
||||
echo -e "\tmonth\tsum"
|
||||
for i in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
|
||||
do
|
||||
echo -en "\t$i\t"
|
||||
echo $(git shortlog -n --no-merges --format='%ad %s' $_since $_until | grep " $i " | wc -l)
|
||||
git -c log.showSignature=false shortlog -n --no-merges --format='%ad %s' \
|
||||
$_since $_until | grep " $i " | wc -l
|
||||
done | awk '{
|
||||
count[$1] = $2
|
||||
total += $2
|
||||
@@ -153,23 +346,30 @@ function commitsByMonth() {
|
||||
END{
|
||||
for (month in count) {
|
||||
s="|";
|
||||
percent = ((count[month] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
s=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 );
|
||||
}
|
||||
|
||||
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() {
|
||||
option_picked "Git commits by weekday:"
|
||||
optionPicked "Git commits by weekday:"
|
||||
echo -e "\tday\tsum"
|
||||
for i in Mon Tue Wed Thu Fri Sat Sun
|
||||
do
|
||||
echo -en "\t$i\t"
|
||||
echo $(git shortlog -n --no-merges --format='%ad %s' $_since $_until | grep "$i " | wc -l)
|
||||
git -c log.showSignature=false shortlog -n --no-merges --format='%ad %s' \
|
||||
$_since $_until | grep "$i " | wc -l
|
||||
done | awk '{
|
||||
|
||||
}
|
||||
@@ -182,29 +382,39 @@ function commitsByWeekday() {
|
||||
|
||||
for (day in count) {
|
||||
s="|";
|
||||
percent = ((count[day] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
s=s"█"
|
||||
if (total > 0) {
|
||||
percent = ((count[day] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
s=s"█"
|
||||
}
|
||||
printf( "\t%s\t%-0s\t%s\n", day, count[day], s );
|
||||
}
|
||||
printf( "\t%s\t%-0s\t%s\n", day, count[day], s );
|
||||
}
|
||||
}' | sort -k 2 -n -r
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# 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
|
||||
option_picked "Git commits by hour:"
|
||||
local _author=""
|
||||
|
||||
if [[ -z "${author}" ]]; then
|
||||
optionPicked "Git commits by hour:"
|
||||
_author="--author=**"
|
||||
else
|
||||
option_picked "Git commits by hour for author '$author':"
|
||||
_author="--author=$author"
|
||||
optionPicked "Git commits by hour for author '${author}':"
|
||||
_author="--author=${author}"
|
||||
fi
|
||||
echo -e "\thour\tsum"
|
||||
for i in `seq -w 0 23`
|
||||
for i in $(seq -w 0 23)
|
||||
do
|
||||
echo -ne "\t$i\t"
|
||||
echo $(git shortlog -n --no-merges --format='%ad %s' $_author $_since $_until | grep " $i:" | wc -l)
|
||||
git -c log.showSignature=false shortlog -n --no-merges --format='%ad %s' \
|
||||
"${_author}" $_since $_until | grep ' '$i: | wc -l
|
||||
done | awk '{
|
||||
count[$1] = $2
|
||||
total += $2
|
||||
@@ -212,33 +422,68 @@ function commitsByHour() {
|
||||
END{
|
||||
for (hour in count) {
|
||||
s="|";
|
||||
percent = ((count[hour] / total) * 100) / 1.25;
|
||||
for (i = 1; i <= percent; ++i) {
|
||||
s=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 );
|
||||
}
|
||||
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() {
|
||||
option_picked "Git commits per date:";
|
||||
git log --use-mailmap --no-merges $_since $_until --date=short --format='%ad' $_pathspec | sort | uniq -c
|
||||
optionPicked "Git commits per date:";
|
||||
git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
|
||||
--date=short --format='%ad' $_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() {
|
||||
option_picked "Git commits per author:"
|
||||
git shortlog $_since $_until --no-merges -n -s | sort -nr | LC_ALL=C awk '
|
||||
{ args[NR] = $0; sum += $0 }
|
||||
END {
|
||||
for (i = 1; i <= NR; ++i) {
|
||||
printf "%s,%2.1f%%\n", args[i], 100 * args[i] / sum
|
||||
}
|
||||
}' | column -t -s,
|
||||
optionPicked "Git commits per author:"
|
||||
local authorCommits=$(git -c log.showSignature=false log --use-mailmap --no-merges \
|
||||
$_since $_until | grep -i Author: | cut -c9-)
|
||||
local coAuthorCommits=$(git -c log.showSignature=false log --use-mailmap --no-merges \
|
||||
$_since $_until | 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() {
|
||||
option_picked "My daily status:"
|
||||
optionPicked "My daily status:"
|
||||
git diff --shortstat '@{0 day ago}' | sort -nr | tr ',' '\n' | LC_ALL=C awk '
|
||||
{ args[NR] = $0; }
|
||||
END {
|
||||
@@ -247,192 +492,185 @@ function myDailyStats() {
|
||||
}
|
||||
}'
|
||||
|
||||
echo -e "\t" $(git log --use-mailmap --author="$(git config user.name)" --no-merges --since=$(date "+%Y-%m-%dT00:00:00") --until=$(date "+%Y-%m-%dT23:59:59") --reverse | grep commit | wc -l) "commits"
|
||||
echo -e "\t" $(git -c log.showSignature=false log --use-mailmap \
|
||||
--author="$(git config user.name)" --no-merges \
|
||||
--since=$(date "+%Y-%m-%dT00:00:00") \
|
||||
--until=$(date "+%Y-%m-%dT23:59:59") --reverse \
|
||||
| grep commit | wc -l) "commits"
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Lists all contributors to a repo sorted by alphabetical order
|
||||
# ARGS: None
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function contributors() {
|
||||
option_picked "All contributors (sorted by name):"
|
||||
git log --use-mailmap --no-merges $_since $_until --format='%aN' $_pathspec | sort -u | cat -n
|
||||
optionPicked "All contributors (sorted by name):"
|
||||
git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
|
||||
--format='%aN' $_pathspec | sort -u | cat -n
|
||||
}
|
||||
|
||||
################################################################################
|
||||
# DESC: Shows an abbreviated ASCII graph based off of commit history
|
||||
# ARGS: None
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function branchTree() {
|
||||
option_picked "Branching tree view:"
|
||||
git 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 | head -n $((_limit*5))
|
||||
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 | head -n $((_limit*5))
|
||||
}
|
||||
|
||||
|
||||
################################################################################
|
||||
# DESC: Lists all branches sorted by their most recent commit
|
||||
# ARGS: None
|
||||
# OUTS: None
|
||||
################################################################################
|
||||
function branchesByDate() {
|
||||
option_picked "All branches (sorted by most recent commit):"
|
||||
git for-each-ref --sort=committerdate refs/heads/ --format='[%(authordate:relative)] %(authorname) %(refname:short)' | cat -n
|
||||
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=''
|
||||
if [ -z "$author" ]; then
|
||||
option_picked "Git changelogs:"
|
||||
local _author=""
|
||||
local next=$(date +%F)
|
||||
|
||||
if [[ -z "${author}" ]]; then
|
||||
optionPicked "Git changelogs:"
|
||||
_author="--author=**"
|
||||
else
|
||||
option_picked "Git changelogs for author '$author':"
|
||||
_author="--author=$author"
|
||||
optionPicked "Git changelogs for author '${author}':"
|
||||
_author="--author=${author}"
|
||||
fi
|
||||
|
||||
NEXT=$(date +%F)
|
||||
git log --use-mailmap --no-merges --format="%cd" --date=short $_author $_since $_until $_pathspec | sort -u -r | head -n $_limit | while read DATE ; do
|
||||
echo
|
||||
echo "[$DATE]"
|
||||
GIT_PAGER=cat git log --use-mailmap --no-merges --format=" * %s (%aN)" $_author --since=$DATE --until=$NEXT
|
||||
NEXT=$DATE
|
||||
done
|
||||
git -c log.showSignature=false log \
|
||||
--use-mailmap \
|
||||
--no-merges \
|
||||
--format="%cd" \
|
||||
--date=short "${_author}" $_since $_until $_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 --no-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
|
||||
|
||||
if [ $# -eq 1 ]
|
||||
then
|
||||
case $1 in
|
||||
"suggestReviewers")
|
||||
suggestReviewers
|
||||
;;
|
||||
"detailedGitStats")
|
||||
detailedGitStats
|
||||
;;
|
||||
"branchTree")
|
||||
branchTree
|
||||
;;
|
||||
"commitsPerDay")
|
||||
commitsPerDay
|
||||
;;
|
||||
"commitsPerAuthor")
|
||||
commitsPerAuthor
|
||||
;;
|
||||
"myDailyStats")
|
||||
myDailyStats
|
||||
;;
|
||||
"contributors")
|
||||
contributors
|
||||
;;
|
||||
"branchesByDate")
|
||||
branchesByDate
|
||||
;;
|
||||
"changelogs")
|
||||
changelogs
|
||||
;;
|
||||
"changelogsByAuthor")
|
||||
author="${_GIT_AUTHOR:-}"
|
||||
while [ -z "$author" ]; do read -p "Which author? " author; done
|
||||
changelogs "$author"
|
||||
;;
|
||||
"commitsByWeekday")
|
||||
commitsByWeekday
|
||||
;;
|
||||
"commitsByHour")
|
||||
commitsByHour
|
||||
;;
|
||||
"commitsByAuthorByHour")
|
||||
author="${_GIT_AUTHOR:-}"
|
||||
while [ -z "$author" ]; do read -p "Which author? " author; done
|
||||
commitsByHour "$author"
|
||||
;;
|
||||
"commitsByMonth")
|
||||
commitsByMonth
|
||||
;;
|
||||
*)
|
||||
echo "Invalid argument. Possible arguments: suggestReviewers, detailedGitStats, commitsPerDay, commitsByMonth, commitsByWeekday, commitsByHour, commitsByAuthorByHour, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
exit 0;
|
||||
fi
|
||||
|
||||
if [ $# -gt 1 ]
|
||||
then
|
||||
echo "Usage: git quick-stats <optional-command-to-execute-directly>";
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
clear
|
||||
show_menu
|
||||
|
||||
while [ opt != '' ]
|
||||
do
|
||||
if [[ $opt = "" ]]; then
|
||||
exit;
|
||||
else
|
||||
clear
|
||||
case $opt in
|
||||
1)
|
||||
detailedGitStats
|
||||
show_menu
|
||||
;;
|
||||
2)
|
||||
changelogs
|
||||
show_menu
|
||||
;;
|
||||
3)
|
||||
author=''
|
||||
while [ -z "$author" ]; do read -p "Which author? " author; done
|
||||
changelogs "$author"
|
||||
show_menu
|
||||
;;
|
||||
4)
|
||||
myDailyStats
|
||||
show_menu
|
||||
;;
|
||||
5)
|
||||
branchTree
|
||||
show_menu
|
||||
;;
|
||||
6)
|
||||
branchesByDate
|
||||
show_menu
|
||||
;;
|
||||
7)
|
||||
contributors
|
||||
show_menu
|
||||
;;
|
||||
8)
|
||||
commitsPerAuthor
|
||||
show_menu
|
||||
;;
|
||||
9)
|
||||
commitsPerDay
|
||||
show_menu
|
||||
;;
|
||||
10)
|
||||
commitsByMonth
|
||||
show_menu
|
||||
;;
|
||||
11)
|
||||
commitsByWeekday
|
||||
show_menu
|
||||
;;
|
||||
12)
|
||||
commitsByHour
|
||||
show_menu
|
||||
;;
|
||||
13)
|
||||
author=''
|
||||
while [ -z "$author" ]; do read -p "Which author? " author; done
|
||||
commitsByHour "$author"
|
||||
show_menu
|
||||
;;
|
||||
14)
|
||||
suggestReviewers
|
||||
show_menu
|
||||
;;
|
||||
q)
|
||||
exit
|
||||
;;
|
||||
\n)
|
||||
exit
|
||||
;;
|
||||
*)
|
||||
clear
|
||||
option_picked "Pick an option from the menu"
|
||||
show_menu
|
||||
;;
|
||||
|
||||
# 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
|
||||
read -r -p "Path 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
|
||||
read -r -p "Path 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
|
||||
|
||||
126
git-quick-stats.1
Normal file
126
git-quick-stats.1
Normal file
@@ -0,0 +1,126 @@
|
||||
.TH git-quick-stats "1" "January 2019" "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 OPTIONS
|
||||
.HP
|
||||
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
||||
.IP
|
||||
show the best people to contact to review code
|
||||
.HP
|
||||
.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\-d\fR, \fB\-\-commits\-per\-day\fR
|
||||
.IP
|
||||
displays a list of commits per day
|
||||
.HP
|
||||
.PP
|
||||
\fB\-m\fR, \fB\-\-commits\-by\-month\fR
|
||||
.IP
|
||||
displays a list of commits per month
|
||||
.HP
|
||||
.PP
|
||||
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
||||
.IP
|
||||
displays a list of commits per weekday
|
||||
.HP
|
||||
.PP
|
||||
\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
|
||||
.IP
|
||||
displays a list of commits per hour
|
||||
.HP
|
||||
.PP
|
||||
\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
|
||||
.IP
|
||||
displays a list of commits per hour by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
||||
.IP
|
||||
displays a list of commits per author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
|
||||
.IP
|
||||
see your current daily stats
|
||||
.HP
|
||||
.PP
|
||||
\fB\-C\fR, \fB\-\-contributors\fR
|
||||
.IP
|
||||
see a list of everyone who contributed to the repo
|
||||
.HP
|
||||
.PP
|
||||
\fB\-b\fR, \fB\-\-branch\-tree\fR
|
||||
.IP
|
||||
show an ASCII graph of the git repo branch history
|
||||
.HP
|
||||
.PP
|
||||
\fB\-D\fR, \fB\-\-branches\-by\-date\fR
|
||||
.IP
|
||||
show branches by date
|
||||
.HP
|
||||
.PP
|
||||
\fB\-c\fR, \fB\-\-changelogs\fR
|
||||
.IP
|
||||
see changelogs
|
||||
.HP
|
||||
.PP
|
||||
\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
|
||||
.IP
|
||||
see changelogs by author
|
||||
.HP
|
||||
.PP
|
||||
\fB\-j\fR, \fB\-\-json\-output\fR
|
||||
.IP
|
||||
save git log as a JSON formatted file to a specified area
|
||||
.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:
|
||||
.IP
|
||||
.PP
|
||||
.B export _GIT_SINCE="2017\-01\-20"
|
||||
.IP
|
||||
.PP
|
||||
You can set _GIT_LIMIT for limited output log, example:
|
||||
.PP
|
||||
.B export _GIT_LIMIT=20
|
||||
.PP
|
||||
You can exclude directories or files from the stats by using pathspec, example:
|
||||
.PP
|
||||
.B export _GIT_PATHSPEC=':!pattern'
|
||||
.PP
|
||||
You can switch to the legacy color scheme, example:
|
||||
.PP
|
||||
.B export _MENU_THEME=legacy
|
||||
.
|
||||
.fi
|
||||
|
||||
@@ -3,17 +3,16 @@
|
||||
. tests/assert.sh -v
|
||||
|
||||
src="./git-quick-stats"
|
||||
|
||||
assert "$src fail" "Invalid argument. Possible arguments: suggestReviewers, detailedGitStats, commitsPerDay, commitsByMonth, commitsByWeekday, commitsByHour, commitsByAuthorByHour, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor"
|
||||
assert "$src fail" "Invalid argument\n\nNAME\n git-quick-stats - Simple and efficient way to access various stats in a git repo\n\nSYNOPSIS\n For non-interactive mode: git-quick-stats [OPTIONS]\n For interactive mode: git-quick-stats\n\nDESCRIPTION\n Any git repository contains tons of information about commits, contributors,\n and files. Extracting this information is not always trivial, mostly because\n of a gadzillion options to a gadzillion git commands.\n\n This program allows you to see detailed information about a git repository.\n\nOPTIONS\n -r, --suggest-reviewers\n show the best people to contact to review code\n -T, --detailed-git-stats\n give a detailed list of git stats\n -R, --git-stats-by-branch\n see detailed list of git stats by branch\n -d, --commits-per-day\n displays a list of commits per day\n -m, --commits-by-month\n displays a list of commits per month\n -w, --commits-by-weekday\n displays a list of commits per weekday\n -o, --commits-by-hour\n displays a list of commits per hour\n -A, --commits-by-author-by-hour\n displays a list of commits per hour by author\n -a, --commits-per-author\n displays a list of commits per author\n -S, --my-daily-stats\n see your current daily stats\n -C, --contributors\n see a list of everyone who contributed to the repo\n -b, --branch-tree\n show an ASCII graph of the git repo branch history\n -D, --branches-by-date\n show branches by date\n -c, --changelogs\n see changelogs\n -L, --changelogs-by-author\n see changelogs by author\n -j, --json-output\n save git log as a JSON formatted file to a specified area\n -h, -?, --help\n display this help text in the terminal\n\nADDITIONAL USAGE\n You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log\n ex: export _GIT_SINCE=\"2017-01-20\"\n You can set _GIT_LIMIT for limited output log\n ex: export _GIT_LIMIT=20\n You can exclude directories or files from the stats by using pathspec\n ex: export _GIT_PATHSPEC=':!pattern'\n You can set _MENU_THEME to display the legacy color scheme\n ex: export _MENU_THEME=legacy"
|
||||
assert_raises "$src fail" 1
|
||||
|
||||
assert_contains "$src suggestReviewers" "Suggested code reviewers (based on git history)" 127
|
||||
assert_raises "$src suggestReviewers" 0
|
||||
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
|
||||
assert_raises "$src --suggest-reviewers" 0
|
||||
|
||||
assert_contains "$src detailedGitStats" "Contribution stats" 127
|
||||
assert_raises "$src detailedGitStats" 0
|
||||
assert_contains "$src --detailed-git-stats" "Contribution stats" 127
|
||||
assert_raises "$src --detailed-git-stats" 0
|
||||
|
||||
assert_contains "$src commitsPerDay" "Git commits per date" 127
|
||||
assert_raises "$src commitsPerDay" 0
|
||||
assert_contains "$src --commits-per-day" "Git commits per date" 127
|
||||
assert_raises "$src --commits-per-day" 0
|
||||
|
||||
assert_end
|
||||
|
||||
Reference in New Issue
Block a user