Merge pull request #253 from phlex-ruby/lsp-hints

Ruby LSP hints for Rails helper adapters

lib/phlex/rails/helpers/action_cable_meta_tag.rb

@@ -3,9 +3,8 @@
 module Phlex::Rails::Helpers::ActionCableMetaTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method action_cable_meta_tag
-	# 	Outputs an "action-cable-url" meta tag with the value of the URL specified in your configuration. Ensure this is above your JavaScript tag:
-	# 	@see https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag
-	# 	@return [nil]
-	register_output_helper :action_cable_meta_tag
+	# Outputs an “action-cable-url” meta tag with the value of the URL specified in your configuration. Ensure this is above your JavaScript tag:
+	#
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag)
+	register_output_helper def action_cable_meta_tag(...) = nil
 end

lib/phlex/rails/helpers/action_name.rb

@@ -3,8 +3,8 @@
 module Phlex::Rails::Helpers::ActionName
 	extend Phlex::Rails::HelperMacros
 
-	# @!method action_name
-	# 	@return [String] the name of the controller action, e.g. <code>"index"</code>
-	# 	@see https://api.rubyonrails.org/classes/AbstractController/Base.html#method-i-action_name
-	register_value_helper :action_name
+	# Returns the name of the action this controller is processing.
+	#
+	# [Rails Docs](https://api.rubyonrails.org/classes/AbstractController/Base.html#method-i-action_name)
+	register_value_helper def action_name(...) = nil
 end

lib/phlex/rails/helpers/asset_path.rb

@@ -3,13 +3,8 @@
 module Phlex::Rails::Helpers::AssetPath
 	extend Phlex::Rails::HelperMacros
 
-	# @!method asset_path(source, host: nil, protocol: nil, type: nil, skip_pipeline: nil, extname: nil)
-	# 	@param source [String]
-	# 	@param host [String]
-	# 	@param protocol [String] e.g. <code>"https"</code>
-	# 	@param type [Symbol] e.g. <code>:javascript</code>
-	# 	@param skip_pipeline [bool]
-	# 	@param extname [String] e.g. <code>".js"</code>
-	# 	@see https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path
-	register_value_helper :asset_path
+	# This is the entry point for all assets.
+	#
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path)
+	register_value_helper def asset_path(...) = nil
 end

lib/phlex/rails/helpers/asset_url.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+# Phlex adapter for the [`asset_url`](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_url) Rails helper.
 module Phlex::Rails::Helpers::AssetURL
 	extend Phlex::Rails::HelperMacros
 
-	# @!method asset_url(...)
-	register_value_helper :asset_url
+	# Computes the full URL to an asset in the public directory.
+	#
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_url)
+	register_value_helper def asset_url(...) = nil
 end

lib/phlex/rails/helpers/audio_path.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::AudioPath
 	extend Phlex::Rails::HelperMacros
 
-	# @!method audio_path(...)
-	register_value_helper :audio_path
+	register_value_helper def audio_path(...) = nil
 end

lib/phlex/rails/helpers/audio_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::AudioTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method audio_tag(...)
-	# 	@return [nil]
-	register_output_helper :audio_tag
+	register_output_helper def audio_tag(...) = nil
 end

lib/phlex/rails/helpers/audio_url.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::AudioURL
 	extend Phlex::Rails::HelperMacros
 
-	# @!method audio_url(...)
-	register_value_helper :audio_url
+	register_value_helper def audio_url(...) = nil
 end

lib/phlex/rails/helpers/auto_discovery_link_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::AutoDiscoveryLinkTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method auto_discovery_link_tag(...)
-	# 	@return [nil]
-	register_output_helper :auto_discovery_link_tag
+	register_output_helper def auto_discovery_link_tag(...) = nil
 end

lib/phlex/rails/helpers/build_tag_values.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::BuildTagValues
 	extend Phlex::Rails::HelperMacros
 
-	# @!method build_tag_values(...)
-	register_value_helper :build_tag_values
+	register_value_helper def build_tag_values(...) = nil
 end

lib/phlex/rails/helpers/button_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::ButtonTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method button_tag(...)
-	# 	@return [nil]
-	register_output_helper :button_tag
+	register_output_helper def button_tag(...) = nil
 end

lib/phlex/rails/helpers/button_to.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::ButtonTo
 	extend Phlex::Rails::HelperMacros
 
-	# @!method button_to(...)
-	# 	@return [nil]
-	register_output_helper :button_to
+	register_output_helper def button_to(...) = nil
 end

lib/phlex/rails/helpers/check_box.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::CheckBox
 	extend Phlex::Rails::HelperMacros
 
-	# @!method check_box(...)
-	# 	@return [nil]
-	register_output_helper :check_box
+	register_output_helper def check_box(...) = nil
 end

