rubocop-rbs_inline 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13356ee2ff7161f55fabd910db6c5baf0e49a9c45baf4f45cb056c0dd530d1bc
-  data.tar.gz: 02fa848f90ced8e1262cdb7fca6fc17f62472594f374b03ce103ebfb978aac15
+  metadata.gz: 5f1bf0f9d17e73042a1c33ae69ffe0cf079bedb1423119b36a524d085cfe6f6a
+  data.tar.gz: '0797210c998bb891bcd07b68f3d4cc9e779cf775ea051e6529c8b052ed58642a'
 SHA512:
-  metadata.gz: 60d860bb7082c040502b9bbba4cdf00ca265f9cc2cb5a7df9a71b597f50241fb722f9c0e234db67eecccf0e9f75611fbc92099fbd76eb063372953b79ac9a259
-  data.tar.gz: ffa3593debf4c47cfb605f4da9f6e23615d628253044eb05da335cdf4019535e1f3bf676c55de6ed4290c49c58b17f2fd50a6056c99d6eba4165fcd4ed5a58f4
+  metadata.gz: bb484322f4605db7c86dddf047de1ad1dbe477faf11b7d736edaa544132b87c1b7c0481cd13a6154662a0e318daeaf4880102882288cf02b84ba88eb8d3372f5
+  data.tar.gz: 141d659c28c9c9b2bef362b7f5b57bccf68aaec436b553e19785d97d162a0293c94d0d79ad7d29b7300f0b2583cce353c3152503ec965ab521eeff6fe3bb1127

data/.rubocop.yml

@@ -1,7 +1,4 @@
-plugins:
-  - rubocop-rake
-  - rubocop-rspec
-  - rubocop-rbs_inline
+# NOTE: Rules are sorted in ASCII order.
 
 AllCops:
   NewCops: enable
@@ -10,43 +7,56 @@ AllCops:
     - bin/**/*
     - vendor/**/*
 
+plugins:
+  - rubocop-numbered-params
+  - rubocop-rake
+  - rubocop-rbs_inline
+  - rubocop-rspec
+
+# Layout
+Layout/LeadingCommentSpace:
+  AllowRBSInlineAnnotation: true
+  AllowSteepAnnotation: true
+
 Layout/LineLength:
   Max: 120
 
+# Metrics
 Metrics/AbcSize:
   Max: 20
 
 Metrics/BlockLength:
   Exclude:
-    - spec/**/*_spec.rb
+    - "spec/**/*_spec.rb"
+
+Metrics/ClassLength:
+  Max: 200
 
 Metrics/MethodLength:
-  Max: 20
+  Max: 30
 
+# Naming
 Naming/FileName:
   Exclude:
-    - lib/rubocop-rbs_inline.rb
+    - "lib/rubocop-rbs_inline.rb"
 
+# RSpec
 RSpec/ExampleLength:
-  Max: 20
-
-RSpec/NestedGroups:
-  Max: 5
-
-Style/Documentation:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedShorthandSyntax: always
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
 
-# for RBS::Inline
-Layout/LeadingCommentSpace:
+RSpec/MultipleExpectations:
   Enabled: false
 
-Style/CommentedKeyword:
+RSpec/NamedSubject:
   Enabled: false
 
-# rubocop-rbs_inline configuration
+RSpec/NestedGroups:
+  Max: 5
+
+# RbsInline
 Style/RbsInline/MissingTypeAnnotation:
   EnforcedStyle: doc_style_and_return_annotation
 
@@ -55,3 +65,22 @@ Style/RbsInline/RedundantTypeAnnotation:
 
 Style/RbsInline/RequireRbsInlineComment:
   EnforcedStyle: never
+
+# Style
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: always
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.7.0 (2026-07-20)
+
+### New Features
+
+- **Style/RbsInline/MissingStructClassAnnotation**: New cop that checks each attribute passed to `Struct.new` has a trailing `#:` inline type annotation. Supports autocorrect.
+- **Style/RbsInline/StructClassCommentAlignment**: New cop that checks `#:` inline type annotations in a multiline `Struct.new` call are aligned. Supports autocorrect.
+- **Style/RbsInline/StructNewWithBlock**: New cop that checks for `Struct.new` calls with a block, which RBS::Inline does not parse.
+
+## 1.6.1 (2026-07-10)
+
+### Bug Fixes
+
+- Fixed user's `Style/RbsInline: Exclude:` configuration being ignored (regression from 1.6.0).
+
 ## 1.6.0 (2026-07-05)
 
 ### Changes

data/README.md

@@ -198,6 +198,32 @@ MethodEntry = Data.define(
 )
 ```
 
+### Style/RbsInline/MissingStructClassAnnotation
+
+Checks that each attribute passed to `Struct.new` has a trailing `#:` inline type annotation on the same line.
+
+For folded `Struct.new` calls (where multiple attributes share a line), the cop will suggest rewriting as a multiline call so each attribute can be annotated individually. A leading string argument (the struct name) and the `keyword_init:` keyword argument are not attributes and are ignored.
+
+Supports autocorrect.
+
+**Examples:**
+```ruby
+# bad
+Point = Struct.new(:x, :y)
+
+# bad - missing annotation for :y
+Point = Struct.new(
+  :x,  #: Integer
+  :y
+)
+
+# good
+Point = Struct.new(
+  :x,  #: Integer
+  :y   #: Integer
+)
+```
+
 ### Style/RbsInline/MissingTypeAnnotation
 
 Enforces that method definitions and `attr_*` declarations have RBS inline type annotations.
@@ -458,6 +484,50 @@ class Foo
 end
 ```
 
+### Style/RbsInline/StructClassCommentAlignment
+
+Checks that `#:` inline type annotations in a multiline `Struct.new` call are aligned to the same column. The expected column is determined by the longest attribute name (plus its trailing comma). Folded `Struct.new` calls (where multiple attributes share a line) are excluded.
+
+Supports autocorrect.
+
+**Examples:**
+```ruby
+# bad
+Point = Struct.new(
+  :x, #: Integer
+  :long_attr  #: Integer
+)
+
+# good
+Point = Struct.new(
+  :x,         #: Integer
+  :long_attr  #: Integer
+)
+```
+
+### Style/RbsInline/StructNewWithBlock
+
+Checks for `Struct.new` calls with a block. RBS::Inline does not parse block contents, so any methods defined inside the block will not be recognized for type checking. Instead, call `Struct.new` without a block and reopen the class separately to add methods.
+
+**Examples:**
+```ruby
+# bad
+User = Struct.new(:name, :role) do
+  def admin?
+    role == :admin
+  end
+end
+
+# good
+User = Struct.new(:name, :role)
+
+class User
+  def admin? #: bool
+    role == :admin
+  end
+end
+```
+
 ### Style/RbsInline/UnmatchedAnnotations
 
 Verifies that annotation parameters match the actual method parameters.

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
@@ -9,18 +9,18 @@ task default: :ci
 
 task ci: %i[rubocop spec steep rbs:validate]
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
-desc 'Generate a new cop with a template'
+desc "Generate a new cop with a template"
 task :new_cop, [:cop] do |_task, args|
-  require 'rubocop'
+  require "rubocop"
 
   cop_name = args.fetch(:cop) do
-    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    warn "usage: bundle exec rake new_cop[Department/Name]"
     exit!
   end
 
@@ -28,30 +28,30 @@ task :new_cop, [:cop] do |_task, args|
 
   generator.write_source
   generator.write_spec
-  generator.inject_require(root_file_path: 'lib/rubocop/cop/rbs_inline_cops.rb')
-  generator.inject_config(config_file_path: 'config/default.yml')
+  generator.inject_require(root_file_path: "lib/rubocop/cop/rbs_inline_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
 
   puts generator.todo
 end
 
 namespace :rbs do
-  desc 'Install RBS signatures'
+  desc "Install RBS signatures"
   task :install do
-    sh 'bundle', 'exec', 'rbs', 'collection', 'install', '--frozen'
+    sh "bundle", "exec", "rbs", "collection", "install", "--frozen"
   end
 
-  desc 'Generate RBS files'
+  desc "Generate RBS files"
   task :generate do
-    sh 'rbs-inline', '--opt-out', '--output=sig', 'lib'
+    sh "rbs-inline", "--opt-out", "--output=sig", "lib"
   end
 
-  desc 'Validate RBS files'
-  task validate: 'rbs:install' do
-    sh 'rbs', '-Isig', 'validate'
+  desc "Validate RBS files"
+  task validate: "rbs:install" do
+    sh "rbs", "-Isig", "validate"
   end
 end
 
-desc 'Run Steep type checker'
-task steep: 'rbs:install' do
-  sh 'bundle', 'exec', 'steep', 'check'
+desc "Run Steep type checker"
+task steep: "rbs:install" do
+  sh "bundle", "exec", "steep", "check"
 end

data/Steepfile

@@ -3,9 +3,9 @@
 D = Steep::Diagnostic
 
 target :lib do
-  signature 'sig'
+  signature "sig"
 
-  check 'lib'
+  check "lib"
 
   configure_code_diagnostics(D::Ruby.strict) do |hash|
     hash[D::Ruby::ImplicitBreakValueMismatch] = nil

data/config/default.yml

@@ -1,66 +1,55 @@
+Style/RbsInline:
+  inherit_mode:
+    merge:
+      - Exclude
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
 Style/RbsInline/DataClassCommentAlignment:
   Description: "Checks that `#:` inline type annotations in `Data.define` blocks are aligned."
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/DataDefineWithBlock:
   Description: "Checks for `Data.define` calls with a block, which RBS::Inline does not parse."
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/EmbeddedRbsSpacing:
   Description: 'Checks that `@rbs!` comments (embedded RBS) are followed by a blank line.'
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/InvalidComment:
   Description: "Checks the rbs-inline annotation comment is valid."
   Enabled: true
   VersionAdded: "1.0.0"
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/InvalidTypes:
   Description: "Checks the rbs-inline annotation comment uses valid types."
   Enabled: true
   VersionAdded: "1.0.0"
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/KeywordSeparator:
   Description: "Checks the rbs-inline annotation comment does not use a separator after the keywords."
   Enabled: true
   VersionAdded: "1.0.0"
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/MethodCommentSpacing:
   Description: 'Checks that method-related `@rbs` annotations are placed immediately before method definitions.'
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/MissingDataClassAnnotation:
   Description: "Checks that `Data.define` attributes have inline type annotations."
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
+
+Style/RbsInline/MissingStructClassAnnotation:
+  Description: "Checks that `Struct.new` attributes have inline type annotations."
+  Enabled: true
+  VersionAdded: '1.7.0'
 
 Style/RbsInline/MissingTypeAnnotation:
   Description: "Checks that method definitions and attr_* declarations have RBS inline type annotations."
@@ -73,34 +62,22 @@ Style/RbsInline/MissingTypeAnnotation:
     - method_type_signature
     - method_type_signature_or_return_annotation
   Visibility: all
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/ParametersSeparator:
   Description: "Checks the rbs-inline annotation comment uses a separator to parameters"
   Enabled: true
   VersionAdded: "1.0.0"
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/RedundantAnnotationWithSkip:
   Description: "Checks for redundant type annotations when `@rbs skip` or `@rbs override` is present."
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/RedundantInstanceVariableAnnotation:
   Description: "Checks for redundant `@rbs` instance variable type annotation when `attr_*` with an inline type annotation is already defined."
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/RedundantTypeAnnotation:
   Description: "Checks for redundant type annotations when multiple type specifications exist for the same method definition."
@@ -112,9 +89,6 @@ Style/RbsInline/RedundantTypeAnnotation:
     - method_type_signature
     - doc_style
     - doc_style_and_return_annotation
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/RequireRbsInlineComment:
   Description: "Checks the presence or absence of `# rbs_inline: enabled` magic comment."
@@ -124,30 +98,28 @@ Style/RbsInline/RequireRbsInlineComment:
   SupportedStyles:
     - always
     - never
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
+
+Style/RbsInline/StructClassCommentAlignment:
+  Description: "Checks that `#:` inline type annotations in `Struct.new` blocks are aligned."
+  Enabled: true
+  VersionAdded: '1.7.0'
+
+Style/RbsInline/StructNewWithBlock:
+  Description: "Checks for `Struct.new` calls with a block, which RBS::Inline does not parse."
+  Enabled: true
+  VersionAdded: '1.7.0'
 
 Style/RbsInline/UnmatchedAnnotations:
   Description: "Checks the rbs-inline annotation comment is surely matched."
   Enabled: true
   VersionAdded: "1.0.0"
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/UntypedInstanceVariable:
   Description: "Checks that instance variables in classes/modules have RBS type annotations."
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
 
 Style/RbsInline/VariableCommentSpacing:
   Description: 'Checks that `@rbs` variable comments are followed by a blank line.'
   Enabled: true
   VersionAdded: '1.5.0'
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'

data/lib/rubocop/cop/rbs_inline_cops.rb

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 
-require_relative 'style/rbs_inline/ast_utils'
-require_relative 'style/rbs_inline/source_code_helper'
-require_relative 'style/rbs_inline/comment_parser'
-require_relative 'style/rbs_inline/data_class_comment_alignment'
-require_relative 'style/rbs_inline/data_define_with_block'
-require_relative 'style/rbs_inline/embedded_rbs_spacing'
-require_relative 'style/rbs_inline/invalid_comment'
-require_relative 'style/rbs_inline/invalid_types'
-require_relative 'style/rbs_inline/keyword_separator'
-require_relative 'style/rbs_inline/method_comment_spacing'
-require_relative 'style/rbs_inline/missing_data_class_annotation'
-require_relative 'style/rbs_inline/missing_type_annotation'
-require_relative 'style/rbs_inline/parameters_separator'
-require_relative 'style/rbs_inline/redundant_annotation_with_skip'
-require_relative 'style/rbs_inline/redundant_instance_variable_annotation'
-require_relative 'style/rbs_inline/redundant_type_annotation'
-require_relative 'style/rbs_inline/require_rbs_inline_comment'
-require_relative 'style/rbs_inline/unmatched_annotations'
-require_relative 'style/rbs_inline/untyped_instance_variable'
-require_relative 'style/rbs_inline/variable_comment_spacing'
+require_relative "style/rbs_inline/ast_utils"
+require_relative "style/rbs_inline/source_code_helper"
+require_relative "style/rbs_inline/comment_parser"
+require_relative "style/rbs_inline/data_struct_helper"
+require_relative "style/rbs_inline/missing_class_annotation"
+require_relative "style/rbs_inline/class_comment_alignment"
+require_relative "style/rbs_inline/data_class_comment_alignment"
+require_relative "style/rbs_inline/data_define_with_block"
+require_relative "style/rbs_inline/embedded_rbs_spacing"
+require_relative "style/rbs_inline/invalid_comment"
+require_relative "style/rbs_inline/invalid_types"
+require_relative "style/rbs_inline/keyword_separator"
+require_relative "style/rbs_inline/method_comment_spacing"
+require_relative "style/rbs_inline/missing_data_class_annotation"
+require_relative "style/rbs_inline/missing_type_annotation"
+require_relative "style/rbs_inline/parameters_separator"
+require_relative "style/rbs_inline/redundant_annotation_with_skip"
+require_relative "style/rbs_inline/redundant_instance_variable_annotation"
+require_relative "style/rbs_inline/redundant_type_annotation"
+require_relative "style/rbs_inline/require_rbs_inline_comment"
+require_relative "style/rbs_inline/struct_class_comment_alignment"
+require_relative "style/rbs_inline/struct_new_with_block"
+require_relative "style/rbs_inline/missing_struct_class_annotation"
+require_relative "style/rbs_inline/unmatched_annotations"
+require_relative "style/rbs_inline/untyped_instance_variable"
+require_relative "style/rbs_inline/variable_comment_spacing"

data/lib/rubocop/cop/style/rbs_inline/class_comment_alignment.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Shared behavior for cops that ensure `#:` inline type annotations on
+        # struct-like class attributes (`Data.define` / `Struct.new`) are aligned.
+        #
+        # The including cop matches the definition node (e.g. via `struct_like_class?`)
+        # and calls {#check_comment_alignment}.
+        #
+        # @rbs module-self RuboCop::Cop::Base
+        module ClassCommentAlignment
+          include DataStructHelper
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_comment_alignment(node) #: void
+            return if folded?(node)
+
+            check_annotation_alignment(node)
+          end
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_annotation_alignment(node) #: void
+            annotated = attr_arguments(node).filter_map do |arg|
+              comment = inline_type_comment(arg.location.line)
+              [arg, comment] if comment #: [RuboCop::AST::Node, Parser::Source::Comment]
+            end
+            return if annotated.size < 2
+
+            expected_col = annotation_column(node)
+            annotated.each do |arg, comment|
+              actual_col = comment.location.column
+              next if actual_col == expected_col
+
+              add_offense(comment.source_range) do |corrector|
+                correct_alignment(corrector, arg, comment, expected_col)
+              end
+            end
+          end
+
+          # @rbs corrector: RuboCop::Cop::Corrector
+          # @rbs arg: RuboCop::AST::Node
+          # @rbs comment: Parser::Source::Comment
+          # @rbs expected_col: Integer
+          def correct_alignment(corrector, arg, comment, expected_col) #: void # rubocop:disable Metrics/AbcSize
+            line = arg.location.line
+            line_source = source_code_at(line)
+            source = line_source[...comment.location.column] || raise
+            content_end_col = source.rstrip.length
+            padding = [expected_col - content_end_col, 1].max || raise
+
+            line_begin = processed_source.buffer.line_range(line).begin_pos
+            replace_start = line_begin + content_end_col
+            replace_end = line_begin + comment.location.column
+
+            corrector.replace(range_between(replace_start, replace_end), " " * padding)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/comment_parser.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rbs/inline'
+require "rbs/inline"
 
-require_relative 'source_code_helper'
+require_relative "source_code_helper"
 
 module RuboCop
   module Cop
@@ -49,7 +49,7 @@ module RuboCop
 
               # Exclude trailing inline comments (e.g., `def method = value #: Type`)
               # by verifying all comment lines contain only whitespace before '#'
-              r.comments.all? { |c| processed_source.buffer.source_line(c.location.start_line).match?(/\A\s*#/) }
+              r.comments.all? { processed_source.buffer.source_line(_1.location.start_line).match?(/\A\s*#/) }
             end
           end
 
@@ -60,8 +60,8 @@ module RuboCop
             return unless leading_annotation
 
             annotation_lines = leading_annotation.comments
-                                                 .select { |c| c.location.slice.start_with?('#:') }
-                                                 .map { |c| c.location.start_line }
+                                                 .select { _1.location.slice.start_with?("#:") }
+                                                 .map { _1.location.start_line }
             return if annotation_lines.empty?
 
             comments = processed_source.comments.select do |c|