Rubocop extension for enforcing graphql-ruby best practices.
Install the gem:
gem install rubocop-graphql
If you use bundler put this in your Gemfile:
gem 'rubocop-graphql', require: false
You need to tell RuboCop to load the GraphQL extension. There are three ways to do this:
RuboCop configuration file
Put this into your
Alternatively, use the following array notation when specifying multiple extensions.
require: - rubocop-other-extension - rubocop-graphql
Now you can run
rubocop and it will automatically load the RuboCop GraphQL cops together with the standard cops.
rubocop --require rubocop-graphql
RuboCop::RakeTask.new do |task| task.requires << 'rubocop-graphql' end
All cops are located under
lib/rubocop/cop/graphql, and contain examples and documentation.
.rubocop.yml, you may treat the GraphQL cops just like any other cop. For example:
GraphQL/ResolverMethodLength: Max: 3
Initially sponsored by Evil Martians.
Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/rubocop-graphql.
The gem is available as open source under the terms of the MIT License.