lib/phlex/rails/helpers/check_box_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::CheckBoxTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method check_box_tag(...)
-	# 	@return [nil]
-	register_output_helper :check_box_tag
+	register_output_helper def check_box_tag(...) = nil
 end

lib/phlex/rails/helpers/class_names.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::ClassNames
 	extend Phlex::Rails::HelperMacros
 
-	# @!method class_names(...)
-	register_value_helper :class_names
+	register_value_helper def class_names(...) = nil
 end

lib/phlex/rails/helpers/collection_check_boxes.rb

@@ -3,8 +3,5 @@
 module Phlex::Rails::Helpers::CollectionCheckBoxes
 	extend Phlex::Rails::HelperMacros
 
-	# @!method collection_check_boxes(...)
-	# 	@yield [builder]
-	# 	@yieldparam builder [Phlex::Rails::BufferedCheckboxBuilder]
-	register_builder_yielding_helper :collection_check_boxes, Phlex::Rails::BufferedCheckboxBuilder
+	register_builder_yielding_helper def collection_check_boxes(...) = nil, Phlex::Rails::BufferedCheckboxBuilder
 end

lib/phlex/rails/helpers/collection_radio_buttons.rb

@@ -3,8 +3,5 @@
 module Phlex::Rails::Helpers::CollectionRadioButtons
 	extend Phlex::Rails::HelperMacros
 
-	# @!method collection_radio_buttons(...)
-	# 	@yield [builder]
-	# 	@yieldparam builder [Phlex::Rails::BufferedRadioButtonBuilder]
-	register_builder_yielding_helper :collection_radio_buttons, Phlex::Rails::BufferedRadioButtonBuilder
+	register_builder_yielding_helper def collection_radio_buttons(...) = nil, Phlex::Rails::BufferedRadioButtonBuilder
 end

lib/phlex/rails/helpers/collection_select.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::CollectionSelect
 	extend Phlex::Rails::HelperMacros
 
-	# @!method collection_select(...)
-	# 	@return [nil]
-	register_output_helper :collection_select
+	register_output_helper def collection_select(...) = nil
 end

lib/phlex/rails/helpers/color_field.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::ColorField
 	extend Phlex::Rails::HelperMacros
 
-	# @!method color_field(...)
-	# 	@return [nil]
-	register_output_helper :color_field
+	register_output_helper def color_field(...) = nil
 end

lib/phlex/rails/helpers/color_field_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::ColorFieldTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method color_field_tag(...)
-	# 	@return [nil]
-	register_output_helper :color_field_tag
+	register_output_helper def color_field_tag(...) = nil
 end

lib/phlex/rails/helpers/compute_asset_extname.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::ComputeAssetExtname
 	extend Phlex::Rails::HelperMacros
 
-	# @!method compute_asset_extname(...)
-	register_value_helper :compute_asset_extname
+	register_value_helper def compute_asset_extname(...) = nil
 end

lib/phlex/rails/helpers/compute_asset_host.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::ComputeAssetHost
 	extend Phlex::Rails::HelperMacros
 
-	# @!method compute_asset_host(...)
-	register_value_helper :compute_asset_host
+	register_value_helper def compute_asset_host(...) = nil
 end

lib/phlex/rails/helpers/compute_asset_path.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::ComputeAssetPath
 	extend Phlex::Rails::HelperMacros
 
-	# @!method compute_asset_path(...)
-	register_value_helper :compute_asset_path
+	register_value_helper def compute_asset_path(...) = nil
 end

lib/phlex/rails/helpers/content_for.rb

@@ -3,9 +3,7 @@
 module Phlex::Rails::Helpers::ContentFor
 	extend Phlex::Rails::HelperMacros
 
-	# @!method content_for?(...)
-	register_value_helper :content_for?
+	register_value_helper def content_for?(...) = nil
 
-	# @!method content_for(...)
-	register_value_helper :content_for
+	register_value_helper def content_for(...) = nil
 end

lib/phlex/rails/helpers/content_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::ContentTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method content_tag(...)
-	# 	@return [nil]
-	register_output_helper :content_tag
+	register_output_helper def content_tag(...) = nil
 end

lib/phlex/rails/helpers/controller_name.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::ControllerName
 	extend Phlex::Rails::HelperMacros
 
-	# @!method controller_name(...)
-	register_value_helper :controller_name
+	register_value_helper def controller_name(...) = nil
 end

lib/phlex/rails/helpers/controller_path.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::ControllerPath
 	extend Phlex::Rails::HelperMacros
 
-	# @!method controller_path(...)
-	register_value_helper :controller_path
+	register_value_helper def controller_path(...) = nil
 end

lib/phlex/rails/helpers/csp_meta_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::CSPMetaTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method csp_meta_tag(...)
-	# 	@return [nil]
-	register_output_helper :csp_meta_tag
+	register_output_helper def csp_meta_tag(...) = nil
 end

