0.0
The project is in a healthy, maintained state
Rubocop LTS - Chaos Reduction In a Bottle
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Runtime

 Project Readme

SVG RuboCop Logo, Copyright (c) 2014 Dimiter Petrov, CC BY-NC 4.0, see docs/images/logo/README.txt SVG RuboCop Logo, Copyright (c) 2014 Dimiter Petrov, CC BY-NC 4.0, see docs/images/logo/README.txt Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5, see docs/images/logo/README.txt SemVer.org Logo by @maxhaz, see docs/images/logo/README.txt SemVer.org Logo by @maxhaz, see docs/images/logo/README.txt

RuboCop LTS

PROJECT DOCUMENTATION

This README

  • 🌳 This Branch
  • ‍💻 Project Health
  • ✨ Installation

This Branch 🌳

This README is for the even release of rubocop-lts supporting Ruby >= 3.1.0.

Project Health 👩‍💻

Gem Name Version Downloads CI Activity
rubocop-lts Gem Version Total DL DL Rank Current Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby1_9 Gem Version Total DL DL Rank Current Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_0 Gem Version Total DL DL Rank Current Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_1 Gem Version Total DL DL Rank Current Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_2 Gem Version Total DL DL Rank Current Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_3 Gem Version Total DL DL Rank Current Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_4 Gem Version Total DL DL Rank Current Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_5 Gem Version Total DL DL Rank Current Heads Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_6 Gem Version Total DL DL Rank Current Heads Legacy Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby2_7 Gem Version Total DL DL Rank Current Heads Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby3_0 Gem Version Total DL DL Rank Current Heads Open Issues Closed Issues Open PRs Closed PRs
rubocop-ruby3_1 Gem Version Total DL DL Rank Current Heads Open Issues Closed Issues Open PRs Closed PRs

Installation ✨

Without bundler execute:

$ gem install 

Add this line to your application's Gemfile:

gem 'rubocop-lts', '~> 22.0', require: false

And then execute:

$ bundle

Dependabot Noise Reduction

Add the following to .github/dependabot.yml if you use Github Actions.

    ignore:
      - dependency-name: "rubocop-lts"

🔧 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-lts.yml
📼 Supporting Ruby 1.8 Have a library still supporting Ruby 1.8.7, or looking to drop support for Ruby 1.8.7 in a SemVer-compliant manner?
  1. Use rubocop-lts, version 1.x or 2.x
  2. Add the following to your project's .rubocop.yml:
inherit_gem:
  rubocop-lts: rubocop-ruby1_8.yml

Ruby 1.9.3 is supported for installation, and 1.8.7 for syntax.

NOTE: For more on how Ruby 1.8 support works, look here

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.

Git Branch Names

Naming Scheme

"r{{ ruby major }}_{{ ruby minor }}-{{ parity }}-v{{ gem-version }}"
Parity

Even versions use the token even in the branch name. Odd versions use the token odd in the branch name.

Version - Branch Matrix

Ruby Version Parity Gem Version Branch Name Purpose
1.9 odd 1.x r1_9-odd-v1 LTS, trunk, single-ruby-linting
1.9 even 2.x r1_9-even-v2 Upgrade, feat, multi-ruby-linting
2.0 odd 3.x r2_0-odd-v3 LTS, trunk, single-ruby-linting
2.0 even 4.x r2_0-even-v4 Upgrade, feat, multi-ruby-linting
2.1 odd 5.x r2_1-odd-v5 LTS, trunk, single-ruby-linting
2.1 even 6.x r2_1-even-v6 Upgrade, feat, multi-ruby-linting
2.2 odd 7.x r2_2-odd-v7 LTS, trunk, single-ruby-linting
2.2 even 8.x r2_2-even-v8 Upgrade, feat, multi-ruby-linting
2.3 odd 9.x r2_3-odd-v9 LTS, trunk, single-ruby-linting
2.3 even 10.x r2_3-even-v10 Upgrade, feat, multi-ruby-linting
2.4 odd 11.x r2_4-odd-v11 LTS, trunk, single-ruby-linting
2.4 even 12.x r2_4-even-v12 Upgrade, feat, multi-ruby-linting
2.5 odd 13.x r2_5-odd-v13 LTS, trunk, single-ruby-linting
2.5 even 14.x r2_5-even-v14 Upgrade, feat, multi-ruby-linting
2.6 odd 15.x r2_6-odd-v15 LTS, trunk, single-ruby-linting
2.6 even 16.x r2_6-even-v16 Upgrade, feat, multi-ruby-linting
2.7 odd 17.x r2_7-odd-v17 LTS, trunk, single-ruby-linting
2.7 even 18.x r2_7-even-v18 Upgrade, feat, multi-ruby-linting
3.0 odd 19.x r3_0-odd-v19 LTS, trunk, single-ruby-linting
3.0 even 20.x r3_0-even-v20 Upgrade, feat, multi-ruby-linting
3.1 odd 21.x r3_1-odd-v21 LTS, trunk, single-ruby-linting
3.1 even 22.x r3_1-even-v22 Upgrade, feat, multi-ruby-linting
3.2 / ruby-head odd 23.x r3_2-odd-v23 LTS, trunk, single-ruby-linting
3.2 / ruby-head even 24.x r3_2-even-v24 Upgrade, feat, multi-ruby-linting

NOTE: For more on how Ruby 1.8 support works, see above

⚡️ Contributing

See CONTRIBUTING.md

🌈 Contributors

Contributors

Made with contributors-img.

📄 License

The gem is available as open source under the terms of the MIT License License: MIT. See LICENSE for the official Copyright Notice.

Project Logos (rubocop-lts)

See docs/images/logo/README.txt

Organization Logo (rubocop-semver)

Author: Yusuf Evli Source: Unsplash License: Unsplash License

© Copyright

🤝 Code of Conduct

Everyone interacting in RuboCop LTS 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-lts", "~> 22.0"