🦾 Standard::Rubocop::Lts

Extended standard (Standard Ruby) config shims for any and every version of Ruby, back to Ruby version 1.8. Enables Ruby projects to more confidently support even the most finely-aged Rubies. Part of the rubocop-lts gem family.

Use the rules standard gives you, and then add more, to increase your code's compatibility across multiple versions of Ruby.

Only reach as far back as you need to go!

The RuboCop LTS family of gems is the distillation of more than 20 years of my own Ruby expertise and source code diving, built on the shoulders of the expertise of many others; organizing that expertise into per-Ruby-version sets of configurations.

Although the situation has improved somewhat, it remains unsafe to upgrade RuboCop, or Standard, in a project that supports EOL Rubies.

I hope it helps others avoid some of the challenges I've had with library maintenance, and supporting decade-old mission-critical applications.

Avoid bike-shedding, use rubocop-lts in every project, and let it manage your linting complexity!

If the rubocop-lts stack of libraries has helped you, or your organization, please support my efforts by making a donation, or becoming a sponsor.

NOTE: You might be interested in rubocop-lts which sits as a higher level than, and depends on, this gem. It will enable your Ruby style rules to keep pace with whatever version of Ruby your project happens to be on!

Gem Name	Version	Downloads	Activity
`rubocop-lts`
`standard-rubocop-lts`

👪 A Gem Family

The rubocop-lts family of gems has a version supporting any version of Ruby you need. They can be used as development dependencies for libraries or applications.

🗿 Stable

All releases of this gem are stable releases. We do not release new versions for every release of rubocop, as this gem is tied to standard (Standard Ruby). 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.

Info you can shake a stick at

Tokens to Remember
Works with MRI Ruby 3.2+
Source
Documentation
Compliance
Expert 1:1 Support	`or`
Enterprise Support	💡Subscribe for support guarantees covering all FLOSS dependencies! 💡Tidelift is part of Sonar! 💡Tidelift pays maintainers to maintain the software you depend on! 📊`@`Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers!
Comrade BDFL 🎖️
`...` 💖

✨ Installation

In case you missed it above - you may be better off not depending on this gem directly. See rubocop-lts which sits as a higher level than, and depends on, this gem. It will enable your Ruby style rules to keep pace with whatever version of Ruby your project happens to be on!

If, OTOH, you want to use this gem directly, carry on!

Install the gem and add to the application's Gemfile by executing:

$ bundle add standard-rubocop-lts

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install standard-rubocop-lts

🔧 Basic Usage

Add to the top of your project's .rubocop.yml configuration file:

inherit_gem:
  # Replace {RUBY_MAJOR_VERSION} with the minimum major version of ruby you want to target.
  # Replace {RUBY_MINOR_VERSION} with the minimum minor version of ruby you want to target.
  standard-rubocop-lts: config/ruby-{RUBY_MAJOR_VERSION}-{RUBY_MINOR_VERSION}.yml

What will this do for me?

Among other settings specific to your chosen minimum version of ruby, the above _effectively_ results in the following config (& more): ```yaml # We want the Exclude and Include directives from different # config files to get merged, not overwritten inherit_mode: merge: - Exclude - Include require: - standard-rubocop-lts - standard - standard-performance - standard-custom - rubocop-performance # Load basic rules for this version of Ruby from standard. # Rules are overridden in a LIFO stack. # If rubocop-performance is listed first, and standard-performance after it, # then rubocop-performance's rules will take precedence. # This is the opposite of what you might expect. # Below: standard's rules override rubocop-performance's (mostly disabling rules) inherit_gem: standard: config/ruby-1.8.yml standard-performance: config/ruby-1.8.yml standard-custom: config/base.yml rubocop-performance: config/default.yml AllCops: NewCops: enable # See: # https://github.com/rubocop/rubocop-performance/issues/240 # https://github.com/rubocop/rubocop-performance/pull/241 Performance/Casecmp: Enabled: false # See: https://github.com/rubocop/rubocop-performance/issues/329#issuecomment-1375527811 Performance/BlockGivenWithExplicitBlock: Enabled: false # See: https://github.com/rubocop/rubocop-performance/issues/329#issuecomment-1451511402 Performance/ArraySemiInfiniteRangeSlice: Enabled: false # See: https://github.com/rubocop/rubocop-performance/issues/329#issuecomment-1451511402 Performance/BigDecimalWithNumericArgument: Enabled: false # See: https://github.com/rubocop/rubocop-performance/issues/329#issuecomment-1451511402 Performance/IoReadlines: Enabled: false # Plus: Ruby-version-specific configs provided by "standard" family of gems # Plus+: Ruby-version-specific configs that standard does not have ```

What about TargetRubyVersion?

**Instead of using this gem, standard-rubocop-lts, use rubocop-lts, which depends on this gem.

# NOTE: Picking the right version of rubocop-lts automatically aligns:
#       - gemspec's required_ruby_version
#       - RuboCop's TargetRubyVersion
# e.g. v24 for Ruby >= 3.2.0
gem "rubocop-lts", "~> 24.0", require: false

💻 Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests w/ coverage, or bin/rake to run tests w/ coverage, and linting. 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.

🚀 Release Instructions

See CONTRIBUTING.md.

🔐 Security

See SECURITY.md.

🤝 Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check TODOs (see below), or check issues, or PRs, or use the gem and think about how it could be better.

We so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

Code Coverage

🪇 Code of Conduct

Everyone interacting in this project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the .

🌈 Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/graphs/main

⭐️ Star History

📌 Versioning

This Library adheres to . 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.

📌 Is "Platform Support" part of the public API?

Yes. But I'm obligated to include notes...

SemVer should, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

dropping support for a platform is both obviously and objectively a breaking change

Jordan Harband (@ljharb) in SemVer issue 716

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

"Major Version Numbers are Not Sacred"

As a result of this policy, and the interpretive lens used by the maintainer, you can (and should) specify a dependency on these libraries using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("standard-rubocop-lts", "~> 2.0")

See CHANGELOG.md for list of releases.

📄 License

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

Project Logos (standard-rubocop-lts)

See [docs/images/logo/README.txt][project-logos]

Organization Logo (rubocop-lts)

- Author: [Yusuf Evli][org-logo-author] - Source: [Unsplash][org-logo-source] - License: [Unsplash License][org-logo-license]

© Copyright

🤑 One more thing

You made it to the bottom of the page, so perhaps you'll indulge me for another 20 seconds. I maintain many dozens of gems, including this one, because I want Ruby to be a great place for people to solve problems, big and small. Please consider supporting my efforts via the giant yellow link below, or one of the others at the head of this README.