Mirror/git_stats
1
0
Fork 0
mirror of https://github.com/tomgi/git_stats.git synced 2024-12-22 13:32:17 +01:00
Code Issues Projects Releases Packages Wiki Activity
GitStats is a git repository statistics generator.
123 commits 2 branches 14 tags 38 MiB
Ruby 70.8%
Haml 14.8%
JavaScript 14.3%
Find a file
Nick Brown 8f67bcdc64 Add commit range to the CLI 
This adds 4th and 5th optional CLI parameters that specifies the first
and last SHA commit to generate stats between.
The generator and repo classes were changed to take these as
initialisation parameters.
It would be nice to have the CLI take individual named optional
parameters, so that only first or last commit could be given and
without having to give the language.
2013-04-03 12:35:12 +01:00
bin activity fix and tests 2012-10-13 11:49:02 +02:00
config/locales #6 Show Lines For Any User 2013-02-21 11:15:58 +01:00
lib Add commit range to the CLI 2013-04-03 12:35:12 +01:00
spec will create output directory if doesn't exist 2012-11-01 18:23:44 +01:00
templates #6 Show Lines For Any User 2013-02-21 11:15:58 +01:00
.gitignore gem description 2012-10-08 17:15:29 +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 using official lazy_high_charts version 2013-02-05 15:40:26 +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 commit range to the CLI 2013-04-03 12:35:12 +01:00

README.md

GitStats Build Status Build Status

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

$ git_stats repo_path output_directory language_code first_commit_sha last_commit_sha 
$ favorite_browser output_directory/index.html

API usage example

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

Contributing

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