Introduce rubocop-on-rbs

[ksss]

Introduce rubocop-on-rbs
Implements of #601

As an introduction, we automated the pointing out by rubocop-on-rbs to activesupport.

.rubocop.yml

Root

I have included common settings in the project root .rubocop.yml, but disabled all Cop.

Each gems

I have enabled RBS/Layout and RBS/Lint only in activesupport.
With other gems, rubocop detection does not work depending on the route configuration.
This means that the owner of the gem can optionally set .rubocop.yml to enable the check.

CI

By running RuboCop in CI, automatic feedback can be displayed on PRs. This frees reviewers from pointing out trivial issues and allows them to focus on essential reviews.

Operation check

You can see that RBS/Layout is enabled and RBS/Style is not.

When Updating rubocop-on-rbs

When New Cops Are Added via gem Update

New Cops are disabled by default. There is no burden from the gem update. If you want to enable new Cops, you need to do so for each gem.

When the Behavior of Existing Cops Changes

You need to make sure that RuboCop passes for all gems (this is assumed to be a rare case).

When Adding a New gem

Use init_new_gem to add a .rubocop.yml file. If unnecessary, simply delete this file. This file enables most Cops by default.

[github-actions]

@ksss Thanks for your contribution!

Please follow the instructions below for each change.
See also: https://github.com/ruby/gem_rbs_collection/blob/main/docs/CONTRIBUTING.md

Available commands

You can use the following commands by commenting on this PR.

• /merge: Merge this PR if CI passes

---

activesupport

You changed RBS files for an existing gem.
You can merge this PR yourself because you are a reviewer of this gem.
Just comment /merge to merge this PR.

You can also request a review from other reviewers if you want.

---

You changed non-gem files.

@pocke, please review and approve the changes.

[pocke]

Thanks for your pull request.

Decreasing development speed is my main concern when introducing RuboCop. But probably this opt-in approach can reduce the negative impact because RuboCop is enabled only for maintainer who want to use it.

By the way, we can probably update the init_new_gem script to create a boilerplate of .rubocop.yml.

[ksss]

@pocke Good idea. I updated init_new_gem.
And to facilitate the update of rubocop-on-rbs, I have rewritten the settings on a per-cop basis.

[ksss]

@pocke
I also thought about the operation of updating rubocop-on-rbs.
Do you have any concerns?

[ksss]

@pocke
Are you positive or negative about this change?
I would like to hear your opinion.

[pocke]

I think it is not a good idea to list all cops in this file, because we need to update this script manually when the gem is updated.
How about writing a link to the documentation of the cops list instead of listing all cops here?

[ksss]

I was concerned about the cost of increasing the version of rubocop-on-rbs.

In rubocop, new cop is supposed to warn with Enabled: pending. We decided to solve the problem by doing this operation in rubocop-on-rbs as well.
https://docs.rubocop.org/rubocop/versioning.html#pending-cops

[pocke]

Sorry for the late reply. I think this approach is good for us. But I left a code comment, please check it.

[ksss]

I have corrected the points raised.
Also, changes to activesupport were rescinded to simplify the PR.

[pocke]

Let me confirm this configuration. Is this configuration for the RBS department necessary?
I guess we can simply remove these lines because DisabledByDefault: true is configured.

[ksss]

We can remove the RBS department at here.
But we will have to set Enabled: true for the RBS department in the .rubocop.yml under all gems.