rubocop-yard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc400612d09ab5ddf92d7361573854c7338a9601a3c1ed253fee7affb4b56de
-  data.tar.gz: 79b066ad6cf601e2d3eac583333cda1f2f56873dad13d7cc19ee30238e2e9d16
+  metadata.gz: 77c23358faa88b10e005e0f455dcf16283fe9fbf64c92276e5bff6bb201de43a
+  data.tar.gz: a1fb8bfe577565d31294920356f176fd9bc71b856ee7db0a11031347473602c5
 SHA512:
-  metadata.gz: 03c33163563d342329b62d989beb3dd4635cfa09a26b4ad3b13b7802ebf3c6286d3ebda9a4f28b7453fc42aa9bcfbafa4c6579703b90636e7d1a5ce608262312
-  data.tar.gz: f82f34bf6a182f595669b9c0ef46567b4e86b22d73d17cc672baa297f3dbeb5cdc81aa544abedbf9787fece7aca0632f7e780e811a628d96112e9a095e206f49
+  metadata.gz: 478b94fe6b6bd5f310fc5774554888a5aa0f99245cc8a13ff8f5225668e5486213eeec4f7621f84b3a4790a9989a9b03a0ebc47c848fda1e757194353d3d1049
+  data.tar.gz: debd8aa21c9d08430fd666a239e6e6114fd1dc091053f76254def0f62d37b9d1698c291c3d91ac716fc80682b07593512bd512ecd143327d3995573dacf603fb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-09-14
+
+- `YARD/TagTypeSyntax`
+    - Check collection tag type syntax
+
 ## [0.1.0] - 2023-09-13
 
 - Add new `YARD/TagTypeSyntax` cop

data/README.md

@@ -1,24 +1,34 @@
-# Rubocop::YARD
+# RuboCop::YARD
 
 You can check YARD format in Ruby code comment by RuboCop.
 
+<img src="https://github.com/ksss/rubocop-yard/blob/main/demo.png?raw=true" width=700 />
+
 ## Features
 
 ### `YARD/TagTypeSyntax`
 
 Check tag type syntax error.
 
