mirror of
https://github.com/ruby/ruby.git
synced 2025-08-24 05:25:34 +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
70 lines
1.9 KiB
Ruby
70 lines
1.9 KiB
Ruby
require 'shellwords'
|
|
|
|
require_relative "../source_finder"
|
|
|
|
module IRB
|
|
# :stopdoc:
|
|
|
|
module Command
|
|
class Edit < Base
|
|
category "Misc"
|
|
description 'Open a file or source location.'
|
|
help_message <<~HELP_MESSAGE
|
|
Usage: edit [FILE or constant or method signature]
|
|
|
|
Open a file in the editor specified in #{highlight('ENV["VISUAL"]')} or #{highlight('ENV["EDITOR"]')}
|
|
|
|
- If no arguments are provided, IRB will attempt to open the file the current context was defined in.
|
|
- If FILE is provided, IRB will open the file.
|
|
- If a constant or method signature is provided, IRB will attempt to locate the source file and open it.
|
|
|
|
Examples:
|
|
|
|
edit
|
|
edit foo.rb
|
|
edit Foo
|
|
edit Foo#bar
|
|
HELP_MESSAGE
|
|
|
|
class << self
|
|
def transform_args(args)
|
|
# Return a string literal as is for backward compatibility
|
|
if args.nil? || args.empty? || string_literal?(args)
|
|
args
|
|
else # Otherwise, consider the input as a String for convenience
|
|
args.strip.dump
|
|
end
|
|
end
|
|
end
|
|
|
|
def execute(*args)
|
|
path = args.first
|
|
|
|
if path.nil?
|
|
path = @irb_context.irb_path
|
|
elsif !File.exist?(path)
|
|
source = SourceFinder.new(@irb_context).find_source(path)
|
|
|
|
if source&.file_exist? && !source.binary_file?
|
|
path = source.file
|
|
end
|
|
end
|
|
|
|
unless File.exist?(path)
|
|
puts "Can not find file: #{path}"
|
|
return
|
|
end
|
|
|
|
if editor = (ENV['VISUAL'] || ENV['EDITOR'])
|
|
puts "command: '#{editor}'"
|
|
puts " path: #{path}"
|
|
system(*Shellwords.split(editor), path)
|
|
else
|
|
puts "Can not find editor setting: ENV['VISUAL'] or ENV['EDITOR']"
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
# :startdoc:
|
|
end
|