mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
Compare commits
75 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c0a1795c1a | ||
|
|
63b9b42034 | ||
|
|
90f9e359c3 | ||
|
|
82ba58e01d | ||
|
|
5b64a8de17 | ||
|
|
b77021c545 | ||
|
|
62458b6fd1 | ||
|
|
ad5b503eea | ||
|
|
96b5dab53f | ||
|
|
85b7fb1cdf | ||
|
|
151b260be1 | ||
|
|
f06b7f4833 | ||
|
|
bf7533afa7 | ||
|
|
27edcf0f7a | ||
|
|
dc72babb20 | ||
|
|
c8ad2fba84 | ||
|
|
5cf8feee53 | ||
|
|
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 |
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
|
||||||
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Desktop (please complete the following information):**
|
||||||
|
- OS: [e.g. iOS]
|
||||||
|
- Browser [e.g. chrome, safari]
|
||||||
|
- Version [e.g. 22]
|
||||||
|
|
||||||
|
**Smartphone (please complete the following information):**
|
||||||
|
- Device: [e.g. iPhone6]
|
||||||
|
- OS: [e.g. iOS8.1]
|
||||||
|
- Browser [e.g. stock browser, safari]
|
||||||
|
- Version [e.g. 22]
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
10
.gitignore
vendored
Normal file
10
.gitignore
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
*.json
|
||||||
|
*.db
|
||||||
|
.DS_Store*
|
||||||
|
._*
|
||||||
|
.*.swp
|
||||||
|
.*.swo
|
||||||
|
.Spotlight*
|
||||||
|
.Trash*
|
||||||
|
**/*~
|
||||||
|
nbproject/*
|
||||||
@@ -11,8 +11,6 @@ addons:
|
|||||||
- cmake
|
- cmake
|
||||||
|
|
||||||
install:
|
install:
|
||||||
- git checkout ${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}
|
|
||||||
- git branch --set-upstream-to origin/$TRAVIS_BRANCH
|
|
||||||
- git rev-parse HEAD
|
- git rev-parse HEAD
|
||||||
|
|
||||||
script: make test
|
script: make test
|
||||||
|
|||||||
27
Dockerfile
Normal file
27
Dockerfile
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
FROM alpine
|
||||||
|
|
||||||
|
# Copy sources
|
||||||
|
COPY . /app
|
||||||
|
|
||||||
|
# Install required packages & build git-quick-stats
|
||||||
|
RUN apk add --no-cache bash git make ncurses util-linux \
|
||||||
|
&& cd /app \
|
||||||
|
&& make install \
|
||||||
|
&& rm -rf /app \
|
||||||
|
&& apk del --no-cache make \
|
||||||
|
&& mkdir -p /usr/local/bin \
|
||||||
|
&& echo -en "#!/bin/bash\nset -e\n[[ \"\${1::1}\" == '-' ]] && set -- /usr/bin/git quick-stats \"\$@\"\nexec \"\$@\"" \
|
||||||
|
> /usr/local/bin/docker-entrypoint \
|
||||||
|
&& chmod +x /usr/local/bin/docker-entrypoint
|
||||||
|
|
||||||
|
# Declare all variables usables by git-quick-stats
|
||||||
|
ENV _GIT_SINCE= \
|
||||||
|
_GIT_UNTIL= \
|
||||||
|
_GIT_LIMIT= \
|
||||||
|
_GIT_PATHSPEC= \
|
||||||
|
_MENU_THEME=default \
|
||||||
|
TERM=xterm-256color
|
||||||
|
|
||||||
|
WORKDIR /git
|
||||||
|
ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
|
||||||
|
CMD [ "/usr/bin/git", "quick-stats" ]
|
||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2018 Lukáš Mešťan
|
Copyright (c) 2019 Lukáš Mešťan
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
26
Makefile
26
Makefile
@@ -1,12 +1,14 @@
|
|||||||
PREFIX ?= /usr/local
|
PREFIX ?= /usr/local
|
||||||
|
_INSTDIR ?= $(DESTDIR)$(PREFIX)
|
||||||
|
BINDIR ?= $(_INSTDIR)/bin
|
||||||
|
MANDIR ?= $(_INSTDIR)/share/man
|
||||||
TASK_DONE = echo -e "\n✓ $@ done\n"
|
TASK_DONE = echo -e "\n✓ $@ done\n"
|
||||||
# files that need mode 755
|
|
||||||
EXEC_FILES=git-quick-stats
|
|
||||||
|
|
||||||
.PHONY: test
|
.PHONY: test
|
||||||
|
|
||||||
all:
|
all:
|
||||||
@echo "usage: make install"
|
@echo "Usage:"
|
||||||
|
@echo " make install"
|
||||||
@echo " make reinstall"
|
@echo " make reinstall"
|
||||||
@echo " make uninstall"
|
@echo " make uninstall"
|
||||||
@echo " make test"
|
@echo " make test"
|
||||||
@@ -16,27 +18,25 @@ help:
|
|||||||
@$(TASK_DONE)
|
@$(TASK_DONE)
|
||||||
|
|
||||||
install:
|
install:
|
||||||
mkdir -p $(PREFIX)/bin
|
install -d -m 0755 $(BINDIR)
|
||||||
install -m 0755 $(EXEC_FILES) $(PREFIX)/bin/$(EXEC_FILES)
|
install -m 0755 git-quick-stats $(BINDIR)/git-quick-stats
|
||||||
git config --global alias.quick-stats '! $(PREFIX)/bin/$(EXEC_FILES)'
|
|
||||||
$(MAKE) man
|
$(MAKE) man
|
||||||
@$(TASK_DONE)
|
@$(TASK_DONE)
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
test -d $(PREFIX)/bin && \
|
rm -f $(BINDIR)/git-quick-stats
|
||||||
cd $(PREFIX)/bin && \
|
rm -f $(MANDIR)/man1/git-quick-stats.1
|
||||||
rm -f $(EXEC_FILES) && \
|
|
||||||
git config --global --unset alias.quick-stats
|
|
||||||
@$(TASK_DONE)
|
@$(TASK_DONE)
|
||||||
|
|
||||||
reinstall:
|
reinstall:
|
||||||
@curl -s https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats > git-quick-stats
|
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
|
||||||
$(MAKE) uninstall && \
|
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
|
||||||
$(MAKE) install
|
$(MAKE) install
|
||||||
@$(TASK_DONE)
|
@$(TASK_DONE)
|
||||||
|
|
||||||
man:
|
man:
|
||||||
install -g 0 -o 0 -m 0644 git-quick-stats.1 /usr/share/man/man1/
|
install -d -m 0755 $(MANDIR)/man1/
|
||||||
|
install -m 0644 git-quick-stats.1 $(MANDIR)/man1/
|
||||||
|
|
||||||
test:
|
test:
|
||||||
tests/commands_test.sh
|
tests/commands_test.sh
|
||||||
|
|||||||
207
README.md
207
README.md
@@ -1,71 +1,102 @@
|
|||||||
|
|
||||||
## 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)
|
# 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.
|
||||||
[](http://braumeister.org/formula/git-quick-stats)
|
>
|
||||||
[](https://repology.org/metapackage/git-quick-stats/packages)
|
> 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 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 – 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
|
## Table of Contents
|
||||||
|
|
||||||
[**Screenshots**](#screenshots)
|
[**Screenshots**](#screenshots)
|
||||||
|
|
||||||
[**Installation**](#installation)
|
|
||||||
* [**Unix OS**](#unix-like-os)
|
|
||||||
* [**OS X**](#os-x-homebrew)
|
|
||||||
* [**Windows**](#windows-cygwin)
|
|
||||||
|
|
||||||
[**Usage**](#usage)
|
[**Usage**](#usage)
|
||||||
* [**Git log since/until**](#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 log limit**](#git-log-limit)
|
||||||
* [**Git pathspec**](#git-pathspec)
|
* [**Git pathspec**](#git-pathspec)
|
||||||
* [**Tests**](#tests)
|
* [**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)
|
[**System requirements**](#system-requirements)
|
||||||
* [**Dependences**](#dependences)
|
|
||||||
|
|
||||||
[**Contribution**](#contribution)
|
* [**Dependencies**](#dependencies)
|
||||||
|
|
||||||
[**FAQ**](#faq)
|
[**FAQ**](#faq)
|
||||||
|
|
||||||
[**License**](#licensing)
|
[**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
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### Interactive
|
||||||
|
|
||||||
|
git-quick-stats has a built-in interactive menu that can be executed as such:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git quick-stats
|
|
||||||
# or
|
|
||||||
git-quick-stats
|
git-quick-stats
|
||||||
```
|
```
|
||||||
|
|
||||||
Or you can use (non-interactive) direct execution:
|
Or
|
||||||
|
|
||||||
`git quick-stats <optional-command-to-execute-directly>`
|
```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:
|
Possible arguments in short and long form:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
-r, --suggest-reviewers
|
-r, --suggest-reviewers
|
||||||
show the best people to contact to review code
|
show the best people to contact to review code
|
||||||
-T, --detailed-git-stats
|
-T, --detailed-git-stats
|
||||||
give a detailed list of 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
|
-d, --commits-per-day
|
||||||
displays a list of commits per day
|
displays a list of commits per day
|
||||||
-m, --commits-by-month
|
-m, --commits-by-month
|
||||||
@@ -90,42 +121,67 @@ Possible arguments in short and long form:
|
|||||||
see changelogs
|
see changelogs
|
||||||
-L, --changelogs-by-author
|
-L, --changelogs-by-author
|
||||||
see changelogs by author
|
see changelogs by author
|
||||||
|
-j, --json-output
|
||||||
|
save git log as a JSON formatted file to a specified area
|
||||||
-h, -?, --help
|
-h, -?, --help
|
||||||
display this help text in the terminal
|
display this help text in the terminal
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Git log since / until
|
### Git log since and until
|
||||||
|
|
||||||
You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
|
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
|
```bash
|
||||||
export _GIT_SINCE="2017-20-01"
|
export _GIT_SINCE="2017-01-20"
|
||||||
export _GIT_UNTIL="2017-22-01"
|
export _GIT_UNTIL="2017-01-22"
|
||||||
```
|
```
|
||||||
|
|
||||||
then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
|
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
|
||||||
|
|
||||||
#### Git log limit
|
You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options.
|
||||||
|
|
||||||
You can set variable `_GIT_LIMIT` for limited output (it will affect: "Git changelogs" and "Branch tree view" )
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export _GIT_LIMIT=20
|
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
|
```bash
|
||||||
export _GIT_PATHSPEC=':!directory'
|
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
|
## Installation
|
||||||
|
|
||||||
#### Unix like OS
|
### UNIX and Linux
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
|
git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
|
||||||
@@ -144,24 +200,37 @@ For update/reinstall
|
|||||||
sudo make reinstall
|
sudo make reinstall
|
||||||
```
|
```
|
||||||
|
|
||||||
#### OS X (homebrew)
|
### macOS (homebrew)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew install git-quick-stats
|
brew install git-quick-stats
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Windows (cygwin)
|
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)
|
* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
|
||||||
* [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
|
* [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
|
## System requirements
|
||||||
|
|
||||||
* Unix like OS with a proper shell
|
* An OS with a Bash shell
|
||||||
* Tools we use: awk ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
|
* 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`
|
* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
|
||||||
|
|
||||||
@@ -169,17 +238,19 @@ brew install git-quick-stats
|
|||||||
|
|
||||||
*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`
|
*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 dos2unix app in cygwin `/bin/dos2unix.exe /usr/local/bin/git-quick-stats`. This will convert it to Unix format and you then should be able to run it.
|
*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
|
## Contribution
|
||||||
|
|
||||||
Want to contribute? Great! First, read this page.
|
Want to contribute? Great! First, read this page.
|
||||||
|
|
||||||
#### Code reviews
|
### Code reviews
|
||||||
All submissions, including submissions by project members, require review.</br>
|
|
||||||
We use Github pull requests for this purpose.
|
All submissions, including submissions by project members, require review.</br>
|
||||||
|
We use GitHub pull requests for this purpose.
|
||||||
|
|
||||||
|
### Some tips for good pull requests
|
||||||
|
|
||||||
#### Some tips for good pull requests:
|
|
||||||
* Use our code </br>
|
* Use our code </br>
|
||||||
When in doubt, try to stay true to the existing code of the project.
|
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
|
* Write a descriptive commit message. What problem are you solving and what
|
||||||
@@ -192,11 +263,11 @@ We use Github pull requests for this purpose.
|
|||||||
HEAD. This make reviewing the code so much easier, and our history more
|
HEAD. This make reviewing the code so much easier, and our history more
|
||||||
readable.
|
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.
|
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)
|
[](https://codecov.io/gh/arzzen/git-quick-stats)
|
||||||
|
|
||||||
@@ -205,9 +276,35 @@ make test
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Licensing
|
## Licensing
|
||||||
|
|
||||||
MIT see [LICENSE][] for the full license text.
|
MIT see [LICENSE][] for the full license text.
|
||||||
|
|
||||||
[read this page]: http://github.com/arzzen/git-quick-stats/blob/master/docs/CONTRIBUTING.md
|
[read this page]: http://github.com/arzzen/git-quick-stats/blob/master/.github/CONTRIBUTING.md
|
||||||
[landing page]: http://arzzen.github.io/git-quick-stats
|
[landing page]: http://arzzen.github.io/git-quick-stats
|
||||||
[LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
|
[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>
|
||||||
|
|||||||
BIN
docs/bg.png
BIN
docs/bg.png
Binary file not shown.
|
Before Width: | Height: | Size: 55 KiB |
6
docs/css/animate.min.css
vendored
6
docs/css/animate.min.css
vendored
File diff suppressed because one or more lines are too long
5
docs/css/bootstrap.min.css
vendored
5
docs/css/bootstrap.min.css
vendored
File diff suppressed because one or more lines are too long
@@ -1,509 +0,0 @@
|
|||||||
/*!
|
|
||||||
* Start Bootstrap - Creative Bootstrap Theme (http://startbootstrap.com)
|
|
||||||
* Code licensed under the Apache License v2.0.
|
|
||||||
* For details, see http://www.apache.org/licenses/LICENSE-2.0.
|
|
||||||
*/
|
|
||||||
|
|
||||||
html,
|
|
||||||
body {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
font-family: Merriweather,'Helvetica Neue',Arial,sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
hr {
|
|
||||||
max-width: 50px;
|
|
||||||
border-color: #f05f40;
|
|
||||||
border-width: 3px;
|
|
||||||
}
|
|
||||||
|
|
||||||
hr.light {
|
|
||||||
border-color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
color: #f05f40;
|
|
||||||
-webkit-transition: all .35s;
|
|
||||||
-moz-transition: all .35s;
|
|
||||||
transition: all .35s;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover,
|
|
||||||
a:focus {
|
|
||||||
color: #eb3812;
|
|
||||||
}
|
|
||||||
|
|
||||||
#about a {
|
|
||||||
color: rgba(52, 52, 52, .7);
|
|
||||||
}
|
|
||||||
|
|
||||||
#about a:hover,
|
|
||||||
#about a:focus {
|
|
||||||
color: rgb(52, 52, 52);
|
|
||||||
}
|
|
||||||
|
|
||||||
h1,
|
|
||||||
h2,
|
|
||||||
h3,
|
|
||||||
h4,
|
|
||||||
h5,
|
|
||||||
h6 {
|
|
||||||
font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
p {
|
|
||||||
margin-bottom: 20px;
|
|
||||||
font-size: 16px;
|
|
||||||
line-height: 1.5;
|
|
||||||
}
|
|
||||||
|
|
||||||
.bg-primary {
|
|
||||||
background-color: #f05f40;
|
|
||||||
}
|
|
||||||
|
|
||||||
.bg-dark {
|
|
||||||
color: #fff;
|
|
||||||
background-color: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
.text-faded {
|
|
||||||
color: rgba(255,255,255,.7);
|
|
||||||
}
|
|
||||||
|
|
||||||
section {
|
|
||||||
padding: 100px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
aside {
|
|
||||||
padding: 50px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.no-padding {
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default {
|
|
||||||
border-color: rgba(34,34,34,.05);
|
|
||||||
font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
|
|
||||||
background-color: #fff;
|
|
||||||
-webkit-transition: all .35s;
|
|
||||||
-moz-transition: all .35s;
|
|
||||||
transition: all .35s;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .navbar-header .navbar-brand {
|
|
||||||
text-transform: uppercase;
|
|
||||||
font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
|
|
||||||
font-weight: 700;
|
|
||||||
color: #2d8888;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .navbar-header .navbar-brand:hover,
|
|
||||||
.navbar-default .navbar-header .navbar-brand:focus {
|
|
||||||
color: #eb3812;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .nav > li>a,
|
|
||||||
.navbar-default .nav>li>a:focus {
|
|
||||||
text-transform: uppercase;
|
|
||||||
font-size: 13px;
|
|
||||||
font-weight: 700;
|
|
||||||
color: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .nav > li>a:hover,
|
|
||||||
.navbar-default .nav>li>a:focus:hover {
|
|
||||||
color: #f05f40;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .nav > li.active>a,
|
|
||||||
.navbar-default .nav>li.active>a:focus {
|
|
||||||
color: #f05f40!important;
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .nav > li.active>a:hover,
|
|
||||||
.navbar-default .nav>li.active>a:focus:hover {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media(min-width:768px) {
|
|
||||||
.navbar-default {
|
|
||||||
border-color: rgba(255,255,255,.3);
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .navbar-header .navbar-brand {
|
|
||||||
color: rgba(255,255,255,.7);
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .navbar-header .navbar-brand:hover,
|
|
||||||
.navbar-default .navbar-header .navbar-brand:focus {
|
|
||||||
color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .nav > li>a,
|
|
||||||
.navbar-default .nav>li>a:focus {
|
|
||||||
color: rgba(255,255,255,.7);
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default .nav > li>a:hover,
|
|
||||||
.navbar-default .nav>li>a:focus:hover {
|
|
||||||
color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default.affix {
|
|
||||||
border-color: rgba(34,34,34,.05);
|
|
||||||
background-color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default.affix .navbar-header .navbar-brand {
|
|
||||||
font-size: 14px;
|
|
||||||
color: #f05f40;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default.affix .navbar-header .navbar-brand:hover,
|
|
||||||
.navbar-default.affix .navbar-header .navbar-brand:focus {
|
|
||||||
color: #eb3812;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default.affix .nav > li>a,
|
|
||||||
.navbar-default.affix .nav>li>a:focus {
|
|
||||||
color: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navbar-default.affix .nav > li>a:hover,
|
|
||||||
.navbar-default.affix .nav>li>a:focus:hover {
|
|
||||||
color: #f05f40;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
header {
|
|
||||||
position: relative;
|
|
||||||
width: 100%;
|
|
||||||
min-height: auto;
|
|
||||||
text-align: center;
|
|
||||||
color: #fff;
|
|
||||||
background-color: #2f2d2f;
|
|
||||||
/*background-color: #2c3333;*/
|
|
||||||
/*background-image: url(../img/header.jpg);*/
|
|
||||||
/*background-position: center;*/
|
|
||||||
/*-webkit-background-size: cover;*/
|
|
||||||
/*-moz-background-size: cover;*/
|
|
||||||
/*background-size: cover;*/
|
|
||||||
/*-o-background-size: cover;*/
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content {
|
|
||||||
position: relative;
|
|
||||||
width: 100%;
|
|
||||||
padding: 100px 15px;
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content .header-content-inner h1 {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
/* text-transform: uppercase; */
|
|
||||||
font-weight: 700;
|
|
||||||
font-size: 120px;
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content .header-content-inner hr {
|
|
||||||
margin: 30px auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content .header-content-inner p {
|
|
||||||
margin-bottom: 50px;
|
|
||||||
font-size: 16px;
|
|
||||||
font-weight: 300;
|
|
||||||
color: rgba(255,255,255,.7);
|
|
||||||
}
|
|
||||||
|
|
||||||
@media(min-width:768px) {
|
|
||||||
header {
|
|
||||||
min-height: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content {
|
|
||||||
position: absolute;
|
|
||||||
top: 50%;
|
|
||||||
padding: 0 50px;
|
|
||||||
-webkit-transform: translateY(-50%);
|
|
||||||
-ms-transform: translateY(-50%);
|
|
||||||
transform: translateY(-50%);
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content .header-content-inner {
|
|
||||||
margin-right: auto;
|
|
||||||
margin-left: auto;
|
|
||||||
max-width: 1000px;
|
|
||||||
}
|
|
||||||
|
|
||||||
header .header-content .header-content-inner p {
|
|
||||||
margin-right: auto;
|
|
||||||
margin-left: auto;
|
|
||||||
max-width: 80%;
|
|
||||||
font-size: 18px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.section-heading {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.service-box {
|
|
||||||
margin: 50px auto 0;
|
|
||||||
max-width: 400px;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media(min-width:992px) {
|
|
||||||
.service-box {
|
|
||||||
margin: 20px auto 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.service-box p {
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box {
|
|
||||||
display: block;
|
|
||||||
position: relative;
|
|
||||||
margin: 0 auto;
|
|
||||||
max-width: 650px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box .portfolio-box-caption {
|
|
||||||
display: block;
|
|
||||||
position: absolute;
|
|
||||||
bottom: 0;
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
text-align: center;
|
|
||||||
color: #fff;
|
|
||||||
opacity: 0;
|
|
||||||
background: rgba(240,95,64,.9);
|
|
||||||
-webkit-transition: all .35s;
|
|
||||||
-moz-transition: all .35s;
|
|
||||||
transition: all .35s;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content {
|
|
||||||
position: absolute;
|
|
||||||
top: 50%;
|
|
||||||
width: 100%;
|
|
||||||
text-align: center;
|
|
||||||
transform: translateY(-50%);
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-category,
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-name {
|
|
||||||
padding: 0 15px;
|
|
||||||
font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-category {
|
|
||||||
text-transform: uppercase;
|
|
||||||
font-size: 14px;
|
|
||||||
font-weight: 600;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-name {
|
|
||||||
font-size: 18px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box:hover .portfolio-box-caption {
|
|
||||||
opacity: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media(min-width:768px) {
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-category {
|
|
||||||
font-size: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-box .portfolio-box-caption .portfolio-box-caption-content .project-name {
|
|
||||||
font-size: 22px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.call-to-action h2 {
|
|
||||||
margin: 0 auto 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.text-primary {
|
|
||||||
color: #f05f40;
|
|
||||||
}
|
|
||||||
|
|
||||||
.no-gutter > [class*=col-] {
|
|
||||||
padding-right: 0;
|
|
||||||
padding-left: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-default {
|
|
||||||
border-color: #fff;
|
|
||||||
color: #222;
|
|
||||||
background-color: #fff;
|
|
||||||
-webkit-transition: all .35s;
|
|
||||||
-moz-transition: all .35s;
|
|
||||||
transition: all .35s;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-default:hover,
|
|
||||||
.btn-default:focus,
|
|
||||||
.btn-default.focus,
|
|
||||||
.btn-default:active,
|
|
||||||
.btn-default.active,
|
|
||||||
.open > .dropdown-toggle.btn-default {
|
|
||||||
border-color: #ededed;
|
|
||||||
color: #222;
|
|
||||||
background-color: #f2f2f2;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-default:active,
|
|
||||||
.btn-default.active,
|
|
||||||
.open > .dropdown-toggle.btn-default {
|
|
||||||
background-image: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-default.disabled,
|
|
||||||
.btn-default[disabled],
|
|
||||||
fieldset[disabled] .btn-default,
|
|
||||||
.btn-default.disabled:hover,
|
|
||||||
.btn-default[disabled]:hover,
|
|
||||||
fieldset[disabled] .btn-default:hover,
|
|
||||||
.btn-default.disabled:focus,
|
|
||||||
.btn-default[disabled]:focus,
|
|
||||||
fieldset[disabled] .btn-default:focus,
|
|
||||||
.btn-default.disabled.focus,
|
|
||||||
.btn-default[disabled].focus,
|
|
||||||
fieldset[disabled] .btn-default.focus,
|
|
||||||
.btn-default.disabled:active,
|
|
||||||
.btn-default[disabled]:active,
|
|
||||||
fieldset[disabled] .btn-default:active,
|
|
||||||
.btn-default.disabled.active,
|
|
||||||
.btn-default[disabled].active,
|
|
||||||
fieldset[disabled] .btn-default.active {
|
|
||||||
border-color: #fff;
|
|
||||||
background-color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-default .badge {
|
|
||||||
color: #fff;
|
|
||||||
background-color: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-primary {
|
|
||||||
border-color: #f05f40;
|
|
||||||
color: #fff;
|
|
||||||
background-color: #2d8888;
|
|
||||||
-webkit-transition: all .35s;
|
|
||||||
-moz-transition: all .35s;
|
|
||||||
transition: all .35s;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-primary:hover,
|
|
||||||
.btn-primary:focus,
|
|
||||||
.btn-primary.focus,
|
|
||||||
.btn-primary:active,
|
|
||||||
.btn-primary.active,
|
|
||||||
.open > .dropdown-toggle.btn-primary {
|
|
||||||
color: #fff;
|
|
||||||
background-color: #68a9a9;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-primary:active,
|
|
||||||
.btn-primary.active,
|
|
||||||
.open > .dropdown-toggle.btn-primary {
|
|
||||||
background-image: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-primary.disabled,
|
|
||||||
.btn-primary[disabled],
|
|
||||||
fieldset[disabled] .btn-primary,
|
|
||||||
.btn-primary.disabled:hover,
|
|
||||||
.btn-primary[disabled]:hover,
|
|
||||||
fieldset[disabled] .btn-primary:hover,
|
|
||||||
.btn-primary.disabled:focus,
|
|
||||||
.btn-primary[disabled]:focus,
|
|
||||||
fieldset[disabled] .btn-primary:focus,
|
|
||||||
.btn-primary.disabled.focus,
|
|
||||||
.btn-primary[disabled].focus,
|
|
||||||
fieldset[disabled] .btn-primary.focus,
|
|
||||||
.btn-primary.disabled:active,
|
|
||||||
.btn-primary[disabled]:active,
|
|
||||||
fieldset[disabled] .btn-primary:active,
|
|
||||||
.btn-primary.disabled.active,
|
|
||||||
.btn-primary[disabled].active,
|
|
||||||
fieldset[disabled] .btn-primary.active {
|
|
||||||
border-color: #f05f40;
|
|
||||||
background-color: #f05f40;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-primary .badge {
|
|
||||||
color: #f05f40;
|
|
||||||
background-color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn {
|
|
||||||
border: 0;
|
|
||||||
border-radius: 300px;
|
|
||||||
text-transform: uppercase;
|
|
||||||
font-family: 'Open Sans','Helvetica Neue',Arial,sans-serif;
|
|
||||||
font-weight: 700;
|
|
||||||
font-size: 1.4em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-xl {
|
|
||||||
padding: 15px 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
::-moz-selection {
|
|
||||||
text-shadow: none;
|
|
||||||
color: #fff;
|
|
||||||
background: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
::selection {
|
|
||||||
text-shadow: none;
|
|
||||||
color: #fff;
|
|
||||||
background: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
img::selection {
|
|
||||||
color: #fff;
|
|
||||||
background: 0 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
img::-moz-selection {
|
|
||||||
color: #fff;
|
|
||||||
background: 0 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
webkit-tap-highlight-color: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
#map {
|
|
||||||
height: 300px;
|
|
||||||
overflow: visible;
|
|
||||||
position: relative;
|
|
||||||
}
|
|
||||||
|
|
||||||
.subtitle {
|
|
||||||
color: #b1b1b1;
|
|
||||||
}
|
|
||||||
|
|
||||||
.logo {
|
|
||||||
width: 50%;
|
|
||||||
padding-bottom: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.screencap {
|
|
||||||
width: 80%;
|
|
||||||
padding-top: 20px;
|
|
||||||
padding-bottom: 30px;
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
/*!
|
|
||||||
* The code below adds the modal functionality of the Freelancer Bootstrap Theme
|
|
||||||
* and was originally part of this theme.
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* Start Bootstrap - Freelancer Bootstrap Theme (http://startbootstrap.com)
|
|
||||||
* Code licensed under the Apache License v2.0.
|
|
||||||
* For details, see http://www.apache.org/licenses/LICENSE-2.0.
|
|
||||||
*/
|
|
||||||
|
|
||||||
body {
|
|
||||||
overflow-x: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.img-centered {
|
|
||||||
margin: 0 auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .modal-content {
|
|
||||||
padding: 100px 0;
|
|
||||||
min-height: 100%;
|
|
||||||
border: 0;
|
|
||||||
border-radius: 0;
|
|
||||||
text-align: center;
|
|
||||||
background-clip: border-box;
|
|
||||||
-webkit-box-shadow: none;
|
|
||||||
box-shadow: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .modal-content h2 {
|
|
||||||
margin: 0;
|
|
||||||
font-size: 3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .modal-content img {
|
|
||||||
margin-bottom: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .modal-content .item-details {
|
|
||||||
margin: 30px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .close-modal {
|
|
||||||
position: absolute;
|
|
||||||
top: 25px;
|
|
||||||
right: 25px;
|
|
||||||
width: 75px;
|
|
||||||
height: 75px;
|
|
||||||
background-color: transparent;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .close-modal:hover {
|
|
||||||
opacity: .3;
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .close-modal .lr {
|
|
||||||
z-index: 1051;
|
|
||||||
width: 1px;
|
|
||||||
height: 75px;
|
|
||||||
margin-left: 35px;
|
|
||||||
background-color: #2c3e50;
|
|
||||||
-webkit-transform: rotate(45deg);
|
|
||||||
-ms-transform: rotate(45deg);
|
|
||||||
transform: rotate(45deg);
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .close-modal .lr .rl {
|
|
||||||
z-index: 1052;
|
|
||||||
width: 1px;
|
|
||||||
height: 75px;
|
|
||||||
background-color: #2c3e50;
|
|
||||||
-webkit-transform: rotate(90deg);
|
|
||||||
-ms-transform: rotate(90deg);
|
|
||||||
transform: rotate(90deg);
|
|
||||||
}
|
|
||||||
|
|
||||||
.portfolio-modal .modal-backdrop {
|
|
||||||
display: none;
|
|
||||||
opacity: 0;
|
|
||||||
}
|
|
||||||
BIN
docs/favicon.ico
BIN
docs/favicon.ico
Binary file not shown.
|
Before Width: | Height: | Size: 1.4 KiB |
@@ -1,35 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en-us">
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta name="author" content="Lukas Mestan">
|
|
||||||
<meta name="description" content="Commandline GIT statistics">
|
|
||||||
<title>git quick stats</title>
|
|
||||||
<link rel="shortcut icon" href="favicon.ico?v=1" type="image/x-icon">
|
|
||||||
<link rel="stylesheet" href="css/bootstrap.min.css" type="text/css">
|
|
||||||
<link href="https://fonts.googleapis.com/css?family=Montserrat" rel="stylesheet">
|
|
||||||
<link rel="stylesheet" href="css/animate.min.css" type="text/css">
|
|
||||||
<link rel="stylesheet" href="css/creative.css" type="text/css">
|
|
||||||
<link rel="stylesheet" href="css/modals.css" type="text/css">
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<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>
|
|
||||||
<div class="header-content">
|
|
||||||
<div class="header-content-inner">
|
|
||||||
<h1>git quick stats</h1>
|
|
||||||
<h3 class="subtitle"> simple and efficient way to access various statistics in git repository</h3>
|
|
||||||
<img class="screencap" src="bg.png" \>
|
|
||||||
<br>
|
|
||||||
<a href="https://github.com/arzzen/git-quick-stats" class="btn btn-primary btn-xl page-scroll">download</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</header>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
477
git-quick-stats
477
git-quick-stats
@@ -1,46 +1,71 @@
|
|||||||
#!/usr/bin/env bash
|
#!/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 nounset
|
||||||
set -o errexit
|
set -o errexit
|
||||||
|
|
||||||
|
# Beginning git log date. Respects all git datetime formats
|
||||||
_since=${_GIT_SINCE:-}
|
_since=${_GIT_SINCE:-}
|
||||||
[[ -n "${_since}" ]] && _since="--since=$_since"
|
[[ -n "${_since}" ]] && _since="--since=$_since"
|
||||||
|
|
||||||
|
# End of git log date. Respects all git datetime formats
|
||||||
_until=${_GIT_UNTIL:-}
|
_until=${_GIT_UNTIL:-}
|
||||||
[[ -n "${_until}" ]] && _until="--until=$_until"
|
[[ -n "${_until}" ]] && _until="--until=$_until"
|
||||||
|
|
||||||
|
# Set files or directories to be excluded in stats
|
||||||
_pathspec=${_GIT_PATHSPEC:-}
|
_pathspec=${_GIT_PATHSPEC:-}
|
||||||
[[ -n "${_pathspec}" ]] && _pathspec="-- $_pathspec"
|
[[ -n "${_pathspec}" ]] && _pathspec="-- $_pathspec"
|
||||||
|
|
||||||
|
# Set merge commit view strategy. Default is to show no merge commits
|
||||||
|
# Exclusive shows only merge commits
|
||||||
|
# Enable shows regular commits together with normal commits
|
||||||
|
_merges=${_GIT_MERGE_VIEW:-}
|
||||||
|
if [[ "${_merges,,}" == "exclusive" ]]; then
|
||||||
|
_merges="--merges"
|
||||||
|
elif [[ "${_merges,,}" == "enable" ]]; then
|
||||||
|
_merges=""
|
||||||
|
else
|
||||||
|
_merges="--no-merges"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Limit git log output
|
||||||
_limit=${_GIT_LIMIT:-}
|
_limit=${_GIT_LIMIT:-}
|
||||||
if [[ -n "${_limit}" ]];
|
if [[ -n "${_limit}" ]]; then
|
||||||
then _limit=$_limit
|
_limit=$_limit
|
||||||
else
|
else
|
||||||
_limit=10
|
_limit=10
|
||||||
fi
|
fi
|
||||||
|
|
||||||
function check_utils() {
|
# Default menu theme
|
||||||
local HELP_MSG="not found. Please make sure this is installed and in PATH."
|
# Set the legacy theme by typing "export _MENU_THEME=legacy"
|
||||||
|
_theme="${_MENU_THEME:=default}"
|
||||||
|
|
||||||
command -v awk >/dev/null 2>&1 || { echo >&2 "awk ${HELP_MSG}"; exit 1; }
|
################################################################################
|
||||||
command -v basename >/dev/null 2>&1 || { echo >&2 "basename ${HELP_MSG}"; exit 1; }
|
# DESC: Checks to make sure the user has the appropriate utilities installed
|
||||||
command -v cat > /dev/null 2>&1 || { echo >&2 "cat ${HELP_MSG}"; exit 1; }
|
# ARGS: None
|
||||||
command -v column > /dev/null 2>&1 || { echo >&2 "column ${HELP_MSG}"; exit 1; }
|
# OUTS: None
|
||||||
command -v echo > /dev/null 2>&1 || { echo >&2 "echo ${HELP_MSG}"; exit 1; }
|
################################################################################
|
||||||
command -v git > /dev/null 2>&1 || { echo >&2 "git ${HELP_MSG}"; exit 1; }
|
function checkUtils() {
|
||||||
command -v grep > /dev/null 2>&1 || { echo >&2 "grep ${HELP_MSG}"; exit 1; }
|
local -r msg="not found. Please make sure this is installed and in PATH."
|
||||||
command -v head > /dev/null 2>&1 || { echo >&2 "head ${HELP_MSG}"; exit 1; }
|
declare -ar utils=("awk" "basename" "cat" "column" "echo" "git" "grep" "head"
|
||||||
command -v seq > /dev/null 2>&1 || { echo >&2 "seq ${HELP_MSG}"; exit 1; }
|
"seq" "sort" "tput" "tr" "uniq" "wc")
|
||||||
command -v sort > /dev/null 2>&1 || { echo >&2 "sort ${HELP_MSG}"; exit 1; }
|
|
||||||
command -v tput > /dev/null 2>&1 || { echo >&2 "tput ${HELP_MSG}"; exit 1; }
|
for u in "${utils[@]}"
|
||||||
command -v tr > /dev/null 2>&1 || { echo >&2 "tr ${HELP_MSG}"; exit 1; }
|
do
|
||||||
command -v uniq > /dev/null 2>&1 || { echo >&2 "uniq ${HELP_MSG}"; exit 1; }
|
command -v "$u" >/dev/null 2>&1 || { echo >&2 "$u ${msg}"; exit 1; }
|
||||||
command -v wc > /dev/null 2>&1 || { echo >&2 "wc ${HELP_MSG}"; exit 1; }
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# DESC: Help information printed to stdout during non-interactive mode
|
||||||
|
# ARGS: None
|
||||||
|
# OUTS: None
|
||||||
|
################################################################################
|
||||||
function usage() {
|
function usage() {
|
||||||
local program=$(basename "$0")
|
local -r program=$(basename "$0")
|
||||||
|
|
||||||
echo "
|
echo "
|
||||||
NAME
|
NAME
|
||||||
@@ -62,6 +87,8 @@ OPTIONS
|
|||||||
show the best people to contact to review code
|
show the best people to contact to review code
|
||||||
-T, --detailed-git-stats
|
-T, --detailed-git-stats
|
||||||
give a detailed list of 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
|
-d, --commits-per-day
|
||||||
displays a list of commits per day
|
displays a list of commits per day
|
||||||
-m, --commits-by-month
|
-m, --commits-by-month
|
||||||
@@ -86,78 +113,157 @@ OPTIONS
|
|||||||
see changelogs
|
see changelogs
|
||||||
-L, --changelogs-by-author
|
-L, --changelogs-by-author
|
||||||
see changelogs by author
|
see changelogs by author
|
||||||
|
-j, --json-output
|
||||||
|
save git log as a JSON formatted file to a specified area
|
||||||
-h, -?, --help
|
-h, -?, --help
|
||||||
display this help text in the terminal
|
display this help text in the terminal
|
||||||
|
|
||||||
ADDITIONAL USAGE
|
ADDITIONAL USAGE
|
||||||
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log
|
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log
|
||||||
ex: export _GIT_SINCE=\"2017-20-01\"
|
ex: export _GIT_SINCE=\"2017-01-20\"
|
||||||
You can set _GIT_LIMIT for limited output log
|
You can set _GIT_LIMIT for limited output log
|
||||||
ex: export _GIT_LIMIT=20
|
ex: export _GIT_LIMIT=20
|
||||||
You can exclude a directory from the stats by using pathspec
|
You can exclude directories or files from the stats by using pathspec
|
||||||
ex: export _GIT_PATHSPEC=':!directory'"
|
ex: export _GIT_PATHSPEC=':!pattern'
|
||||||
|
You can set _GIT_MERGE_VIEW to view merge commits with normal commits
|
||||||
|
ex: export _GIT_MERGE_VIEW=enable
|
||||||
|
You can also set _GIT_MERGE_VIEW to only show merge commits
|
||||||
|
ex: export _GIT_MERGE_VIEW=exclusive
|
||||||
|
You can set _MENU_THEME to display the legacy color scheme
|
||||||
|
ex: export _MENU_THEME=legacy"
|
||||||
}
|
}
|
||||||
|
|
||||||
function show_menu() {
|
################################################################################
|
||||||
local NORMAL=$(tput sgr0)
|
# DESC: Displays the interactive menu and saves the user supplied option
|
||||||
local CYAN_TEXT=$(tput setaf 6)
|
# ARGS: None
|
||||||
local RED_TEXT=$(tput setaf 1)
|
# OUTS: $opt: Option selected by the user based on menu choice
|
||||||
local YELLOW_TEXT=$(tput setaf 3)
|
################################################################################
|
||||||
|
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=""
|
||||||
|
|
||||||
echo -e "\n${RED_TEXT} Generate: ${NORMAL}"
|
# Adjustable color menu option
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 1)${CYAN_TEXT} Contribution stats (by author) ${NORMAL}"
|
if [[ "${_theme}" == "legacy" ]]; then
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 2)${CYAN_TEXT} Git changelogs (last $_limit days)${NORMAL}"
|
titles="${bold}${red}" && readonly titles
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 3)${CYAN_TEXT} Git changelogs by author ${NORMAL}"
|
text="${normal}${cyan}" && readonly text
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 4)${CYAN_TEXT} My daily status ${NORMAL}"
|
nums="${bold}${yellow}" && readonly nums
|
||||||
echo -e "${RED_TEXT} List: ${NORMAL}"
|
help_txt="${normal}${yellow}" && readonly help_txt
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 5)${CYAN_TEXT} Branch tree view (last $_limit)${NORMAL}"
|
exit_txt="${bold}${red}" && readonly exit_txt
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 6)${CYAN_TEXT} All branches (sorted by most recent commit) ${NORMAL}"
|
else
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 7)${CYAN_TEXT} All contributors (sorted by name) ${NORMAL}"
|
titles="${bold}${cyan}" && readonly titles
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 8)${CYAN_TEXT} Git commits per author ${NORMAL}"
|
text="${normal}${white}" && readonly text
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 9)${CYAN_TEXT} Git commits per date ${NORMAL}"
|
nums="${normal}${bold}${white}" && readonly nums
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 10)${CYAN_TEXT} Git commits per month ${NORMAL}"
|
help_txt="${normal}${cyan}" && readonly help_txt
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 11)${CYAN_TEXT} Git commits per weekday ${NORMAL}"
|
exit_txt="${bold}${cyan}" && readonly exit_txt
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 12)${CYAN_TEXT} Git commits per hour ${NORMAL}"
|
fi
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 13)${CYAN_TEXT} Git commits by author per hour ${NORMAL}"
|
|
||||||
echo -e "${RED_TEXT} Suggest: ${NORMAL}"
|
echo -e "\n${titles} Generate:${normal}"
|
||||||
echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 14)${CYAN_TEXT} Code reviewers (based on git history) ${NORMAL}"
|
echo -e "${nums} 1)${text} Contribution stats (by author)"
|
||||||
echo -e "\n${YELLOW_TEXT}Please enter a menu option or ${RED_TEXT}press enter to exit. ${NORMAL}"
|
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
|
read -r opt
|
||||||
}
|
}
|
||||||
|
|
||||||
function option_picked() {
|
################################################################################
|
||||||
local BOLD=$(tput bold)
|
# DESC: Prints a formatted message of the selected option by the user to stdout
|
||||||
local RED_TEXT=$(tput setaf 1)
|
# ARGS: $* (required): String to print (usually provided by other functions)
|
||||||
local COLOR="${BOLD}${RED_TEXT}"
|
# OUTS: None
|
||||||
local RESET=$(tput sgr0)
|
################################################################################
|
||||||
local MESSAGE=${*:-"${RESET}Error: No message passed"}
|
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 "${COLOR}${MESSAGE}${RESET}\n"
|
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() {
|
function detailedGitStats() {
|
||||||
option_picked "Contribution stats (by author):"
|
local is_branch_existing=false
|
||||||
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 '
|
local branch="${1:-}"
|
||||||
|
local _branch=""
|
||||||
|
|
||||||
|
# Check if requesting for a specific branch
|
||||||
|
if [[ -n "${branch}" ]]; then
|
||||||
|
# Check if branch exist
|
||||||
|
if [[ $(git show-ref refs/heads/"${branch}") ]] ; then
|
||||||
|
is_branch_existing=true
|
||||||
|
_branch="${branch}"
|
||||||
|
else
|
||||||
|
is_branch_existing=false
|
||||||
|
_branch=""
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Prompt message
|
||||||
|
if [[ "${is_branch_existing}" && -n "${_branch}" ]]; then
|
||||||
|
optionPicked "Contribution stats (by author) on ${_branch} branch:"
|
||||||
|
elif [[ -n "${branch}" && -z "${_branch}" ]]; then
|
||||||
|
optionPicked "Branch ${branch} does not exist.\nContribution stats (by author) on the current branch:"
|
||||||
|
else
|
||||||
|
optionPicked "Contribution stats (by author) on the current branch:"
|
||||||
|
fi
|
||||||
|
|
||||||
|
git -c log.showSignature=false log ${_branch} --use-mailmap $_merges --numstat \
|
||||||
|
--pretty="format:commit %H%nAuthor: %aN <%aE>%nDate: %ad%n%n%w(0,4,4)%B%n" \
|
||||||
|
$_since $_until $_pathspec | LC_ALL=C awk '
|
||||||
function printStats(author) {
|
function printStats(author) {
|
||||||
printf "\t%s:\n", author
|
printf "\t%s:\n", author
|
||||||
|
|
||||||
if( more["total"] > 0 ) {
|
if(more["total"] > 0) {
|
||||||
printf "\t insertions: %d (%.0f%%)\n", more[author], (more[author] / more["total"] * 100)
|
printf "\t insertions: %d (%.0f%%)\n", more[author], \
|
||||||
|
(more[author] / more["total"] * 100)
|
||||||
}
|
}
|
||||||
|
|
||||||
if( less["total"] > 0 ) {
|
if(less["total"] > 0) {
|
||||||
printf "\t deletions: %d (%.0f%%)\n", less[author], (less[author] / less["total"] * 100)
|
printf "\t deletions: %d (%.0f%%)\n", less[author], \
|
||||||
|
(less[author] / less["total"] * 100)
|
||||||
}
|
}
|
||||||
|
|
||||||
if( file["total"] > 0 ) {
|
if(file["total"] > 0) {
|
||||||
printf "\t files: %d (%.0f%%)\n", file[author], (file[author] / file["total"] * 100)
|
printf "\t files: %d (%.0f%%)\n", file[author], \
|
||||||
|
(file[author] / file["total"] * 100)
|
||||||
}
|
}
|
||||||
|
|
||||||
if(commits["total"] > 0) {
|
if(commits["total"] > 0) {
|
||||||
printf "\t commits: %d (%.0f%%)\n", commits[author], (commits[author] / commits["total"] * 100)
|
printf "\t commits: %d (%.0f%%)\n", commits[author], \
|
||||||
|
(commits[author] / commits["total"] * 100)
|
||||||
}
|
}
|
||||||
|
|
||||||
if ( first[author] != "" ) {
|
if (first[author] != "") {
|
||||||
printf "\t lines changed: %s\n", more[author] + less[author]
|
printf "\t lines changed: %s\n", more[author] + less[author]
|
||||||
printf "\t first commit: %s\n", first[author]
|
printf "\t first commit: %s\n", first[author]
|
||||||
printf "\t last commit: %s\n", last[author]
|
printf "\t last commit: %s\n", last[author]
|
||||||
@@ -199,9 +305,15 @@ function detailedGitStats() {
|
|||||||
}'
|
}'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# DESC: Displays the authors in order of total contribution to the repo
|
||||||
|
# ARGS: None
|
||||||
|
# OUTS: None
|
||||||
|
################################################################################
|
||||||
function suggestReviewers() {
|
function suggestReviewers() {
|
||||||
option_picked "Suggested code reviewers (based on git history):"
|
optionPicked "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 '
|
git -c log.showSignature=false log --use-mailmap $_merges $_since $_until \
|
||||||
|
--pretty=%aN $_pathspec | head -n 100 | sort | uniq -c | sort -nr | LC_ALL=C awk '
|
||||||
{ args[NR] = $0; }
|
{ args[NR] = $0; }
|
||||||
END {
|
END {
|
||||||
for (i = 1; i <= NR; ++i) {
|
for (i = 1; i <= NR; ++i) {
|
||||||
@@ -210,13 +322,34 @@ function suggestReviewers() {
|
|||||||
}' | column -t -s,
|
}' | column -t -s,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# DESC: Saves the git log output in a JSON format
|
||||||
|
# ARGS: $json_path (required): Path to where the file is saved
|
||||||
|
# OUTS: A JSON formatted file
|
||||||
|
################################################################################
|
||||||
|
function jsonOutput() {
|
||||||
|
optionPicked "Output log saved to file at: ${json_path:?}/output.json"
|
||||||
|
git -c log.showSignature=false log --use-mailmap $_merges $_since $_until \
|
||||||
|
--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() {
|
function commitsByMonth() {
|
||||||
option_picked "Git commits by month:"
|
optionPicked "Git commits by month:"
|
||||||
echo -e "\tmonth\tsum"
|
echo -e "\tmonth\tsum"
|
||||||
for i in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
|
for i in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
|
||||||
do
|
do
|
||||||
echo -en "\t$i\t"
|
echo -en "\t$i\t"
|
||||||
git shortlog -n --no-merges --format='%ad %s' $_since $_until | grep " $i " | wc -l
|
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||||||
|
$_since $_until | grep " $i " | wc -l
|
||||||
done | awk '{
|
done | awk '{
|
||||||
count[$1] = $2
|
count[$1] = $2
|
||||||
total += $2
|
total += $2
|
||||||
@@ -235,13 +368,19 @@ function commitsByMonth() {
|
|||||||
}' | LC_TIME="en_EN.UTF-8" sort -M
|
}' | 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() {
|
function commitsByWeekday() {
|
||||||
option_picked "Git commits by weekday:"
|
optionPicked "Git commits by weekday:"
|
||||||
echo -e "\tday\tsum"
|
echo -e "\tday\tsum"
|
||||||
for i in Mon Tue Wed Thu Fri Sat Sun
|
for i in Mon Tue Wed Thu Fri Sat Sun
|
||||||
do
|
do
|
||||||
echo -en "\t$i\t"
|
echo -en "\t$i\t"
|
||||||
git shortlog -n --no-merges --format='%ad %s' $_since $_until | grep "$i " | wc -l
|
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||||||
|
$_since $_until | grep "$i " | wc -l
|
||||||
done | awk '{
|
done | awk '{
|
||||||
|
|
||||||
}
|
}
|
||||||
@@ -265,22 +404,28 @@ function commitsByWeekday() {
|
|||||||
}' | sort -k 2 -n -r
|
}' | 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() {
|
function commitsByHour() {
|
||||||
local author="${1:-}"
|
local author="${1:-}"
|
||||||
local _author=""
|
local _author=""
|
||||||
|
|
||||||
if [[ -z "${author}" ]]; then
|
if [[ -z "${author}" ]]; then
|
||||||
option_picked "Git commits by hour:"
|
optionPicked "Git commits by hour:"
|
||||||
_author="--author=**"
|
_author="--author=**"
|
||||||
else
|
else
|
||||||
option_picked "Git commits by hour for author '${author}':"
|
optionPicked "Git commits by hour for author '${author}':"
|
||||||
_author="--author=${author}"
|
_author="--author=${author}"
|
||||||
fi
|
fi
|
||||||
echo -e "\thour\tsum"
|
echo -e "\thour\tsum"
|
||||||
for i in $(seq -w 0 23)
|
for i in $(seq -w 0 23)
|
||||||
do
|
do
|
||||||
echo -ne "\t$i\t"
|
echo -ne "\t$i\t"
|
||||||
git shortlog -n --no-merges --format='%ad %s' "${_author}" $_since $_until | grep ' '$i: | wc -l
|
git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
|
||||||
|
"${_author}" $_since $_until | grep ' '$i: | wc -l
|
||||||
done | awk '{
|
done | awk '{
|
||||||
count[$1] = $2
|
count[$1] = $2
|
||||||
total += $2
|
total += $2
|
||||||
@@ -299,24 +444,57 @@ function commitsByHour() {
|
|||||||
}' | sort
|
}' | 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() {
|
function commitsPerDay() {
|
||||||
option_picked "Git commits per date:";
|
optionPicked "Git commits per date:";
|
||||||
git log --use-mailmap --no-merges $_since $_until --date=short --format='%ad' $_pathspec | sort | uniq -c
|
git -c log.showSignature=false log --use-mailmap $_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() {
|
function commitsPerAuthor() {
|
||||||
option_picked "Git commits per author:"
|
optionPicked "Git commits per author:"
|
||||||
git shortlog $_since $_until --no-merges -n -s | sort -nr | LC_ALL=C awk '
|
local authorCommits=$(git -c log.showSignature=false log --use-mailmap $_merges \
|
||||||
{ args[NR] = $0; sum += $0 }
|
$_since $_until | grep -i Author: | cut -c9-)
|
||||||
|
local coAuthorCommits=$(git -c log.showSignature=false log --use-mailmap $_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 {
|
END {
|
||||||
for (i = 1; i <= NR; ++i) {
|
for(i in author) {
|
||||||
printf "%s,%2.1f%%\n", args[i], 100 * args[i] / sum
|
sum[author[i]]++; name[author[i]] = author[i]; total++;
|
||||||
}
|
}
|
||||||
}' | column -t -s,
|
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() {
|
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 '
|
git diff --shortstat '@{0 day ago}' | sort -nr | tr ',' '\n' | LC_ALL=C awk '
|
||||||
{ args[NR] = $0; }
|
{ args[NR] = $0; }
|
||||||
END {
|
END {
|
||||||
@@ -325,48 +503,87 @@ 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)" $_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() {
|
function contributors() {
|
||||||
option_picked "All contributors (sorted by name):"
|
optionPicked "All contributors (sorted by name):"
|
||||||
git log --use-mailmap --no-merges $_since $_until --format='%aN' $_pathspec | sort -u | cat -n
|
git -c log.showSignature=false log --use-mailmap $_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() {
|
function branchTree() {
|
||||||
option_picked "Branching tree view:"
|
optionPicked "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))
|
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() {
|
function branchesByDate() {
|
||||||
option_picked "All branches (sorted by most recent commit):"
|
optionPicked "All branches (sorted by most recent commit):"
|
||||||
git for-each-ref --sort=committerdate refs/heads/ --format='[%(authordate:relative)] %(authorname) %(refname:short)' | cat -n
|
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() {
|
function changelogs() {
|
||||||
local author="${1:-}"
|
local author="${1:-}"
|
||||||
local _author=""
|
local _author=""
|
||||||
|
local next=$(date +%F)
|
||||||
|
|
||||||
if [[ -z "${author}" ]]; then
|
if [[ -z "${author}" ]]; then
|
||||||
option_picked "Git changelogs:"
|
optionPicked "Git changelogs:"
|
||||||
_author="--author=**"
|
_author="--author=**"
|
||||||
else
|
else
|
||||||
option_picked "Git changelogs for author '${author}':"
|
optionPicked "Git changelogs for author '${author}':"
|
||||||
_author="--author=${author}"
|
_author="--author=${author}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
NEXT=$(date +%F)
|
git -c log.showSignature=false log \
|
||||||
git log --use-mailmap --no-merges --format="%cd" --date=short "${_author}" $_since $_until $_pathspec | sort -u -r | head -n $_limit | while read DATE ; do
|
--use-mailmap \
|
||||||
echo
|
$_merges \
|
||||||
echo "[$DATE]"
|
--format="%cd" \
|
||||||
GIT_PAGER=cat git log --use-mailmap --no-merges --format=" * %s (%aN)" "${_author}" --since=$DATE --until=$NEXT
|
--date=short "${_author}" $_since $_until $_pathspec \
|
||||||
NEXT=$DATE
|
| sort -u -r | head -n $_limit \
|
||||||
|
| while read DATE; do
|
||||||
|
echo -e "\n[$DATE]"
|
||||||
|
GIT_PAGER=cat git -c log.showSignature=false log \
|
||||||
|
--use-mailmap $_merges \
|
||||||
|
--format=" * %s (%aN)" "${_author}" \
|
||||||
|
--since=$DATE --until=$next
|
||||||
|
next=$DATE
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# MAIN
|
||||||
|
|
||||||
# Check to make sure all utilities required for this script are installed
|
# Check to make sure all utilities required for this script are installed
|
||||||
check_utils
|
checkUtils
|
||||||
|
|
||||||
# Check if we are currently in a git repo.
|
# Check if we are currently in a git repo.
|
||||||
git rev-parse --is-inside-work-tree > /dev/null
|
git rev-parse --is-inside-work-tree > /dev/null
|
||||||
@@ -376,6 +593,12 @@ if [[ "$#" -eq 1 ]]; then
|
|||||||
case "$1" in
|
case "$1" in
|
||||||
-r|--suggest-reviewers) suggestReviewers;;
|
-r|--suggest-reviewers) suggestReviewers;;
|
||||||
-T|--detailed-git-stats) detailedGitStats;;
|
-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;;
|
-b|--branch-tree) branchTree;;
|
||||||
-d|--commits-per-day) commitsPerDay;;
|
-d|--commits-per-day) commitsPerDay;;
|
||||||
-a|--commits-per-author) commitsPerAuthor;;
|
-a|--commits-per-author) commitsPerAuthor;;
|
||||||
@@ -398,6 +621,16 @@ if [[ "$#" -eq 1 ]]; then
|
|||||||
done
|
done
|
||||||
commitsByHour "${author}";;
|
commitsByHour "${author}";;
|
||||||
-m|--commits-by-month) commitsByMonth;;
|
-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;;
|
-h|-\?|--help) usage;;
|
||||||
*) echo "Invalid argument"; usage; exit 1;;
|
*) echo "Invalid argument"; usage; exit 1;;
|
||||||
esac
|
esac
|
||||||
@@ -407,34 +640,48 @@ fi
|
|||||||
|
|
||||||
# Parse interactive commands
|
# Parse interactive commands
|
||||||
clear
|
clear
|
||||||
show_menu
|
showMenu
|
||||||
|
|
||||||
while [[ "${opt}" != "" ]]; do
|
while [[ "${opt}" != "" ]]; do
|
||||||
clear
|
clear
|
||||||
case "${opt}" in
|
case "${opt}" in
|
||||||
1) detailedGitStats; show_menu;;
|
1) detailedGitStats; showMenu;;
|
||||||
2) changelogs; show_menu;;
|
2) branch=""
|
||||||
3) author=""
|
while [[ -z "${branch}" ]]; do
|
||||||
|
read -r -p "Which branch? " branch
|
||||||
|
done
|
||||||
|
detailedGitStats "${branch}"; showMenu;;
|
||||||
|
3) changelogs; showMenu;;
|
||||||
|
4) author=""
|
||||||
while [[ -z "${author}" ]]; do
|
while [[ -z "${author}" ]]; do
|
||||||
read -r -p "Which author? " author
|
read -r -p "Which author? " author
|
||||||
done
|
done
|
||||||
changelogs "${author}"; show_menu;;
|
changelogs "${author}"; showMenu;;
|
||||||
4) myDailyStats; show_menu;;
|
5) myDailyStats; showMenu;;
|
||||||
5) branchTree; show_menu;;
|
6) json_path=""
|
||||||
6) branchesByDate; show_menu;;
|
while [[ -z "${json_path}" ]]; do
|
||||||
7) contributors; show_menu;;
|
read -r -p "Path to save JSON file: " json_path
|
||||||
8) commitsPerAuthor; show_menu;;
|
if [[ ! -w "${json_path}" ]]; then
|
||||||
9) commitsPerDay; show_menu;;
|
echo "Invalid path or permission denied to write to given area."
|
||||||
10) commitsByMonth; show_menu;;
|
json_path=""
|
||||||
11) commitsByWeekday; show_menu;;
|
fi
|
||||||
12) commitsByHour; show_menu;;
|
done
|
||||||
13) author=""
|
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
|
while [[ -z "${author}" ]]; do
|
||||||
read -r -p "Which author? " author
|
read -r -p "Which author? " author
|
||||||
done
|
done
|
||||||
commitsByHour "${author}"; show_menu;;
|
commitsByHour "${author}"; showMenu;;
|
||||||
14) suggestReviewers; show_menu;;
|
16) suggestReviewers; showMenu;;
|
||||||
q|"\n") exit;;
|
q|"\n") exit;;
|
||||||
*) clear; option_picked "Pick an option from the menu"; show_menu;;
|
*) clear; optionPicked "Pick an option from the menu"; showMenu;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.TH git-quick-stats "1" "January 2019" "git-quick-stats" "User Commands"
|
.TH git-quick-stats "1" "January 2020" "git-quick-stats" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B git\-quick\-stats
|
.B git\-quick\-stats
|
||||||
\- Simple and efficient way to access various stats in a git repository.
|
\- Simple and efficient way to access various stats in a git repository.
|
||||||
@@ -24,12 +24,16 @@ This program allows you to see detailed information about a git repository.
|
|||||||
show the best people to contact to review code
|
show the best people to contact to review code
|
||||||
.HP
|
.HP
|
||||||
.PP
|
.PP
|
||||||
.PP
|
|
||||||
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
||||||
.IP
|
.IP
|
||||||
give a detailed list of git stats
|
give a detailed list of git stats
|
||||||
.HP
|
.HP
|
||||||
.PP
|
.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
|
\fB\-d\fR, \fB\-\-commits\-per\-day\fR
|
||||||
.IP
|
.IP
|
||||||
displays a list of commits per day
|
displays a list of commits per day
|
||||||
@@ -90,24 +94,39 @@ see changelogs
|
|||||||
see changelogs by author
|
see changelogs by author
|
||||||
.HP
|
.HP
|
||||||
.PP
|
.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
|
\fB\-h\fR, \-?, \fB\-\-help\fR
|
||||||
.IP
|
.IP
|
||||||
display this help text in the terminal
|
display this help text in the terminal
|
||||||
.PP
|
.PP
|
||||||
.SH ADDITIONAL USAGE
|
.SH ADDITIONAL USAGE
|
||||||
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
|
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
|
||||||
.IP
|
|
||||||
.PP
|
.PP
|
||||||
.B export _GIT_SINCE="2017\-20\-01"
|
.B export _GIT_SINCE="2017\-01\-20"
|
||||||
.IP
|
|
||||||
.PP
|
.PP
|
||||||
You can set _GIT_LIMIT for limited output log, example:
|
You can set _GIT_LIMIT for limited output log, example:
|
||||||
.PP
|
.PP
|
||||||
.B export _GIT_LIMIT=20
|
.B export _GIT_LIMIT=20
|
||||||
.PP
|
.PP
|
||||||
You can exclude a directory from the stats by using pathspec, example:
|
You can exclude directories or files from the stats by using pathspec, example:
|
||||||
.PP
|
.PP
|
||||||
.B export _GIT_PATHSPEC=':!directory'
|
.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
|
.fi
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,7 @@
|
|||||||
. tests/assert.sh -v
|
. tests/assert.sh -v
|
||||||
|
|
||||||
src="./git-quick-stats"
|
src="./git-quick-stats"
|
||||||
#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 suggestReviewers - see best people to contact to review code\n detailedGitStats - displays a detailed list of git status\n commitsPerDay - displays a list of commits per day\n commitsByMonth - displays a list of commits per month\n commitsByWeekday - displays a list of commits per weekday\n commitsByHour - displays a list of commits per hour\n commitsByAuthorByHour - see a list of commits per hour by author\n commitsPerAuthor - displays a list of commits per author\n myDailyStats - see your current daily stats\n contributors - see a list of all contributors\n branchTree - see an ASCII graph of the git repo\n branchesByDate - show branches by date\n changelogs - see changelogs\n changelogsByAuthor - see changelogs by author\n\nADDITIONAL USAGE\n You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log\n ex: export _GIT_SINCE=2017-20-01\n You can set _GIT_LIMIT for limited output log\n ex: export _GIT_LIMIT=20\n You can exclude a directory from the stats by using pathspec\n ex: export _GIT_PATHSPEC=':!directory'\n \nCONTRIBUTION\n For details regarding contribution, please see the contribution.md document\n\nLICENSE\n This is under the MIT license. See LICENSE in the repo for more info"
|
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 _GIT_MERGE_VIEW to view merge commits with normal commits\n ex: export _GIT_MERGE_VIEW=enable\n You can also set _GIT_MERGE_VIEW to only show merge commits\n ex: export _GIT_MERGE_VIEW=exclusive\n You can set _MENU_THEME to display the legacy color scheme\n ex: export _MENU_THEME=legacy"
|
||||||
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 -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 -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-20-01\"\n You can set _GIT_LIMIT for limited output log\n ex: export _GIT_LIMIT=20\n You can exclude a directory from the stats by using pathspec\n ex: export _GIT_PATHSPEC=':!directory'"
|
|
||||||
assert_raises "$src fail" 1
|
assert_raises "$src fail" 1
|
||||||
|
|
||||||
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
|
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
|
||||||
|
|||||||
Reference in New Issue
Block a user