yard-lint 1.2.2 → 1.3.0.rc1

data/lib/yard/lint/validators/tags/tag_type_position/validator.rb

@@ -9,100 +9,69 @@ module Yard
           # YARD standard (type_after_name): @param name [String] description
           # Alternative (type_first): @param name [String] description
           #
-          # Note: @return tags are not checked as they don't have parameter names
+          # @note @return tags are not checked as they don't have parameter names
           class Validator < Base
-            private
-
-            # Runs YARD query to check type position in tags
-            # @param dir [String] directory where YARD database is stored
-            # @param file_list_path [String] path to temp file containing file paths (one per line)
-            # @return [Hash] shell command execution results
-            def yard_cmd(dir, file_list_path)
-              # Write query to a temporary file to avoid shell escaping issues
-              cmd = "cat #{Shellwords.escape(file_list_path)} | xargs yard list --query #{query} "
-
-              Tempfile.create(['yard_query', '.sh']) do |f|
-                f.write("#!/bin/bash\n")
-                f.write(cmd)
-                f.write("#{shell_arguments} -b #{Shellwords.escape(dir)}\n")
-                f.flush
-                f.chmod(0o755)
-
-                shell("bash #{Shellwords.escape(f.path)}")
-              end
-            end
-
-            # YARD query that checks source code directly instead of docstring.all
-            # Detects patterns based on configured style
-            # @return [String] YARD query string
-            def query
-              <<~QUERY.strip
-                '
-                require "ripper"
-
-                checked_tags = #{checked_tags_array}
-                enforced_style = "#{enforced_style}"
-
-                # Read the source file and find comment lines for this object
-                return false unless object.file && File.exist?(object.file)
-
-                source_lines = File.readlines(object.file)
-                start_line = [object.line - 50, 0].max
-                end_line = [object.line, source_lines.length - 1].min
-
-                # Look for comments before the object definition
-                # Start just before the object line and scan backward
-                (start_line...(end_line - 1)).reverse_each do |line_num|
-                  line = source_lines[line_num].to_s.strip
-
-                  # Skip empty lines
-                  next if line.empty?
-
-                  # Stop if we hit code (non-comment line)
-                  break unless line.start_with?("#")
-
-                  # Skip comment-only lines without tags
-                  next unless line.include?("@")
-
-                  checked_tags.each do |tag_name|
-                    if enforced_style == "type_first"
-                      # Detect: @tag_name word [Type] (violation when type_first is enforced)
-                      pattern = /@\#{tag_name}\\s+(\\w+)\\s+\\[([^\\]]+)\\]/
-                      if line =~ pattern
-                        param_name = $1
-                        type_info = $2
-                        puts object.file + ":" + (line_num + 1).to_s + ": " + object.title
-                        puts tag_name + "|" + param_name + "|" + type_info + "|type_after_name"
-                      end
-                    else
-                      # Detect: @tag_name [Type] word (violation when type_after_name is enforced)
-                      pattern = /@\#{tag_name}\\s+\\[([^\\]]+)\\]\\s+(\\w+)/
-                      if line =~ pattern
-                        type_info = $1
-                        param_name = $2
-                        puts object.file + ":" + (line_num + 1).to_s + ": " + object.title
-                        puts tag_name + "|" + param_name + "|" + type_info + "|type_first"
-                      end
+            # Enable in-process execution
+            in_process visibility: :public
+
+            # Execute query for a single object during in-process execution.
+            # Checks type annotation position in @param and @option tags.
+            # @param object [YARD::CodeObjects::Base] the code object to query
+            # @param collector [Executor::ResultCollector] collector for output
+            # @return [void]
+            def in_process_query(object, collector)
+              return unless object.file && File.exist?(object.file)
+
+              checked_tags = config_or_default('CheckedTags')
+              style = enforced_style
+
+              source_lines = File.readlines(object.file)
+              start_line = [object.line - 50, 0].max
+              end_line = [object.line, source_lines.length - 1].min
+
+              # Look for comments before the object definition
+              (start_line...(end_line - 1)).reverse_each do |line_num|
+                line = source_lines[line_num].to_s.strip
+
+                # Skip empty lines
+                next if line.empty?
+
+                # Stop if we hit code (non-comment line)
+                break unless line.start_with?('#')
+
+                # Skip comment-only lines without tags
+                next unless line.include?('@')
+
+                checked_tags.each do |tag_name|
+                  if style == 'type_first'
+                    # Detect: @tag_name word [Type] (violation when type_first is enforced)
+                    pattern = /@#{tag_name}\s+(\w+)\s+\[([^\]]+)\]/
+                    if line =~ pattern
+                      param_name = ::Regexp.last_match(1)
+                      type_info = ::Regexp.last_match(2)
+                      collector.puts "#{object.file}:#{line_num + 1}: #{object.title}"
+                      collector.puts "#{tag_name}|#{param_name}|#{type_info}|type_after_name"
+                    end
+                  else
+                    # Detect: @tag_name [Type] word (violation when type_after_name is enforced)
+                    pattern = /@#{tag_name}\s+\[([^\]]+)\]\s+(\w+)/
+                    if line =~ pattern
+                      type_info = ::Regexp.last_match(1)
+                      param_name = ::Regexp.last_match(2)
+                      collector.puts "#{object.file}:#{line_num + 1}: #{object.title}"
+                      collector.puts "#{tag_name}|#{param_name}|#{type_info}|type_first"
                     end
                   end
                 end
