mirror of https://github.com/tomgi/git_stats.git synced 2024-12-22 13:32:17 +01:00

GitStats is a git repository statistics generator.

Find a file

Stephan Esch c2a0e0bafe Added command line option (‚comment‘) for the comment string; default is ‚///‚		2013-11-19 17:08:57 +01:00
bin	Modified the cli to base on thor gem.	2013-08-15 22:02:25 +02:00
config/locales	Added comment stats. Only lines beginning with three slashes are counted, since these stats should reflect comments used for documentation, not inline explanations.	2013-11-17 22:39:00 +01:00
lib	Added command line option (‚comment‘) for the comment string; default is ‚///‚	2013-11-19 17:08:57 +01:00
spec	tests fixed	2013-08-09 15:29:41 +02:00
templates	Added comment stats. Only lines beginning with three slashes are counted, since these stats should reflect comments used for documentation, not inline explanations.	2013-11-17 22:39:00 +01:00
.gitignore	Ignore rvm or rbenv related dotfiles.	2013-08-15 12:51:11 +02:00
.gitmodules	public submodule path	2012-10-23 21:38:15 +02:00
.rspec	lazy loading and firsts tests	2012-10-12 18:20:07 +02:00
Gemfile	using my version of lazy_high_charts	2012-10-22 20:57:24 +02:00
git_stats.gemspec	minimum dependencies requirements	2013-08-22 18:41:35 +02: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	Added silent option.	2013-08-27 17:29:51 +02:00

README.md

GitStats

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

Examples

Installation

$ 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, [--output=OUTPUT]      # Output path where statistics should be written.
                            # Default: ./git_stats
  l, [--language=LANGUAGE]  # Language of written statistics.
                            # Default: en
  f, [--from=FROM]          # Commit from where statistics should start.
  t, [--to=TO]              # Commit where statistics should stop.
                            # Default: HEAD
  s, [--silent]             # Silent mode. Don't output anything.

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