Code style checking for dependencies control, as an extension to RuboCop.
Add this line to your application's Gemfile:
gem 'rubocop-dependency', require: false
Put this into your .rubocop.yml.
require: rubocop-dependency
Check not to refer constants over dependency boundaries which given from Rules
config.
When the following Rules
is given,
Rules: # Array of each rules
- BannedConsts: Foo # Array<String> | String.
FromNamespacePatterns: # Array<String> | String. This value is used as Regexp pattern.
- \ABar(\W|\z)
The following code is considered problems.
class Bar
Foo
^^^ Const `Foo` cannot use from namespace `Bar`.
end
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 the created tag, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/keik/rubocop-dependency.