README.md in rubocop-ruby2_7-1.0.2 vs README.md in rubocop-ruby2_7-1.0.3

- old
+ new

@@ -1,20 +1,20 @@ <p align="center"> <a href="https://rubocop.org#gh-light-mode-only" target="_blank" rel="noopener"> - <img width="120px" src="https://github.com/rubocop-semver/rubocop-ruby2_7/raw/main/docs/images/logo/rubocop-light.svg?raw=true" alt="PNG Rubocop Logo, Copyright (c) 2014 Bozhidar Batsov, MIT License, SVG Rubocop Logo, Gil Barbara, CC0"> + <img height="120px" src="https://github.com/rubocop-lts/rubocop-ruby2_7/raw/main/docs/images/logo/rubocop-light.svg?raw=true" alt="SVG RuboCop Logo, Copyright (c) 2014 Dimiter Petrov, CC BY-NC 4.0, see docs/images/logo/README.txt"> </a> <a href="https://rubocop.org#gh-dark-mode-only" target="_blank" rel="noopener"> - <img width="120px" src="https://github.com/rubocop-semver/rubocop-ruby2_7/raw/main/docs/images/logo/rubocop-dark.svg?raw=true" alt="SVG Rubocop Logo, Copyright (c) 2014 Bozhidar Batsov, MIT License, SVG Rubocop Logo, Roberto Huertas, MIT"> + <img height="120px" src="https://github.com/rubocop-lts/rubocop-ruby2_7/raw/main/docs/images/logo/rubocop-dark.svg?raw=true" alt="SVG RuboCop Logo, Copyright (c) 2014 Dimiter Petrov, CC BY-NC 4.0, see docs/images/logo/README.txt"> </a> <a href="https://www.ruby-lang.org/" target="_blank" rel="noopener"> - <img width="120px" src="https://github.com/rubocop-semver/rubocop-ruby2_7/raw/main/docs/images/logo/ruby-logo.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5"> + <img height="120px" src="https://github.com/rubocop-lts/rubocop-ruby2_7/raw/main/docs/images/logo/ruby-logo.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5, see docs/images/logo/README.txt"> </a> <a href="https://semver.org/#gh-light-mode-only" target="_blank" rel="noopener"> - <img width="120px" src="https://github.com/rubocop-semver/rubocop-ruby2_7/raw/main/docs/images/logo/semver-light.svg?raw=true" alt="SemVer.org Logo by @maxhaz"> + <img height="120px" src="https://github.com/rubocop-lts/rubocop-ruby2_7/raw/main/docs/images/logo/semver-light.svg?raw=true" alt="SemVer.org Logo by @maxhaz, see docs/images/logo/README.txt"> </a> <a href="https://semver.org/#gh-dark-mode-only" target="_blank" rel="noopener"> - <img width="120px" src="https://github.com/rubocop-semver/rubocop-ruby2_7/raw/main/docs/images/logo/semver-dark.svg?raw=true" alt="SemVer.org Logo by @maxhaz"> + <img height="120px" src="https://github.com/rubocop-lts/rubocop-ruby2_7/raw/main/docs/images/logo/semver-dark.svg?raw=true" alt="SemVer.org Logo by @maxhaz, see docs/images/logo/README.txt"> </a> </p> # Rubocop::Ruby27 @@ -29,37 +29,74 @@ found this project their reasons likely weigh less, in your context (e.g. running `rubocop` from command line), than what brought you here. <p align="left"> <a href="https://metaredux.com/posts/2022/04/21/rubocop-turns-10.html" target="_blank" rel="noopener"> - <img width="360px" src="https://github.com/rubocop-semver/rubocop-ruby2_7/raw/main/docs/images/rubocop-not-semver.png?raw=true" alt="Explanation of non-SemVer compliance, @bbatsov"> + <img width="360px" src="https://github.com/rubocop-lts/rubocop-ruby2_7/raw/main/docs/images/rubocop-not-semver.png?raw=true" alt="Explanation of non-SemVer compliance, @bbatsov"> </a> </p> The purpose of this gem is to constrain the `rubocop` dependency of a project in a [SemVer compliant](https://semver.org/) (Semantic Versioning) way that aligns with the the desired minimum compatible/supported Ruby version. +## Ruby Version Support Matrix + 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](https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/compatibility.adoc#support-matrix) (Rubocop documentation) +official [compatibility matrix][rubocop-matrix] for `rubocop`. -## Stable +`rubocop-ruby2_7` (this gem) will install on any version of Ruby >= 2.7, and can be used to analyze code intended to support Ruby >= 2.7. +* 🧊 - Install on Ruby `<version>` +* 🏃‍ - Will Execute on Ruby `<version>` +* 🪷 - Will not execute correctly on Ruby `<version>` +* 🛠 - Lint code with Ruby `<version>` syntax as the target + +| gem | 1.8.7 | 1.9.3 | 2.0 | 2.1 | 2.2 | 2.3 | 2.4 | 2.5 | 2.6 | 2.7 | 3.0 | 3.1 | ruby-head | jruby-head | +|-------------------------|---------------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|------------| +| [rubocop-ruby1_9][rr19] | [🛠][what1_8] | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | +| [rubocop-ruby2_0][rr20] | | | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | +| [rubocop-ruby2_1][rr21] | | | | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | +| [rubocop-ruby2_2][rr22] | | | | | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊‍ 🪷 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | +| [rubocop-ruby2_3][rr23] | | | | | | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | +| [rubocop-ruby2_4][rr24] | | | | | | | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | +| [rubocop-ruby2_5][rr25] | | | | | | | | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | +| [rubocop-ruby2_6][rr26] | | | | | | | | 🛠 | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🪷 | +| [rubocop-ruby2_7][rr27] | | | | | | | | 🛠 | 🛠 | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | +| [rubocop-ruby3_0][rr30] | | | | | | | | 🛠 | 🛠 | 🛠 | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | 🧊 🏃‍ | +| [rubocop-ruby3_1][rr31] | | | | | | | | 🛠 | 🛠 | 🛠 | 🛠 | 🧊 🏃‍ 🛠 | 🧊 🏃‍ | 🧊 🏃‍ | + +[rr19]: https://github.com/rubocop-lts/rubocop-ruby1_9 +[rr20]: https://github.com/rubocop-lts/rubocop-ruby2_0 +[rr21]: https://github.com/rubocop-lts/rubocop-ruby2_1 +[rr22]: https://github.com/rubocop-lts/rubocop-ruby2_2 +[rr23]: https://github.com/rubocop-lts/rubocop-ruby2_3 +[rr24]: https://github.com/rubocop-lts/rubocop-ruby2_4 +[rr25]: https://github.com/rubocop-lts/rubocop-ruby2_5 +[rr26]: https://github.com/rubocop-lts/rubocop-ruby2_6 +[rr27]: https://github.com/rubocop-lts/rubocop-ruby2_7 +[rr30]: https://github.com/rubocop-lts/rubocop-ruby3_0 +[rr31]: https://github.com/rubocop-lts/rubocop-ruby3_1 +[what1_8]: https://github.com/rubocop-lts/rubocop-ruby1_9#what-about-ruby-18 +[rubocop-matrix]: https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/compatibility.adoc#support-matrix + +## 🗿 Stable + All releases of this gem are stable releases. The first version is `1.0.0`. -## Installation +## ✨ Installation Install the gem and add to the application's Gemfile by executing: $ bundle add rubocop-ruby2_7 -r false If bundler is not being used to manage dependencies, install the gem by executing: $ gem install rubocop-ruby2_7 -## Usage +## 🔧 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: @@ -77,37 +114,37 @@ NewCops: enable ``` Let's talk about these settings. -## TargetRubyVersion +### 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 +### 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`](https://github.com/rubocop/rubocop/issues/5953#issuecomment-805921993)). Accepting new cops arriving in a new version of Rubocop can feel risky, especially when it doesn't follow SemVer. +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`](https://github.com/rubocop/rubocop/issues/5953#issuecomment-805921993)). 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(r)! If you use a dependency greening tool like GitHub's `dependabot`, or the excellent alternatives [depfu](https://depfu.com/), and [`renovate`](https://www.whitesourcesoftware.com/free-developer-tools/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](https://rubygems.org). -## Contributing +## ⚡️ Contributing See [CONTRIBUTING.md][contributing] -## Contributors +## 🌈 Contributors -[![Contributors](https://contrib.rocks/image?repo=rubocop-semver/rubocop-ruby2_7)]("https://github.com/rubocop-semver/rubocop-ruby2_7/graphs/contributors") +[![Contributors](https://contrib.rocks/image?repo=rubocop-lts/rubocop-ruby2_7)]("https://github.com/rubocop-lts/rubocop-ruby2_7/graphs/contributors") Made with [contributors-img](https://contrib.rocks). -## License +## 📄 License The gem is available as open source under the terms of the [MIT License][license] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref]. See [LICENSE][license] for the official [Copyright Notice][copyright-notice-explainer]. @@ -123,26 +160,26 @@ Author: [Yusuf Evli][org-logo-author] Source: [Unsplash][org-logo-source] License: [Unsplash License][org-logo-license] </details> -[project-logos]: https://github.com/rubocop-semver/rubocop-ruby2_7/blob/main/docs/images/logo/README.txt +[project-logos]: https://github.com/rubocop-lts/rubocop-ruby2_7/blob/main/docs/images/logo/README.txt [org-logo-author]: https://unsplash.com/@yusufevli [org-logo-source]: https://unsplash.com/photos/yaSLNLtKRIU [org-logo-license]: https://unsplash.com/license -### Copyright +### © Copyright * Copyright (c) 2022 [Peter H. Boling][peterboling] of [Rails Bling][railsbling] [copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year -## Code of Conduct +## 🤝 Code of Conduct -Everyone interacting in the Rubocop::Ruby27 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubocop-semver/rubocop-ruby2_7/blob/main/CODE_OF_CONDUCT.md). +Everyone interacting in the Rubocop::Ruby27 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubocop-lts/rubocop-ruby2_7/blob/main/CODE_OF_CONDUCT.md). -## Versioning +## 📌 Versioning This library aims to adhere to [Semantic Versioning 2.0.0][semver]. 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. @@ -156,19 +193,19 @@ spec.add_dependency "rubocop-ruby2_7", "~> 1.0" ``` [copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year -[gh_discussions]: https://github.com/rubocop-semver/rubocop-ruby2_7/discussions +[gh_discussions]: https://github.com/rubocop-lts/rubocop-ruby2_7/discussions -[conduct]: https://github.com/rubocop-semver/rubocop-ruby2_7/blob/main/CODE_OF_CONDUCT.md +[conduct]: https://github.com/rubocop-lts/rubocop-ruby2_7/blob/main/CODE_OF_CONDUCT.md -[contributing]: https://github.com/rubocop-semver/rubocop-ruby2_7/blob/main/CONTRIBUTING.md +[contributing]: https://github.com/rubocop-lts/rubocop-ruby2_7/blob/main/CONTRIBUTING.md -[security]: https://github.com/rubocop-semver/rubocop-ruby2_7/blob/main/SECURITY.md +[security]: https://github.com/rubocop-lts/rubocop-ruby2_7/blob/main/SECURITY.md -[license]: https://github.com/rubocop-semver/rubocop-ruby2_7/blob/main/LICENSE.txt +[license]: https://github.com/rubocop-lts/rubocop-ruby2_7/blob/main/LICENSE.txt [license-ref]: https://opensource.org/licenses/MIT [semver]: http://semver.org/ @@ -188,30 +225,30 @@ [tweetme]: http://twitter.com/galtzo [politicme]: https://nationalprogressiveparty.org -[documentation]: https://rubydoc.info/github/rubocop-semver/rubocop-ruby2_7/main +[documentation]: https://rubydoc.info/github/rubocop-lts/rubocop-ruby2_7/main -[source]: https://github.com/rubocop-semver/rubocop-ruby2_7/ +[source]: https://github.com/rubocop-lts/rubocop-ruby2_7/ -[actions]: https://github.com/rubocop-semver/rubocop-ruby2_7/actions +[actions]: https://github.com/rubocop-lts/rubocop-ruby2_7/actions -[issues]: https://github.com/rubocop-semver/rubocop-ruby2_7/issues +[issues]: https://github.com/rubocop-lts/rubocop-ruby2_7/issues -[climate_maintainability]: https://codeclimate.com/github/rubocop-semver/rubocop-ruby2_7/maintainability +[climate_maintainability]: https://codeclimate.com/github/rubocop-lts/rubocop-ruby2_7/maintainability -[climate_coverage]: https://codeclimate.com/github/rubocop-semver/rubocop-ruby2_7/test_coverage +[climate_coverage]: https://codeclimate.com/github/rubocop-lts/rubocop-ruby2_7/test_coverage -[codecov_coverage]: https://codecov.io/gh/rubocop-semver/rubocop-ruby2_7 +[codecov_coverage]: https://codecov.io/gh/rubocop-lts/rubocop-ruby2_7 -[code_triage]: https://www.codetriage.com/rubocop-semver/rubocop-ruby2_7 +[code_triage]: https://www.codetriage.com/rubocop-lts/rubocop-ruby2_7 [blogpage]: http://www.railsbling.com/tags/rubocop-ruby2_7/ [rubygems]: https://rubygems.org/gems/rubocop-ruby2_7 -[chat]: https://gitter.im/rubocop-semver/rubocop-ruby2_7?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[chat]: https://gitter.im/rubocop-lts/rubocop-ruby2_7?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [maintenancee_policy]: https://guides.rubyonrails.org/maintenance_policy.html#security-issues [liberapay_donate]: https://liberapay.com/pboling/donate