-
-                false
-                '
-              QUERY
+              end
             end
 
+            private
+
             # @return [String] the enforced style ('type_after_name' (standard) or 'type_first')
             def enforced_style
               config_or_default('EnforcedStyle')
             end
-
-            # Array of tag names to check, formatted for YARD query
-            # @return [String] Ruby array literal string
-            def checked_tags_array
-              tags = config_or_default('CheckedTags')
-              "[#{tags.map { |t| "\"#{t}\"" }.join(',')}]"
-            end
           end
         end
       end

data/lib/yard/lint/validators/tags/tag_type_position.rb

@@ -20,8 +20,8 @@ module Yard
         #   end
         #
         # @example Bad - Type before parameter name (when using default style)
-        #   # @param [String] name the user's name
-        #   # @param [Integer] age the user's age
+        #   # @param name [String] the user's name
+        #   # @param age [Integer] the user's age
         #   def create_user(name, age)
         #   end
         #
@@ -33,8 +33,8 @@ module Yard
         #       EnforcedStyle: type_first
         #
         # @example Good - When EnforcedStyle is type_first
-        #   # @param [String] name the user's name
-        #   # @param [Integer] age the user's age
+        #   # @param name [String] the user's name
+        #   # @param age [Integer] the user's age
         #   def create_user(name, age)
         #   end
         #
@@ -42,7 +42,6 @@ module Yard
         #
         #     Tags/TagTypePosition:
         #       Enabled: false
-        #
         module TagTypePosition
         end
       end

data/lib/yard/lint/validators/tags/type_syntax/parser.rb

@@ -13,12 +13,17 @@ module Yard
             #   file.rb:LINE: ClassName#method_name
             #   tag_name|type_string|error_message
             # @param yard_output [String] raw YARD query results
-            # @param _kwargs [Hash] unused keyword arguments (for compatibility)
+            # @option _kwargs [Object] :unused this parameter accepts no options (reserved for future use)
             # @return [Array<Hash>] array with violation details
             def call(yard_output, **_kwargs)
-              return [] if yard_output.nil? || yard_output.strip.empty?
+              return [] if yard_output.nil?
 
