mirror of https://github.com/tomgi/git_stats.git synced 2024-12-22 05:22:16 +01:00

GitStats is a git repository statistics generator.

Find a file

Romain Weeger c35d2c5708 Add missing library on install For people who have not every required packages, or working like me from a fresh docker container.		2019-02-18 15:56:19 +01:00
bin	Modified the cli to base on thor gem.	2013-08-15 22:02:25 +02:00
config/locales	Improve zh_tw translation	2018-01-09 11:20:17 +08:00
lib	Bump to 1.0.17	2017-12-01 12:25:39 +01:00
spec	Switched short commit SHA to full SHA to remove ambiguity	2017-12-01 11:57:53 +01:00
templates	Revert "Add files/lines by extension by date"	2017-11-28 16:25:42 +01:00
.gitignore	Ignore rvm or rbenv related dotfiles.	2013-08-15 12:51:11 +02:00
.gitmodules	Implement git statistics on git trees (directories)	2014-03-30 08:01:39 +02:00
.rspec	lazy loading and firsts tests	2012-10-12 18:20:07 +02:00
.travis.yml	Update ruby version used on Travis CI	2018-01-09 11:52:15 +08:00
Gemfile	Using semantic versioning for dependencies	2017-12-01 12:18:28 +01:00
git_stats.gemspec	Using semantic versioning for dependencies	2017-12-01 12:18:28 +01:00
LICENSE.txt	initial gem	2012-10-08 17:11:11 +02:00
Rakefile	spec is a default rake task	2012-10-23 21:57:27 +02:00
README.md	Add missing library on install	2019-02-18 15:56:19 +01:00

README.md

GitStats

GitStats is a git repository statistics generator. It browses the repository and outputs html page with statistics.

Examples

Installation

Existing ruby/gem environment

$ gem install git_stats

debian stretch (9.*)

# apt-get install ruby ruby-nokogiri ruby-nokogiri-diff ruby-nokogumbo
# gem install git_stats

Ubuntu

$ sudo apt-get install ruby ruby-dev gcc zlib1g-dev make
$ sudo gem install git_stats

Usage

Generator

Print help

$ git_stats
Commands:
  git_stats generate        # Generates the statistics of a repository
  git_stats help [COMMAND]  # Describe available commands or one specific command

Print help of the generate command

$ git_stats help generate
Usage:
  git_stats generate

Options:
  p, [--path=PATH]                          # Path to repository from which statistics should be generated.
                                            # Default: .
  o, [--out-path=OUT_PATH]                  # Output path where statistics should be written.
                                            # Default: ./git_stats
  l, [--language=LANGUAGE]                  # Language of written statistics.
                                            # Default: en
  f, [--first-commit-sha=FIRST_COMMIT_SHA]  # Commit from where statistics should start.
  t, [--last-commit-sha=LAST_COMMIT_SHA]    # Commit where statistics should stop.
                                            # Default: HEAD
  s, [--silent], [--no-silent]              # Silent mode. Don't output anything.
  d, [--tree=TREE]                          # Tree where statistics should be generated.
                                            # Default: .
  c, [--comment-string=COMMENT_STRING]      # The string which is used for comments.
                                            # Default: //

Generates the statistics of a repository

Start generator with default settings

$ git_stats generate
  git rev-list --pretty=format:'%h|%at|%ai|%aE' HEAD | grep -v commit
  git shortlog -se HEAD
  ...

Start generator with some parameters in long and short form.

$ git_stats generate -o stats --langugage de
  git rev-list --pretty=format:'%h|%at|%ai|%aE' HEAD | grep -v commit
  git shortlog -se HEAD
  ...

API usage example

> repo = GitStats::GitData::Repo.new(path: '.', first_commit_sha: 'abcd1234', last_commit_sha: 'HEAD')
> repo.authors
=> [...]
> repo.commits
=> [...]
> commit.files
=> [...]

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
Push to the branch (git push origin my-new-feature)
Create new Pull Request