Class: Yard::Lint::Validators::Warnings::UnknownParameterName::MessagesBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/lint/validators/warnings/unknown_parameter_name/messages_builder.rb

Overview

Builds enhanced messages with “did you mean” suggestions

Class Method Summary collapse

Class Method Details

.call(offense) ⇒ String

Build message with suggestion for unknown parameter

Parameters:

  • offense (Hash) —

    offense data with :message, :location (file), :line keys

Returns:

  • (String) —

    formatted message with suggestion if available



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/yard/lint/validators/warnings/unknown_parameter_name/messages_builder.rb', line 17

def call(offense)
  message = offense[:message] || 'UnknownParameterName detected'

  # Extract the unknown parameter name from the message
  # Format: "@param tag has unknown parameter name: param_name"
  match = message.match(/@param tag has unknown parameter name: (\w+)/)
  return message unless match

  unknown_param = match[1]

  # Get actual parameters for the method at this location
  # Note: offense[:location] contains the file path
  file = offense[:location]
  line = offense[:line]
  actual_params = fetch_actual_parameters(file, line)
  return message if actual_params.empty?

  # Find best suggestion using did_you_mean
  suggestion = find_suggestion(unknown_param, actual_params)

  if suggestion
    "#{message} (did you mean '#{suggestion}'?)"
  else
    message
  end
end