mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
Compare commits
120 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
125eec7136 | ||
|
d61c812247 | ||
|
|
261262ab4e | ||
|
|
e968ef62b9 | ||
|
74261c1e50 | ||
|
|
4eade09673 | ||
|
|
47a9151886 | ||
|
|
916d5e1e0f | ||
|
|
17a9d1427b | ||
|
|
091562d4f8 | ||
|
|
748576b541 | ||
|
|
f43ab22172 | ||
|
|
4d2e52aa6d | ||
|
|
08c0ca1d85 | ||
|
|
e8843da10e | ||
|
|
376887a394 | ||
|
|
cebb5a8f48 | ||
|
|
343351b762 | ||
|
|
95136d3f92 | ||
|
|
79c735c814 | ||
|
|
ec6a95d2ef | ||
|
|
b65b100cd8 | ||
|
|
dd7719c3b0 | ||
|
|
c34ceb4c0e | ||
|
|
850b7453eb | ||
|
5063d1aad7 | ||
|
|
53b9971cf7 | ||
|
|
eec6d53ce9 | ||
|
|
d06a7ca090 | ||
|
|
462439a855 | ||
|
|
c467a9694b | ||
|
|
d4f71cfdad | ||
|
|
88e369503e | ||
|
|
afd61ce9c2 | ||
|
|
e1e02024a1 | ||
|
|
d1641f7bf3 | ||
|
|
8de8c43212 | ||
|
f4ec72073d | ||
|
|
b0003bef49 | ||
|
|
a833a5f431 | ||
|
|
886f64f086 | ||
|
115b21a48d | ||
|
|
4d515b88b3 | ||
|
|
9b3c0e5db1 | ||
|
|
86ad0af8bb | ||
|
|
fb488abe3e | ||
|
|
3cce04ddad | ||
|
|
d4e56cf557 | ||
|
cf239e5523 | ||
|
|
a0f495894b | ||
|
|
4faf233ad1 | ||
|
7d5087795e | ||
|
|
fe2df31c36 | ||
|
615563459f | ||
|
|
8c1d81a29d | ||
|
|
9f96cecf42 | ||
|
|
5b01b5e055 | ||
|
|
32a84903ff | ||
|
cd6d67df06 | ||
|
|
00d13c0b79 | ||
|
|
b525ed3b5c | ||
|
|
41a8542aaa | ||
|
|
7b1e0b2a65 | ||
|
43bc82520e | ||
|
|
d33ede9bcc | ||
|
|
7f24d202b9 | ||
|
62b128a3ce | ||
|
|
8515fe3a94 | ||
|
|
37bfde67ed | ||
|
|
d886facadf | ||
|
|
aa6619508a | ||
|
|
a813846c9f | ||
|
22bf354da4 | ||
|
|
0fea0323a4 | ||
|
4fcf8f5fef | ||
|
|
374aa2ef72 | ||
|
33dca7f3ed | ||
|
|
2ecb296442 | ||
|
|
428d25d0ef | ||
|
c3110e985e | ||
|
ebbeb34837 | ||
|
6cdca7c7c7 | ||
|
|
71d414eb4a | ||
|
d8346210a4 | ||
|
|
b85760e8b9 | ||
|
07ad3b57a7 | ||
|
|
dec1c4e103 | ||
|
|
2a0294941f | ||
|
|
22f1b3563d | ||
|
|
628b31ffd8 | ||
|
|
1e5723d7a2 | ||
|
|
0c1749a560 | ||
|
|
ecab54c630 | ||
|
|
7219205696 | ||
|
|
dd3c97816e | ||
|
d2b273eead | ||
|
|
5b08bb0b52 | ||
|
|
08d1a5a6e3 | ||
|
|
f5c2b82f02 | ||
|
bf29c19cf5 | ||
|
|
c6cb74a5e0 | ||
|
|
3f0befcd07 | ||
|
|
292876846d | ||
|
|
e70c288225 | ||
|
|
4d2621b084 | ||
|
|
2318d42765 | ||
|
|
ef74d79102 | ||
|
|
82f8690285 | ||
|
0f641ea0e6 | ||
|
|
6c7bd4fddf | ||
|
|
9f9617b88b | ||
|
|
8cea653d6c | ||
|
|
efa004122e | ||
|
|
0534327006 | ||
|
a113dc306f | ||
|
|
0fc2fe956b | ||
|
|
1efe3133dc | ||
|
3fd0ee2453 | ||
|
|
a4f19c9e54 | ||
|
|
cd38c40fe8 |
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
@@ -1,5 +1 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: [arzzen]
|
||||
open_collective: git-quick-stats
|
||||
custom: ['https://lukasmestan.com/thanks/']
|
||||
|
||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -7,4 +7,7 @@
|
||||
.Spotlight*
|
||||
.Trash*
|
||||
**/*~
|
||||
nbproject/*
|
||||
nbproject/*
|
||||
/tests/test-git/.git/
|
||||
#/tests/test-git/*
|
||||
!/tests/test-git/resetgit
|
||||
|
||||
4
.mailmap
4
.mailmap
@@ -1,3 +1,3 @@
|
||||
Lukas Mestan <lukas.mestan@gmail.com> Lukáš Mešťan <arzzen@users.noreply.github.com>
|
||||
Lukas Mestan <lukas.mestan@gmail.com> arzzen
|
||||
Lukas <test@gmail.com> Lukáš <arzzen@users.noreply.github.com>
|
||||
Lukas <lukas@gmail.com> arzzen
|
||||
|
||||
|
||||
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 \
|
||||
@@ -23,5 +23,6 @@ ENV _GIT_SINCE= \
|
||||
TERM=xterm-256color
|
||||
|
||||
WORKDIR /git
|
||||
RUN git config --global --add safe.directory /git
|
||||
ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
|
||||
CMD [ "/usr/bin/git", "quick-stats" ]
|
||||
CMD [ "/usr/bin/git", "quick-stats" ]
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Lukáš Mešťan
|
||||
Copyright (c) 2024 git-quick-stats.sh
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
5
Makefile
5
Makefile
@@ -3,6 +3,7 @@ _INSTDIR ?= $(DESTDIR)$(PREFIX)
|
||||
BINDIR ?= $(_INSTDIR)/bin
|
||||
MANDIR ?= $(_INSTDIR)/share/man
|
||||
TASK_DONE = echo -e "\n✓ $@ done\n"
|
||||
SHELL := $(shell which bash)
|
||||
|
||||
.PHONY: test
|
||||
|
||||
@@ -29,8 +30,8 @@ uninstall:
|
||||
@$(TASK_DONE)
|
||||
|
||||
reinstall:
|
||||
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
|
||||
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
|
||||
@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats
|
||||
@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats.1
|
||||
$(MAKE) install
|
||||
@$(TASK_DONE)
|
||||
|
||||
|
||||
730
README.md
730
README.md
@@ -1,319 +1,411 @@
|
||||
|
||||
# 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) [](https://formulae.brew.sh/formula/git-quick-stats#default) [](https://repology.org/metapackage/git-quick-stats/packages)
|
||||
|
||||
> `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
|
||||
-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 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"
|
||||
```
|
||||
|
||||
### 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 and Linux
|
||||
|
||||
```bash
|
||||
git clone https://github.com/arzzen/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)
|
||||
|
||||
```bash
|
||||
brew install git-quick-stats
|
||||
```
|
||||
|
||||
Or you can follow the UNIX and Linux instructions if you wish.
|
||||
|
||||
### 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: awk ; basename ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
|
||||
|
||||
### Dependencies
|
||||
|
||||
* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
|
||||
|
||||
## 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.</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/arzzen/git-quick-stats/blob/master/.github/CONTRIBUTING.md
|
||||
[landing page]: http://arzzen.github.io/git-quick-stats
|
||||
[LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
|
||||
|
||||
## 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>
|
||||
# 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)
|
||||
|
||||
1445
git-quick-stats
1445
git-quick-stats
File diff suppressed because it is too large
Load Diff
@@ -1,136 +1,206 @@
|
||||
.TH git-quick-stats "1" "January 2020" "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:
|
||||
.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 switch to the legacy color scheme, example:
|
||||
.PP
|
||||
.B export _MENU_THEME=legacy
|
||||
.
|
||||
.fi
|
||||
|
||||
.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
|
||||
@@ -17,12 +17,16 @@
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
set -o nounset
|
||||
|
||||
export DISCOVERONLY=${DISCOVERONLY:-}
|
||||
export DEBUG=${DEBUG:-}
|
||||
export STOP=${STOP:-}
|
||||
export INVARIANT=${INVARIANT:-}
|
||||
export CONTINUE=${CONTINUE:-}
|
||||
|
||||
GREP=${GREP:-grep}
|
||||
|
||||
args="$(getopt -n "$0" -l \
|
||||
verbose,help,stop,discover,invariant,continue vhxdic $*)" \
|
||||
|| exit -1
|
||||
@@ -75,7 +79,7 @@ assert_end() {
|
||||
tests_endtime="$(date +%s%N)"
|
||||
# required visible decimal place for seconds (leading zeros if needed)
|
||||
local tests_time="$( \
|
||||
printf "%010d" "$(( ${tests_endtime/%N/000000000}
|
||||
printf "%010d" "$(( ${tests_endtime/%N/000000000}
|
||||
- ${tests_starttime/%N/000000000} ))")" # in ns
|
||||
tests="$tests_ran ${*:+$* }tests"
|
||||
[[ -n "$DISCOVERONLY" ]] && echo "collected $tests." && _assert_reset && return
|
||||
@@ -101,7 +105,7 @@ assert_end() {
|
||||
assert() {
|
||||
# assert <command> <expected stdout> [stdin]
|
||||
(( tests_ran++ )) || :
|
||||
[[ -z "$DISCOVERONLY" ]] || return
|
||||
[[ -z "$DISCOVERONLY" ]] || return 0
|
||||
expected=$(echo -ne "${2:-}")
|
||||
result="$(eval 2>/dev/null $1 <<< ${3:-})" || true
|
||||
if [[ "$result" == "$expected" ]]; then
|
||||
@@ -111,13 +115,13 @@ assert() {
|
||||
result="$(sed -e :a -e '$!N;s/\n/\\n/;ta' <<< "$result")"
|
||||
[[ -z "$result" ]] && result="nothing" || result="\"$result\""
|
||||
[[ -z "$2" ]] && expected="nothing" || expected="\"$2\""
|
||||
_assert_fail "expected $expected${_indent}got $result" "$1" "$3"
|
||||
_assert_fail "expected $expected${_indent}got $result" "$1" "${3:-}"
|
||||
}
|
||||
|
||||
assert_raises() {
|
||||
# assert_raises <command> <expected code> [stdin]
|
||||
(( tests_ran++ )) || :
|
||||
[[ -z "$DISCOVERONLY" ]] || return
|
||||
[[ -z "$DISCOVERONLY" ]] || return 0
|
||||
status=0
|
||||
(eval $1 <<< ${3:-}) > /dev/null 2>&1 || status=$?
|
||||
expected=${2:-0}
|
||||
@@ -125,19 +129,24 @@ assert_raises() {
|
||||
[[ -z "$DEBUG" ]] || echo -n .
|
||||
return
|
||||
fi
|
||||
_assert_fail "program terminated with code $status instead of $expected" "$1" "$3"
|
||||
_assert_fail "program terminated with code $status instead of $expected" "$1" "${3:-}"
|
||||
}
|
||||
|
||||
assert_success() {
|
||||
# assert_success <command>
|
||||
assert_raises "$1" 0
|
||||
}
|
||||
|
||||
# _assert_with_grep <grep modifiers> <command> <expected output...>
|
||||
_assert_with_grep() {
|
||||
local grep_modifier="$1"
|
||||
local output="$($2)"
|
||||
local exitcode="$4" || 0
|
||||
local exitcode=0
|
||||
shift 2
|
||||
|
||||
while [ $# != 0 ]; do
|
||||
assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
|
||||
shift
|
||||
assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
|
||||
shift
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
@@ -1,9 +1,17 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Verify we are in a git repo. Create one if not
|
||||
# FIXME: All the paths are hardcoded currently and will break if anything
|
||||
# in this chain moves or gets executed elsewhere. Adjust all of these so
|
||||
# pathing does not matter as much such as creating a TOP variable that
|
||||
# does something like TOP=$(cd "$(dirname "$0")" || exit ; pwd -P)
|
||||
# or maybe leverages Make to handle these as test targets
|
||||
./tests/test-git/resetgit
|
||||
|
||||
. tests/assert.sh -v
|
||||
|
||||
src="./git-quick-stats"
|
||||
assert "$src fail" "Invalid argument
|
||||
assert "$src fail" "Invalid argument: fail
|
||||
|
||||
NAME
|
||||
git-quick-stats - Simple and efficient way to access various stats in a git repo
|
||||
@@ -16,42 +24,64 @@ 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
|
||||
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
|
||||
-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
|
||||
-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
|
||||
|
||||
@@ -68,18 +98,34 @@ ADDITIONAL USAGE
|
||||
ex: export _GIT_MERGE_VIEW=enable
|
||||
You can also set _GIT_MERGE_VIEW to only show merge commits
|
||||
ex: export _GIT_MERGE_VIEW=exclusive
|
||||
You can set _MENU_THEME to display the legacy color scheme
|
||||
ex: export _MENU_THEME=legacy"
|
||||
You can change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
|
||||
You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
|
||||
ex: export _MENU_THEME=legacy
|
||||
You can set _GIT_BRANCH to set the branch of the stats
|
||||
ex: export _GIT_BRANCH=master
|
||||
You can set _GIT_IGNORE_AUTHORS to filter out specific authors
|
||||
ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
|
||||
You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
|
||||
ex: export _GIT_SORT_BY=\"name-asc\"
|
||||
You can set _GIT_DAYS to set the number of days for the heatmap
|
||||
ex: export _GIT_DAYS=30"
|
||||
|
||||
assert_raises "$src fail" 1
|
||||
|
||||
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
|
||||
assert_raises "$src --suggest-reviewers" 0
|
||||
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" 127
|
||||
assert_raises "$src --detailed-git-stats" 0
|
||||
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" 127
|
||||
assert_raises "$src --commits-per-day" 0
|
||||
assert_contains "$src --commits-per-day" "Git commits per date"
|
||||
assert_success "$src --commits-per-day"
|
||||
|
||||
assert_startswith "$src --commits-by-year" "Git commits by year"
|
||||
assert_success "$src --commits-by-year"
|
||||
|
||||
export LC_TIME=POSIX
|
||||
assert_startswith "$src --commits-by-year" "Git commits by year"
|
||||
assert_success "$src --commits-by-year"
|
||||
|
||||
assert_end
|
||||
|
||||
16
tests/test-git/resetgit
Executable file
16
tests/test-git/resetgit
Executable file
@@ -0,0 +1,16 @@
|
||||
#!/bin/sh
|
||||
# Initialises a new local Git repo for test purpose if one does not exist already
|
||||
if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
||||
{
|
||||
git init
|
||||
git config user.name "$(printf %s 'Test Git,\nfor test purpose')"
|
||||
git config user.email "TestGit\o/@example.org"
|
||||
|
||||
printf 'test-git\n========\n' > README.md
|
||||
git add README.md
|
||||
git commit -m 'added readme (o\w/o)' -m 'in markdown, no \r\n, only \n' -m 'a very "simple" readme'
|
||||
testChars="$(printf 'tab [%b] form feed [%b] line feed [%b] carriage return [%b]' '\x09' '\x0C' '\x0A' '\x0D')"
|
||||
git notes add -m 'Some notes' -m 'out of ascii: été au cœur' -m "$testChars"
|
||||
git log
|
||||
} >/dev/null 2>&1
|
||||
fi
|
||||
Reference in New Issue
Block a user