mdeering / guard-yardstick

guard-yardstick will automatically check your code for missing yardocs

guard-yardstick

guard-yardstick will automatically check your code for missing yardocs

Installation

Add guard-yardstick to your Gemfile:

group :development do
  gem 'guard-yardstick'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install guard-yardstick

Usage

After correctly installing the gem initialize your Guardfile as follows.

$ bundle exec guard init yardstick

Please read the Guard usage documentation for further details.

Options

all_on_start: Same as on any other Guard plugin. Run yardstick on all files on start or not.

path: Tells yardstick which paths to run the yardoc analysis on. Defaults to yardsticks default of 'lib' directory.

guard :yardstick, all_on_start: false, path: ['app', 'config', 'lib'] do
  # ...
end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request