-              lines = yard_output.split("\n").map(&:strip).reject(&:empty?)
+              # Handle encoding issues from YARD output that may contain invalid UTF-8 sequences
+              # This can happen when YARD processes files with non-ASCII characters in type specs
+              sanitized = yard_output.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')
+              return [] if sanitized.strip.empty?
+
+              lines = sanitized.split("\n").map(&:strip).reject(&:empty?)
               violations = []
 
               lines.each_slice(2) do |location_line, details_line|

data/lib/yard/lint/validators/tags/type_syntax/validator.rb

@@ -7,66 +7,36 @@ module Yard
         module TypeSyntax
           # Runs YARD to validate type syntax using TypesExplainer::Parser
           class Validator < Base
-            private
-
-            # Runs YARD query to validate type syntax on given files
-            # @param dir [String] directory where YARD database is stored
-            # @param file_list_path [String] path to temp file containing file paths (one per line)
-            # @return [Hash] shell command execution results
-            def yard_cmd(dir, file_list_path)
-              # Write query to a temporary file to avoid shell escaping issues
-              cmd = "cat #{Shellwords.escape(file_list_path)} | xargs yard list --query #{query} "
-
-              Tempfile.create(['yard_query', '.sh']) do |f|
-                f.write("#!/bin/bash\n")
-                f.write(cmd)
-                f.write("#{shell_arguments} -b #{Shellwords.escape(dir)}\n")
-                f.flush
-                f.chmod(0o755)
-
-                shell("bash #{Shellwords.escape(f.path)}")
-              end
-            end
-
-            # YARD query that validates type syntax for each tag
-            # Format output as two lines per violation:
-            #   Line 1: file.rb:LINE: ClassName#method_name
-            #   Line 2: tag_name|type_string|error_message
-            # @return [String] YARD query string
-            def query
-              <<~QUERY.strip
-                '
-                require "yard"
-
-                docstring
-                  .tags
-                  .select { |tag| #{validated_tags_array}.include?(tag.tag_name) }
-                  .each do |tag|
-                    next unless tag.types
-
-                    tag.types.each do |type_str|
-                      begin
-                        YARD::Tags::TypesExplainer::Parser.parse(type_str)
-                      rescue SyntaxError => e
-                        puts object.file + ":" + object.line.to_s + ": " + object.title
-                        puts tag.tag_name + "|" + type_str + "|" + e.message
-                        break
-                      end
-                    end
+            # Enable in-process execution
+            in_process visibility: :public
+
+            # Execute query for a single object during in-process execution.
+            # Validates type syntax in tags using YARD's TypesExplainer::Parser.
+            # @param object [YARD::CodeObjects::Base] the code object to query
+            # @param collector [Executor::ResultCollector] collector for output
+            # @return [void]
+            def in_process_query(object, collector)
+              validated_tags = config.validator_config('Tags/TypeSyntax', 'ValidatedTags') ||
+                               %w[param option return yieldreturn]
+
+              object.docstring.tags
+                    .select { |tag| validated_tags.include?(tag.tag_name) }
+                    .each do |tag|
+                next unless tag.types
+
+                tag.types.each do |type_str|
+                  begin
+                    YARD::Tags::TypesExplainer::Parser.parse(type_str)
+                  rescue SyntaxError => e
+                    # Sanitize error message to handle invalid UTF-8 sequences
+                    # YARD's parser may generate malformed error messages for non-ASCII input
+                    error_msg = e.message.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
+                    collector.puts "#{object.file}:#{object.line}: #{object.title}"
+                    collector.puts "#{tag.tag_name}|#{type_str}|#{error_msg}"
+                    break
                   end
-
-                false
-                '
-              QUERY
-            end
-
-            # Array of tag names to validate, formatted for YARD query
-            # @return [String] Ruby array literal string
-            def validated_tags_array
-              tags = config.validator_config('Tags/TypeSyntax', 'ValidatedTags') || %w[
-                param option return yieldreturn
-              ]
-              "[#{tags.map { |t| "\"#{t}\"" }.join(',')}]"
+                end
+              end
             end
           end
         end

