Support helper method extension API
Maintainers usually reply within 2 days
@st0012 is already working on this.
Since Jul 2, 2023.
Assessment
This issue has not been assessed yet.
Description
In #513, I proposed extension API for commands, but it doesn't cover all the extension needs. For example, Rails defines controller and helpers methods (and these methods too) for its Rails console, which are meant to be used as methods and be chained with other method calls. So they should not be treated as commands.
However, helper methods do share some common needs with commands, like:
- Feature discovery, e.g. can be listed in the result of
show_cmds(orhelpin the future) - Proper registration API and documentation (instead of manually including a module)
So I think we should provide (perhaps similar) extension for helper methods to fulfill such needs.
Details
Using Rails' controller helper as example:
module IRB
module Helper
class Controller < Helper::Base
category "Rails"
description "Gets a new instance of a controller object."
def execute
@controller ||= ApplicationController.new
end
end
end
end
IRB::ExtendedCommandBundle.add_helper(:controller, IRB::Helper::Controller)
- Dominant language
- Ruby
- Stars
- 477
- Forks
- 165
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 5
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ruby/irb
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Maintainers usually reply within 2 days
-
Proposal: public hook for external documentation providers in show_doc and the completion doc dialogPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 5/5 Over a week Newbie friendliness 38/100
Maintainers usually reply within 2 days
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 2 days
Similar issues
-
bug f:request-creation professional
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mysociety/alaveteli#9733 · 1 comment ·
Maintainers usually reply within 1 day
-
needs verification
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 13 days
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
betagouv/conseillers-entreprises#4808 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100