NOTE: You might be interested in rubocop-lts
which sits as a higher level than this gem, and can keep pace with whatever version of Ruby you happen to be on.
Gem Name | Version | Downloads | CI | Activity |
---|---|---|---|---|
rubocop-lts |
||||
rubocop-ruby3_0 |
Rubocop::Ruby30
See the intro blog post!
This gem requires no other gems. It depends on rubocop
, but does not require 'rubocop'
.
Awareness of rubocop
‘s lack of SemVer adherence isn’t evenly dispersed in the Ruby community.
The RuboCop team has real reasons
for not following SemVer, but if you’ve
found this project their reasons likely weigh less, in your context (e.g. running rubocop
from command line), than
what brought you here.
The purpose of this gem is to constrain the rubocop
dependency of a project in
a SemVer compliant (Semantic Versioning) way that aligns with the the desired minimum
compatible/supported Ruby version.
Ruby Version Support
Adding this gem will facilitate the best practice of adding a ~>
version constrained rubocop
dependency, while
minimizing the risk of a rubocop minor / patch upgrade breaking the build. See the
official compatibility matrix for rubocop
.
Three Guarantees
rubocop-ruby3_0
(this gem) will install a version of rubocop
which will
install on (1), run on (2), and analyze code (3) intended to support any version of Ruby >= 3.0.
Any change to any of those three abilities would require a major version bump.
Each spring rubocop
drops the ability to install and run rubocop
on an EOL’d Ruby.
Eventually rubocop
will drop the ability to analyze code intended to support an EOL’d Ruby,
as they already have for Ruby 1.8 and 1.9.
When the rubocop
team makes any of these changes they typically only bump the minor version of ruby,
in violation of SemVer. This is a primary raison dβΓͺtre for this project.
A Gem Family
The rubocop-lts
series of gems has a version supporting any version of Ruby you need.
They can be used as development dependencies for libraries or applications.
rubocop-ruby1_9
rubocop-ruby2_0
rubocop-ruby2_1
rubocop-ruby2_2
rubocop-ruby2_3
rubocop-ruby2_4
rubocop-ruby2_5
rubocop-ruby2_6
rubocop-ruby2_7
rubocop-ruby3_0
rubocop-ruby3_1
πΏ Stable
All releases of this gem are stable releases.
We do not release new versions for every release of rubocop
.
A typical release cycle for a gem in the rubocop-lts
family is roughly every six months,
though eventually analysis support for an old version of Ruby will be dropped.
When that happens releases of the rubocop-lts
gem for that version of Ruby will (mostly) cease.
β¨ Installation
Install the gem and add to the application’s Gemfile by executing:
$ bundle add rubocop-ruby3_0 -r false
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install rubocop-ruby3_0
π§ Usage
The following is optional. We’ll discuss why you might want to do this after you see what it does.
Add to the top of your project’s .rubocop.yml
configuration file:
inherit_gem: rubocop-ruby3_0: rubocop.yml
This has the same effect as you declaring the following in your .rubocop.yml
:
AllCops: # remove if already present in your `.rubocop.yml` to gain the full benefit of this gem! TargetRubyVersion: 3.0 NewCops: enable
Let’s talk about these settings.
TargetRubyVersion
Allowing this gem to manage the target ruby version means you can switch to a different gem within the family when you upgrade to the next version of Ruby, and have nothing else to change. A single line in the Gemfile
, and you are done.
NewCops: enable
You may not use this setting in your project yet. Upgrades to the latest RuboCop can include all kinds of changes, including removing support for the version of Ruby your project uses, or adding a cop that may not work with some of your syntax (e.g. some use cases of 'module_function`). Accepting new cops arriving in a new version of RuboCop can feel risky, especially when it doesn’t follow SemVer.
But this gem shoehorns rubocop into SemVer… so NewCops
is now safe®! If you use a dependency greening tool like GitHub’s dependabot
, or the excellent alternatives depfu, and renovate
, then you can see the effect of a minor / major version bumpin your CI Build!
Development
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.
β‘οΈ Contributing
See CONTRIBUTING.md
π Contributors
Made with contributors-img.
π License
The gem is available as open source under the terms of
the MIT License .
See LICENSE for the official Copyright Notice.
Project Logos (rubocop-ruby3_0)
See docs/images/logo/README.txt
Organization Logo (rubocop-semver)
Author: Yusuf Evli
Source: Unsplash
License: Unsplash License
Β© Copyright
- Copyright © 2022 Peter H. Boling of Rails Bling
π€ Code of Conduct
Everyone interacting in the Rubocop::Ruby30 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
π Versioning
This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as
bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be
immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new
major versions.
As a result of this policy, you can (and should) specify a dependency on this gem using
the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency "rubocop-ruby3_0", "~> 1.1"