data/lib/yard/lint/validators/tags/type_syntax.rb

@@ -29,7 +29,6 @@ module Yard
         #
         #     Tags/TypeSyntax:
         #       Enabled: false
-        #
         module TypeSyntax
         end
       end

data/lib/yard/lint/validators/warnings/duplicated_parameter_name/validator.rb

@@ -5,25 +5,8 @@ module Yard
     module Validators
       module Warnings
         module DuplicatedParameterName
-          # Runs YARD stats command to check for duplicatedparametername
+          # Validator for detecting duplicated parameter name warnings from YARD
           class Validator < Base
-            private
-
-            # Runs YARD stats command with proper settings on a given dir and files
-            # @param dir [String] dir where we should generate the temp docs
-            # @param file_list_path [String] path to temp file containing file paths (one per line)
-            # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, file_list_path)
-              cmd = <<~CMD
-                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
-                  #{shell_arguments} \
-                --compact \
-                -b #{Shellwords.escape(dir)}
-              CMD
-              cmd = cmd.tr("\n", ' ')
-
-              shell(cmd)
-            end
           end
         end
       end

data/lib/yard/lint/validators/warnings/invalid_directive_format/validator.rb

@@ -5,25 +5,8 @@ module Yard
     module Validators
       module Warnings
         module InvalidDirectiveFormat
-          # Runs YARD stats command to check for invaliddirectiveformat
+          # Validator for detecting invalid directive format warnings from YARD
           class Validator < Base
-            private
-
-            # Runs YARD stats command with proper settings on a given dir and files
-            # @param dir [String] dir where we should generate the temp docs
-            # @param file_list_path [String] path to temp file containing file paths (one per line)
-            # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, file_list_path)
-              cmd = <<~CMD
-                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
-                  #{shell_arguments} \
-                --compact \
-                -b #{Shellwords.escape(dir)}
-              CMD
-              cmd = cmd.tr("\n", ' ')
-
-              shell(cmd)
-            end
           end
         end
       end

data/lib/yard/lint/validators/warnings/invalid_tag_format/validator.rb

@@ -5,25 +5,8 @@ module Yard
     module Validators
       module Warnings
         module InvalidTagFormat
-          # Runs YARD stats command to check for invalidtagformat
+          # Validator for detecting invalid tag format warnings from YARD
           class Validator < Base
-            private
-
-            # Runs YARD stats command with proper settings on a given dir and files
-            # @param dir [String] dir where we should generate the temp docs
-            # @param file_list_path [String] path to temp file containing file paths (one per line)
-            # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, file_list_path)
-              cmd = <<~CMD
-                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
-                  #{shell_arguments} \
-                --compact \
-                -b #{Shellwords.escape(dir)}
-              CMD
-              cmd = cmd.tr("\n", ' ')
-
-              shell(cmd)
-            end
           end
         end
       end

data/lib/yard/lint/validators/warnings/unknown_directive/validator.rb

@@ -5,25 +5,8 @@ module Yard
     module Validators
       module Warnings
         module UnknownDirective
-          # Runs YARD stats command to check for unknowndirective
+          # Validator for detecting unknown directive warnings from YARD
           class Validator < Base
-            private
-
-            # Runs YARD stats command with proper settings on a given dir and files
-            # @param dir [String] dir where we should generate the temp docs
-            # @param file_list_path [String] path to temp file containing file paths (one per line)
-            # @return [Hash] shell command execution hash results
-            def yard_cmd(dir, file_list_path)
-              cmd = <<~CMD
-                cat #{Shellwords.escape(file_list_path)} | xargs yard stats \
-                  #{shell_arguments} \
-                --compact \
-                -b #{Shellwords.escape(dir)}
-              CMD
-              cmd = cmd.tr("\n", ' ')
-
-              shell(cmd)
-            end
           end
         end
       end