RuboCop Yardoc

A RuboCop plugin to lint documentation comments in Ruby files.

Community

• Matrix chatroom

Documentation

• Community-related:
  • Code of conduct
• Development-related:
  • Contribution guide
  • This file
• Provided cops: For now, refer to examples in lib/rubocop/cop/yardoc/*.

Todo : Gitlab pages with cop documentation, Markdown cop documentation from sources.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add rubocop-yardoc

If bundler is not being used to manage dependencies, install the gem by executing:

gem install rubocop-yardoc

Usage

Add rubocop-yardoc to the plugins list in the RuboCop configuration:

# .rubocop.yml
plugins:
  - rubocop-yardoc

Then, run RuboCop as usual.

Cops

TODO

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in lib/rubocop/yardoc/version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/experimentslabs/rubocop-yardoc.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the RuboCop Yardoc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.