Skip to content

Commit

Permalink
Deprecate multi-irb commands
Browse files Browse the repository at this point in the history
- Print deprecated message when any of the commands are used
- Put related commands under `Multi-irb` category with a deprecated
  label
  • Loading branch information
st0012 committed Aug 1, 2023
1 parent 310650c commit 20f2a40
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions lib/irb/cmd/subirb.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,45 +18,56 @@ def initialize(conf)

private

def print_deprecated_warning
warn <<~MSG
Multi-irb commands are deprecated and will be removed in IRB 2.0.0. Please use workspace commands instead.
If you have any use case for multi-irb, please leave a comment at https://github.com/ruby/irb/issues/653
MSG
end

def extend_irb_context
# this extension patches IRB context like IRB.CurrentContext
require_relative "../ext/multi-irb"
end
end

class IrbCommand < MultiIRBCommand
category "IRB"
category "Multi-irb (DEPRECATED)"
description "Start a child IRB."

def execute(*obj)
print_deprecated_warning
IRB.irb(nil, *obj)
end
end

class Jobs < MultiIRBCommand
category "IRB"
category "Multi-irb (DEPRECATED)"
description "List of current sessions."

def execute
print_deprecated_warning
IRB.JobManager
end
end

class Foreground < MultiIRBCommand
category "IRB"
category "Multi-irb (DEPRECATED)"
description "Switches to the session of the given number."

def execute(key = nil)
print_deprecated_warning
raise CommandArgumentError.new("Please specify the id of target IRB job (listed in the `jobs` command).") unless key
IRB.JobManager.switch(key)
end
end

class Kill < MultiIRBCommand
category "IRB"
category "Multi-irb (DEPRECATED)"
description "Kills the session with the given number."

def execute(*keys)
print_deprecated_warning
IRB.JobManager.kill(*keys)
end
end
Expand Down

0 comments on commit 20f2a40

Please # to comment.