Skip to content
A generator of RuboCop's custom cops gem.
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Rename custom_cops_generator to rubocop-extension-generator Nov 8, 2019
exe Rename custom_cops_generator to rubocop-extension-generator Nov 8, 2019
lib/rubocop/extension Bump up version to 0.2.1 Nov 23, 2019
smoke
.gitignore The first implementation Sep 3, 2019
CHANGELOG.md Add CHANGELOG Nov 23, 2019
Gemfile Update Rake to v13 Nov 23, 2019
LICENSE Create LICENSE Sep 3, 2019
README.md Mention the smoke test in README Nov 23, 2019
Rakefile bunlde gem Sep 3, 2019
rubocop-extension-generator.gemspec Rename custom_cops_generator to rubocop-extension-generator Nov 8, 2019

README.md

rubocop-extension-generator

A generator of RuboCop's custom cops gem.

Installation

Add this line to your application's Gemfile:

gem 'rubocop-extension-generator'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rubocop-extension-generator

Usage

$ rubocop-extension-generator rubocop-foobar
Creating gem 'rubocop-foobar'...
      create  rubocop-foobar/Gemfile
      create  rubocop-foobar/lib/rubocop/foobar.rb
      create  rubocop-foobar/lib/rubocop/foobar/version.rb
      create  rubocop-foobar/rubocop-foobar.gemspec
      create  rubocop-foobar/Rakefile
      create  rubocop-foobar/README.md
      create  rubocop-foobar/bin/console
      create  rubocop-foobar/bin/setup
      create  rubocop-foobar/.gitignore
Initializing git repo in /tmp/tmp.Gu7G94wX00/rubocop-foobar
Gem 'rubocop-foobar' was successfully created. For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html
create rubocop-foobar/lib/rubocop-foobar.rb
create rubocop-foobar/lib/rubocop/foobar/inject.rb
create rubocop-foobar/lib/rubocop/cop/foobar_cops.rb
create rubocop-foobar/config/default.yml
create rubocop-foobar/spec/spec_helper.rb
create rubocop-foobar/.rspec
update lib/rubocop/foobar.rb
update lib/rubocop/foobar.rb
update lib/rubocop/foobar/version.rb
update rubocop-foobar.gemspec
update rubocop-foobar.gemspec
update Rakefile
update Gemfile

It's done! You can start developing a new extension of RuboCop in rubocop-foobar.
For the next step, you can use the cop generator.

  $ bundle exec rake 'new_cop[Foobar/SuperCoolCopName]'

Development

After checking out the repo, run bin/setup to install dependencies. 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 version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Testing

You can execute a smoke test with ruby smoke/smoke.rb. Check it is success before open a pull request.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop-hq/rubocop-extension-generator.

You can’t perform that action at this time.