Use the IRB extension API to add commands to the console #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st0012
commented
May 5, 2024
| @@ -67,10 +67,9 @@ class Engine < ::Rails::Engine | |||
|
|
|||
| console do | |||
| require "irb" | |||
| require "irb/context" | |||
There was a problem hiding this comment.
Newer versions of IRB require irb/context by default, so this won't be necessary.
| module MissionControl::Jobs | ||
| class ConnectTo < IRB::Command::Base | ||
| category "Mission control jobs" | ||
| description "Connect to a job server" |
There was a problem hiding this comment.
You can also add help_message to commands to display more detailed messages when help <cmd> is called.
| @@ -20,6 +20,7 @@ Gem::Specification.new do |spec| | |||
| spec.add_dependency "importmap-rails" | |||
| spec.add_dependency "turbo-rails" | |||
| spec.add_dependency "stimulus-rails" | |||
| spec.add_dependency "irb", "~> 1.13" | |||
There was a problem hiding this comment.
The new API is added in v1.13, so it's necessary to require it.
|
I'm so sorry for the delay, @st0012. I love this!! 🤩 Amazing work on this new IRB extension API; it's super cool 🙇♀️ |
rosa
reviewed
May 7, 2024
After rails/rails#51705, the current way to add commands to the console will no longer work as `Rails::ConsoleMethods` will not be directly included in the IRB internal anymore. So this commit uses the new IRB extension API to add commands instead, which would also bring a few benefits: - Commands can be displayed in IRB's help message to make them easier to discover. - The parameter of `connect_to` doesn't need to be a string anymore as registered commands aren't treated as Ruby methods.
st0012
force-pushed
the
use-irb-extension-api
branch
from
12b4e60 to
113a887
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After rails/rails#51705, the current way to add commands to the console will no longer work as
Rails::ConsoleMethodswill not be directly included to the IRB internal anymore.So this commit uses the new IRB extension API to add commands instead, which would also bring a few benefits:
Commands can be displayed in IRB's help message to make them easier to discover.
The parameter of
connect_todoesn't need to be a string anymore as registered commands aren't treated as Ruby methods. So this now works too: