rubocop-yard 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52a54c55381be3ea917d1d52e64a36e7b2262e4758f2408c77468f5bfa09815
-  data.tar.gz: 6d9f2f8e4dcccdaba87a55596bd6741479e2238ae39657fc65638578eff173d7
+  metadata.gz: 1899df376dd3954bb74cccef087aa23643d16a8c585965cafc732d2463ef408f
+  data.tar.gz: 6b268c4978625ffd07dbdcfa971f57df5442fcea0dfa1833b7570754f1758042
 SHA512:
-  metadata.gz: a2adb53a2daa313c7dfc8cbf5a238deb4904cde7783bcdab476ce823f018bed11587b33f88214587afc9f6be5723742edc2b250f8651045cb88a1851ed6a94e8
-  data.tar.gz: 0323d3765e33329d3ff345290cd3306676e4cbbf27d3c946da87627c1e98030a1591be102958e56f683131d37bbdf9cc7fe04af424dfce6db11264e105c5e1d3
+  metadata.gz: 1db8c39281f661263e7c9f3afc99e5155ad5ee566d6c0025519850e5585e6bc22c617e37b3772a41f7ca4d9c574af65ee853d8ed89f09af9537f66381f3d197a
+  data.tar.gz: 95a2d49c434ea46b6b86dee06347c96f0522cbcedcd5a34699536beec0009f7d8fe877ea352f79dcf57079186a8f6f5ae40c4454dbe40c06d4a1deabedddd254

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+* `YARD/MeaninglessTag`: Allow `@param` on `Struct.new`/`Data.define` constant assignments (https://github.com/ksss/rubocop-yard/issues/36)
+
 ## [1.1.0] - 2026-01-29
 
 * Fix NoMethodError when method signature includes **nil by @ksss in https://github.com/ksss/rubocop-yard/pull/39

data/lib/rubocop/cop/yard/helper.rb

@@ -25,6 +25,8 @@ module RuboCop
 
             begin
               types_explainers = parse_type(types.join(', '))
+              next if types.size != types_explainers.size
+
               types.zip(types_explainers).each do |type, types_explainer|
                 block.call(type, types_explainer)
               end

data/lib/rubocop/cop/yard/meaningless_tag.rb

@@ -19,12 +19,26 @@ module RuboCop
       #
       #   # good
       #   CONST = 1
+      #
+      #   # good (Struct/Data constant assignments accept @param)
+      #   # @param name [String]
+      #   # @param age [Integer]
+      #   Person = Struct.new(:name, :age, keyword_init: true)
       class MeaninglessTag < Base
         include YARD::Helper
         include RangeHelp
         include DocumentationComment
         extend AutoCorrector
 
+        # @!method struct_or_data_definition?(node)
+        #   @param node [RuboCop::AST::Node]
+        def_node_matcher :struct_or_data_definition?, <<~PATTERN
+          (casgn _ _ {
+            (block (send (const _ {:Struct :Data}) {:new :define} ...) ...)
+            (send (const _ {:Struct :Data}) {:new :define} ...)
+          })
+        PATTERN
+
         def on_class(node)
           check(node)
         end
@@ -40,6 +54,7 @@ module RuboCop
 
           docstring.tags.each do |tag|
             next unless tag.tag_name == 'param' || tag.tag_name == 'option'
+            next if tag.tag_name == 'param' && struct_or_data_definition?(node)
 
             comment = preceding_lines.find { |line| line.text.include?("@#{tag.tag_name}") }
             next unless comment

data/lib/rubocop/yard/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module YARD
-    VERSION = "1.1.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ksss
@@ -93,14 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Check yardoc format.
 test_files: []