Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 1.08 KB

README.md

File metadata and controls

42 lines (23 loc) · 1.08 KB

Kolekti

Code Climate

Kolekti is a code metric results parser framework. You can use it whenever you want structured unique output for different metric collectors.

Contributing

Please, have a look the wiki pages about development workflow and code standards:

Installation

Add this line to your application's Gemfile:

gem 'kolekti'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kolekti

Usage

You have one key class you need to extend Kolekti::Collector implementing the following methods:

  • collect_metrics(code_directory, wanted_metric_configurations)
  • clean(code_directory, wanted_metric_configurations)
  • default_value_from(metric_configuration)

Actual examples are:

Versioning

Kolekti follows the semantic versioning policy.