mirror of
https://github.com/ruby/ruby.git
synced 2025-08-24 13:34:17 +02:00
07c774e85c
(https://github.com/ruby/irb/pull/877)
* Make help command display help for individual commands
Usage: `help [command]`
If the command is not specified, it will display a list of all available commands.
If the command is specified, it will display the banner OR description of the command.
If the command is not found, it will display a message saying that the command is not found.
* Rename test/irb/cmd to test/irb/command
* Add banner to edit and ls commands
* Promote help command in the help message
1. Make `show_cmds` an alias of `help` so it's not displayed in the help message
2. Update description of the help command to reflect `help <command>` syntax
* Rename banner to help_message
43a2c99f3f
84 lines
2.6 KiB
Ruby
84 lines
2.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module IRB
|
|
module Command
|
|
class Help < Base
|
|
category "Help"
|
|
description "List all available commands. Use `help <command>` to get information about a specific command."
|
|
|
|
class << self
|
|
def transform_args(args)
|
|
# Return a string literal as is for backward compatibility
|
|
if args.empty? || string_literal?(args)
|
|
args
|
|
else # Otherwise, consider the input as a String for convenience
|
|
args.strip.dump
|
|
end
|
|
end
|
|
end
|
|
|
|
def execute(command_name = nil)
|
|
content =
|
|
if command_name
|
|
if command_class = ExtendCommandBundle.load_command(command_name)
|
|
command_class.help_message || command_class.description
|
|
else
|
|
"Can't find command `#{command_name}`. Please check the command name and try again.\n\n"
|
|
end
|
|
else
|
|
help_message
|
|
end
|
|
Pager.page_content(content)
|
|
end
|
|
|
|
private
|
|
|
|
def help_message
|
|
commands_info = IRB::ExtendCommandBundle.all_commands_info
|
|
commands_grouped_by_categories = commands_info.group_by { |cmd| cmd[:category] }
|
|
|
|
user_aliases = irb_context.instance_variable_get(:@user_aliases)
|
|
|
|
commands_grouped_by_categories["Aliases"] = user_aliases.map do |alias_name, target|
|
|
{ display_name: alias_name, description: "Alias for `#{target}`" }
|
|
end
|
|
|
|
if irb_context.with_debugger
|
|
# Remove the original "Debugging" category
|
|
commands_grouped_by_categories.delete("Debugging")
|
|
# Add an empty "Debugging (from debug.gem)" category at the end
|
|
commands_grouped_by_categories["Debugging (from debug.gem)"] = []
|
|
end
|
|
|
|
longest_cmd_name_length = commands_info.map { |c| c[:display_name].length }.max
|
|
|
|
output = StringIO.new
|
|
|
|
help_cmds = commands_grouped_by_categories.delete("Help")
|
|
|
|
add_category_to_output("Help", help_cmds, output, longest_cmd_name_length)
|
|
|
|
commands_grouped_by_categories.each do |category, cmds|
|
|
add_category_to_output(category, cmds, output, longest_cmd_name_length)
|
|
end
|
|
|
|
# Append the debugger help at the end
|
|
if irb_context.with_debugger
|
|
output.puts DEBUGGER__.help
|
|
end
|
|
|
|
output.string
|
|
end
|
|
|
|
def add_category_to_output(category, cmds, output, longest_cmd_name_length)
|
|
output.puts Color.colorize(category, [:BOLD])
|
|
|
|
cmds.each do |cmd|
|
|
output.puts " #{cmd[:display_name].to_s.ljust(longest_cmd_name_length)} #{cmd[:description]}"
|
|
end
|
|
|
|
output.puts
|
|
end
|
|
end
|
|
end
|
|
end
|