No commit activity in last 3 years
No release in over 3 years
Code style checking for dependencies control. A plugin for the RuboCop code style enforcing & linting tool.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

Rubocop::Dependency

Coverage Status

Code style checking for dependencies control, as an extension to RuboCop.

Installation

Add this line to your application's Gemfile:

gem 'rubocop-dependency', require: false

Usage

Put this into your .rubocop.yml.

require: rubocop-dependency

Cops

Dependency/OverBoundary

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

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/keik/rubocop-dependency.