utils-code/arzzen.git-quick-stats
1
0
Fork 0
mirror of https://github.com/arzzen/git-quick-stats.git synced 2026-09-10 07:36:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
Author: "git-quick-stats is a simple and efficient way to access various statistics in a git repository."
121 commits 16 branches 68 tags 1.7 MiB
Shell 91.4%
Roff 6.6%
Makefile 1.1%
Dockerfile 0.9%
Go to file
Tom Ice 83e96f8b80 Fix divide by zero error and add utility checker 
* In some situations, the awk statements in the functions commitsByMonth,
  commitsByDay, and commitsByHour attempt to divide by zero and display
  an error to the user. To invoke this bug, checkout any of the previous
  commits and attempt to see commits by hour from some user who has never
  committed to this repository.

  This commit fixes this bug by making sure the awk statement only ever
  executes when the total commits is greater than zero.

* Added a utility checker to make sure that the user has all of the necessary
  tools in their path in order to run this script. If they do not exist, it
  exits and informs the user that this script cannot locate them in PATH.

* Adjusted shell logic to prevent double negatives from confusing developers
  as ! -z is technically read as something akin to "not has no value"

* Changed some statements to utilize safer and more predictable bash-isms

* Minor white space fixes and adjusted the README.md slightly
2018-12-21 14:50:13 -05:00
docs Update index.html 2018-12-07 15:43:23 +01:00
tests verbose tests 2017-04-02 17:02:56 +02:00
.mailmap add .mailmap 2017-09-05 08:42:41 +02:00
.travis.yml Update .travis.yml 2017-09-29 13:28:50 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-16 08:22:00 +02:00
git-quick-stats Fix divide by zero error and add utility checker 2018-12-21 14:50:13 -05:00
LICENSE Update LICENSE 2018-01-07 12:33:34 +01:00
Makefile Makefile: fix installing to an empty prefix 2018-09-20 13:34:18 -04:00
README.md Fix divide by zero error and add utility checker 2018-12-21 14:50:13 -05:00

README.md

GIT quick statistics Tweet

Travis Homebrew package Linuxbrew package

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 himself :).

Table of Contents

Screenshots

Installation

Usage

System requirements

Contribution

FAQ

License

Screenshots

screenshot from 2017-04-02 17-10-21

screenshot from 2017-04-02 17-09-13

screenshot from 2017-04-02 17-09-31

screenshot from 2017-04-02 17-09-45

screenshot from 2017-04-02 17-08-28

Usage

git quick-stats
# or
git-quick-stats

Or you can use (non-interactive) direct execution:

git quick-stats <optional-command-to-execute-directly>

Possible arguments:

suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor

Git log since / until

You can set variable _GIT_SINCE, _GIT_UNTIL and limit the git log

export _GIT_SINCE="2017-20-01"
export _GIT_UNTIL="2017-22-01"

then run git quick-stats (affect all stats, except "My daily status" and "Git changelogs" )

Git log limit

You can set variable _GIT_LIMIT for limited output (it will affect: "Git changelogs" and "Branch tree view" )

export _GIT_LIMIT=20

Git pathspec

You can exclude directory from the stats by using pathspec

export _GIT_PATHSPEC=':!directory'

Installation

Unix like OS

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

sudo make uninstall

For update/reinstall

sudo make reinstall

OS X (homebrew)

brew install git-quick-stats

Windows (cygwin)

System requirements

  • Unix like OS with a proper shell
  • Tools we use: awk ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc

Dependences

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 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.

Contribution

Want to contribute? Great! First, read this page.

Code reviews

All submissions, including submissions by project members, require review.
We use Github pull requests for this purpose.

Some tips for good pull requests:

  • Use our code
    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 and here.
  • 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. Please submit your changes using the same syntax.

Tests

codecov

make test

Licensing

MIT see LICENSE for the full license text.