Skip to content

Commit

Permalink
Tweak docs about target Ruby version
Browse files Browse the repository at this point in the history
Follow up #10632 (comment).

RuboCop targets Ruby 2.0+ code analysis since RuboCop 1.30.
This PR tweaks docs about target Ruby version.

NOTE: Ruby 1.9 code analysis is not restored because its some incompatibilities with
Ruby 2.0+ cops. It may not be worth the maintenance cost.
  • Loading branch information
koic authored and bbatsov committed May 30, 2022
1 parent 9476274 commit 15908eb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -73,11 +73,13 @@ You can read a lot more about RuboCop in its [official docs](https://docs.ruboco

## Compatibility

RuboCop officially supports the following Ruby implementations:
RuboCop officially supports the following runtime Ruby implementations:

* MRI 2.6+
* JRuby 9.3+

Targets Ruby 2.0+ code analysis.

See the [compatibility documentation](https://docs.rubocop.org/rubocop/compatibility.html) for further details.

## Readme Badge
Expand Down
10 changes: 6 additions & 4 deletions docs/modules/ROOT/pages/compatibility.adoc
@@ -1,8 +1,8 @@
= Compatibility

RuboCop targets Ruby 2.6+.footnote:[As defined by its reference implementation MRI.]
RuboCop targets Ruby 2.0+ code analysis.footnote:[As defined by its reference implementation MRI.]

RuboCop officially supports MRI (a.k.a. CRuby) and JRuby.
RuboCop officially runtime supports MRI (a.k.a. CRuby) and JRuby.

- MRI 2.6+
- JRuby 9.3+
Expand All @@ -16,10 +16,10 @@ NOTE: RuboCop might be working with other Ruby implementations as well, but it's
RuboCop generally aims to follow MRI's own support policy - meaning RuboCop would support all officially supported MRI releases.footnote:[Typically the last 3 releases.] To give people extra time for a smooth transition, we've customarily provided support for about one year after EOL of MRI version.
This means that if Ruby 2.6 reaches its EOL in Spring 2022, it would be supported by RuboCop (at least) until Spring 2023.footnote:[At the core team's discretion this policy might be waived aside for MRI releases causing significant maintenance overhead.]

The following table is the support matrix.
The following table is the runtime support matrix.

|===
| Supported target Ruby version | Last supported RuboCop version
| Supported runtime Ruby version | Last supported RuboCop version

| 1.9 | 0.41
| 2.0 | 0.50
Expand All @@ -35,6 +35,8 @@ The following table is the support matrix.
| 3.2 (experimental) | -
|===

Targets Ruby 2.0+ code analysis since RuboCop 1.30. It restored code analysis that was unsupported with EOL of runtime Ruby version.

NOTE: The compatibility xref:configuration.adoc#setting-the-target-ruby-version[target Ruby version mentioned here] is about code analysis (what RuboCop can analyze), not runtime (is RuboCop capable of running on some Ruby or not).

== Forward Compatibility
Expand Down

0 comments on commit 15908eb

Please sign in to comment.