lib/phlex/rails/helpers/csrf_meta_tags.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::CSRFMetaTags
 	extend Phlex::Rails::HelperMacros
 
-	# @!method csrf_meta_tags(...)
-	# 	@return [nil]
-	register_output_helper :csrf_meta_tags
+	register_output_helper def csrf_meta_tags(...) = nil
 end

lib/phlex/rails/helpers/current_cycle.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::CurrentCycle
 	extend Phlex::Rails::HelperMacros
 
-	# @!method current_cycle(...)
-	register_value_helper :current_cycle
+	register_value_helper def current_cycle(...) = nil
 end

lib/phlex/rails/helpers/current_page.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::CurrentPage
 	extend Phlex::Rails::HelperMacros
 
-	# @!method current_page?(...)
-	register_value_helper :current_page?
+	register_value_helper def current_page?(...) = nil
 end

lib/phlex/rails/helpers/cycle.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::Cycle
 	extend Phlex::Rails::HelperMacros
 
-	# @!method cycle(...)
-	register_value_helper :cycle
+	register_value_helper def cycle(...) = nil
 end

lib/phlex/rails/helpers/date_field.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DateField
 	extend Phlex::Rails::HelperMacros
 
-	# @!method date_field(...)
-	# 	@return [nil]
-	register_output_helper :date_field
+	register_output_helper def date_field(...) = nil
 end

lib/phlex/rails/helpers/date_field_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DateFieldTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method date_field_tag(...)
-	# 	@return [nil]
-	register_output_helper :date_field_tag
+	register_output_helper def date_field_tag(...) = nil
 end

lib/phlex/rails/helpers/date_select.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DateSelect
 	extend Phlex::Rails::HelperMacros
 
-	# @!method date_select(...)
-	# 	@return [nil]
-	register_output_helper :date_select
+	register_output_helper def date_select(...) = nil
 end

lib/phlex/rails/helpers/datetime_field.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DatetimeField
 	extend Phlex::Rails::HelperMacros
 
-	# @!method datetime_field(...)
-	# 	@return [nil]
-	register_output_helper :datetime_field
+	register_output_helper def datetime_field(...) = nil
 end

lib/phlex/rails/helpers/datetime_field_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DatetimeFieldTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method datetime_field_tag(...)
-	# 	@return [nil]
-	register_output_helper :datetime_field_tag
+	register_output_helper def datetime_field_tag(...) = nil
 end

lib/phlex/rails/helpers/datetime_local_field.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DatetimeLocalField
 	extend Phlex::Rails::HelperMacros
 
-	# @!method datetime_local_field(...)
-	# 	@return [nil]
-	register_output_helper :datetime_local_field
+	register_output_helper def datetime_local_field(...) = nil
 end

lib/phlex/rails/helpers/datetime_local_field_tag.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DatetimeLocalFieldTag
 	extend Phlex::Rails::HelperMacros
 
-	# @!method datetime_local_field_tag(...)
-	# 	@return [nil]
-	register_output_helper :datetime_local_field_tag
+	register_output_helper def datetime_local_field_tag(...) = nil
 end

lib/phlex/rails/helpers/datetime_select.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::DatetimeSelect
 	extend Phlex::Rails::HelperMacros
 
-	# @!method datetime_select(...)
-	# 	@return [nil]
-	register_output_helper :datetime_select
+	register_output_helper def datetime_select(...) = nil
 end

lib/phlex/rails/helpers/debug.rb

@@ -3,7 +3,5 @@
 module Phlex::Rails::Helpers::Debug
 	extend Phlex::Rails::HelperMacros
 
-	# @!method debug(...)
-	# 	@return [nil]
-	register_output_helper :debug
+	register_output_helper def debug(...) = nil
 end

lib/phlex/rails/helpers/default_url_options.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::DefaultURLOptions
 	extend Phlex::Rails::HelperMacros
 
-	# @!method default_url_options(...)
-	register_value_helper :default_url_options
+	register_value_helper def default_url_options(...) = nil
 end

lib/phlex/rails/helpers/distance_of_time_in_words.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::DistanceOfTimeInWords
 	extend Phlex::Rails::HelperMacros
 
-	# @!method distance_of_time_in_words(...)
-	register_value_helper :distance_of_time_in_words
+	register_value_helper def distance_of_time_in_words(...) = nil
 end

lib/phlex/rails/helpers/distance_of_time_in_words_to_now.rb

@@ -3,6 +3,5 @@
 module Phlex::Rails::Helpers::DistanceOfTimeInWordsToNow
 	extend Phlex::Rails::HelperMacros
 
-	# @!method distance_of_time_in_words_to_now(...)
-	register_value_helper :distance_of_time_in_words_to_now
+	register_value_helper def distance_of_time_in_words_to_now(...) = nil
 end