Merge pull request #608 from ksss/rubocop-on-rbs

Introduce rubocop-on-rbs

.github/workflows/rubocop.yml

@@ -0,0 +1,22 @@
+name: RuboCop
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+    - name: 'Install dependencies'
+      run: 'bundle install'
+    - name: 'Run RuboCop'
+      run: 'bundle exec rubocop --format github'

.rubocop.yml

@@ -0,0 +1,30 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+require:
+  - rubocop-on-rbs
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: disable
+  DisabledByDefault: true
+  Exclude:
+    - "**/Steepfile"
+    - "**/*.rb"
+    - "**/vendor/**/*"
+
+RBS:
+  Enabled: true
+RBS/Layout:
+  Enabled: false
+RBS/Lint:
+  Enabled: false
+RBS/Style:
+  Enabled: false

Gemfile

@@ -4,3 +4,4 @@ gem "rbs"
 gem "steep"
 gem "typeprof"
 gem "rake"
+gem 'rubocop-on-rbs'

Gemfile.lock

@@ -30,6 +30,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.6.1)
     minitest (5.25.1)
+    parallel (1.26.3)
     parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
@@ -41,6 +42,24 @@ GEM
       ffi (~> 1.0)
     rbs (3.6.1)
       logger
+    regexp_parser (2.9.2)
+    rubocop (1.67.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-on-rbs (1.1.0)
+      rbs (~> 3.5)
+      rubocop (~> 1.61)
+      zlib
+    ruby-progressbar (1.13.0)
     securerandom (0.3.1)
     steep (1.8.3)
       activesupport (>= 5.1)
@@ -65,13 +84,15 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.6.0)
+    zlib (3.1.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   rake
   rbs
+  rubocop-on-rbs
   steep
   typeprof
 

bin/init_new_gem

@@ -75,6 +75,28 @@ put base / 'manifest.yaml', <<~'YAML'
   #   - name: pathname
 YAML
 
+put base.parent / '.rubocop.yml', <<~'YAML'
+  # This configuration inherits from /.rubocop.yml.
+  # You can configure RBS style of this gem.
+  # This file is used on CI. It is configured to automatically
+  # make rubocop suggestions on pull requests for this gem.
+  # If you do not like the style enforcement, you should remove this file.
+  inherit_from: ../../.rubocop.yml
+
+  ##
+  # If you want to customize the style, please consult with the gem reviewers.
+  # You can see the list of cops at https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages/cops.adoc
+
+  RBS/Layout:
+    Enabled: true
+
+  RBS/Lint:
+    Enabled: true
+
+  RBS/Style:
+    Enabled: true
+YAML
+
 if github_account
   github_account = github_account.sub('@', '')
   put base.parent / '_reviewers.yaml', <<~YAML