ruby / ruby/irb

Allow rdoc to be an optional dependency?

Open
#1,211 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
478
Forks
158
Avg merge
1d 12h
Merged PRs (30d)
12

Description

While an rdoc integration into irb has definite advantages, there are circumstances where the rdoc integration is more of a hinderance, e.g. wenn used as a console in production-like environment.

This also extends to the rdocs dependencies - if e.g. the project in question does not otherwise use ERB, we will always need to install it in the production environments anyway. And then be confronted with handling security issues for ERB, even if they aren't really pertinent to the project in question.

I'm not aware of an easy way to mark dependencies as optional with the current gemfile specification, so this issue might need to be put on the back burner until such a time that this can be specified in the gemfile. :)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the rdoc integration in IRB and how its dependencies are specified in the Gemfile. Define how rdoc and ERB could be optional while preserving the integration for users who need it; done means IRB can be used without installing those dependencies when the integration is not required.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.