-## Installation
+```
+@param [Symbol|String]
+        ^^^^^^^^^^^^^ SyntaxError as YARD tag type
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```
+@param [Hash<Symbol, String>]
+        ^^^^^^^^^^^^^^^^^^^^ <Type> is the collection type syntax. Did you mean {KeyType => ValueType} or Hash{KeyType => ValueType}
+```
+
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG --require=false
+    $ bundle add rubocop-yard --require=false
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install rubocop-yard
 
 ## Usage
 
@@ -44,4 +54,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rubocop::YARD project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/rubocop-yard/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the RuboCop::YARD project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/rubocop-yard/blob/main/CODE_OF_CONDUCT.md).

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

@@ -8,15 +8,30 @@ module RuboCop
       #   @param [Integer String]
       #
       #   # bad
-      #   @return [TrueClass|FalseClass]
+      #   @param [Hash<Symbol, String>]
+      #
+      #   # bad
+      #   @param [Hash(String)]
+      #
+      #   # bad
+      #   @param [Array{Symbol => String}]
       #
       #   # good
       #   @param [Integer, String]
       #
       #   # good
-      #   @return [Boolean]
+      #   @param [<String>]
+      #   @param [Array<String>]
+      #
+      #   # good
+      #   @param [(String)]
+      #   @param [Array(String)]
+      #
+      #   # good
+      #   @param [{KeyType => ValueType}]
+      #   @param [Hash{KeyType => ValueType}]
       class TagTypeSyntax < Base
-        MSG = 'SyntaxError as YARD tag type'
+        MSG = ''
         include RangeHelp # @return [void,]
 
         def on_new_investigation
@@ -33,9 +48,49 @@ module RuboCop
         def check(comment)
           docstring = comment.text.gsub(/\A#\s*/, '')
           ::YARD::DocstringParser.new.parse(docstring).tags.each do |tag|
-            ::YARD::Tags::TypesExplainer::Parser.parse(tag.types.join(', '))
+            ::YARD::Tags::TypesExplainer::Parser.parse(tag.types.join(', ')).each do |types_explainer|
+              check_mismatch_collection_type(comment, types_explainer)
+            end
           rescue SyntaxError
-            add_offense(tag_range(comment))
+            add_offense(tag_range_for_comment(comment), message: 'SyntaxError as YARD tag type')
+          end
+        end
+
+        def check_mismatch_collection_type(comment, types_explainer)
+          case types_explainer
+          when ::YARD::Tags::TypesExplainer::HashCollectionType
+            if types_explainer.name == 'Hash'
+              types_explainer.key_types.each { |t| check_mismatch_collection_type(comment, t) }
+              types_explainer.value_types.each { |t| check_mismatch_collection_type(comment, t) }
+            else
+              message = "`{KeyType => ValueType}` is the hash collection type syntax. #{did_you_mean_type(types_explainer.name)}"
+              add_offense(tag_range_for_comment(comment), message: message)
+            end
+          when ::YARD::Tags::TypesExplainer::FixedCollectionType
+            if types_explainer.name == 'Array'
+              types_explainer.types.each { |t| check_mismatch_collection_type(comment, t) }
+            else
+              message = "`(Type)` is the fixed collection type syntax. #{did_you_mean_type(types_explainer.name)}"
+              add_offense(tag_range_for_comment(comment), message: message)
+            end
+          when ::YARD::Tags::TypesExplainer::CollectionType
+            if types_explainer.name == 'Array'
+              types_explainer.types.each { |t| check_mismatch_collection_type(comment, t) }
+            else
+              message = "`<Type>` is the collection type syntax. #{did_you_mean_type(types_explainer.name)}"
+              add_offense(tag_range_for_comment(comment), message: message)
+            end
+          end
+        end
+
+        def did_you_mean_type(name)
+          case name
+          when 'Hash'
+            'Did you mean `{KeyType => ValueType}` or `Hash{KeyType => ValueType}`'
+          when 'Array'
+            'Did you mean `<Type>` or `Array<Type>`'
+          else
+            ''
           end
         end
 
@@ -47,7 +102,7 @@ module RuboCop
           comment.source.match?(/@(?:param|return)\s+\[.*\]/)
         end
 
-        def tag_range(comment)
+        def tag_range_for_comment(comment)
           start_column = comment.source.index(/\[/) + 1
           end_column = comment.source.index(/\]/)
           offense_start = comment.location.column + start_column

data/lib/rubocop/cop/yard_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 require 'yard'
 require_relative 'yard/tag_type_syntax'

data/lib/rubocop/yard/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module YARD
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/sig/rubocop/yard.rbs

@@ -1,6 +1,17 @@
-module Rubocop
+module RuboCop
   module YARD
     VERSION: String
     # See the writing guide of rbs: https://github.com/ruby/rbs#guides
   end
+  module Cop
+    module YARD
+      class TagTypeSyntax
+        type t = YARD::Tags::TypesExplainer::Type
+               | ::YARD::Tags::TypesExplainer::CollectionType
+               | ::YARD::Tags::TypesExplainer::FixedCollectionType
+               | ::YARD::Tags::TypesExplainer::HashCollectionType
+        private def check_mismatch_collection_type: (untyped comment, t types_explainer) -> void
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ksss
@@ -57,13 +57,13 @@ files:
 - lib/rubocop/yard/inject.rb
 - lib/rubocop/yard/version.rb
 - sig/rubocop/yard.rbs
-homepage: https://ksss.ink/
+homepage: https://github.com/ksss/rubocop-yard
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://ksss.ink/
-  source_code_uri: https://ksss.ink/
-  changelog_uri: https://ksss.ink/
+  homepage_uri: https://github.com/ksss/rubocop-yard
+  source_code_uri: https://github.com/ksss/rubocop-yard
+  changelog_uri: https://github.com/ksss/rubocop-yard
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []