Skip to content
This repository was archived by the owner on Apr 10, 2025. It is now read-only.

wealthsimple/rubocop-vendor

Repository files navigation

rubocop-vendor

Gem Version GitHub Actions Badge

Vendor integration analysis for your projects, as an extension to RuboCop.

Installation

Just install the rubocop-vendor gem

gem install rubocop-vendor

or if you use bundler put this in your Gemfile

gem 'rubocop-vendor'

Usage

You need to tell RuboCop to load the Vendor extension. There are three ways to do this:

RuboCop configuration file

Put this into your .rubocop.yml.

plugins:
 - rubocop-vendor

Now you can run rubocop and it will automatically load the RuboCop Vendor cops together with the standard cops.

Command line

rubocop --require rubocop-vendor

Rake task

RuboCop::RakeTask.new do |task|
  task.requires << 'rubocop-vendor'
end

The Cops

All cops are located under lib/rubocop/cop/vendor, and contain examples/documentation.

In your .rubocop.yml, you may treat the Vendor cops just like any other cop. For example:

Vendor/RollbarLogger:
  Exclude:
    - lib/example.rb

Contributing

Checkout the contribution guidelines.

License

rubocop-vendor is MIT licensed. See the accompanying file for the full text.

About

An extension of RuboCop focused on vendor integration checks.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages