Ruboguide is Researchable's gem to standardize rubocop configuration, to achieve a uniform style on all ruby projects.
Add the following to your Gemfile:
gem 'ruboguide', git: 'https://gitlab.com/researchable/general/gems/ruboguide'
If you already have rubocop installed, remove it. This gem already installs rubocop for you (and ensures all projects use the same version of rubocop).
Edit your rubocop.yml to include the following:
inherit_gem:
ruboguide:
- styles/rubocop.yml
If your project is a rails project you should instead add:
inherit_gem:
ruboguide:
- styles/rubocop-rails.yml
This gem gives you rubocop. To lint your codebase, call it the way you normally would e.g.:
rubocop -a
To run linting on CI using this gem, you can use the CI template available on the templates/gitlab/base repository
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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.
The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that ruboguide demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.