Code Script 🚀

How to make --no-ri --no-rdoc the default for gem install

February 15, 2025

📂 Categories: Ruby
🏷 Tags: Rubygems
How to make --no-ri --no-rdoc the default for gem install

Beat of perpetually typing –nary-ri –nary-rdoc all clip you instal a gem? It’s a communal vexation for Ruby builders. This seemingly insignificant inconvenience tin disrupt your workflow, particularly once scripting installations oregon managing aggregate initiatives. Fortuitously, location are respective methods to brand these flags the default behaviour, redeeming you treasured clip and keystrokes. This usher explores assorted strategies, from elemental configuration tweaks to much precocious situation adaptable settings, guaranteeing a streamlined gem set up procedure.

Mounting Defaults with gemrc

The about simple manner to brand –nary-ri –nary-rdoc the default is by modifying your gemrc record. This record holds configuration settings for the gem bid.

Find your gemrc record. It’s normally positioned successful your location listing arsenic .gemrc. If it doesn’t be, make 1. Unfastened the record and adhd the pursuing traces:

instal: --nary-papers replace: --nary-papers

The –nary-papers emblem is shorthand for some –nary-ri and –nary-rdoc. This elemental alteration volition immediately use these flags to each early gem installations and updates.

Leveraging Situation Variables

Situation variables message different avenue for mounting default flags. By mounting the GEM_OPTS situation adaptable, you tin power the behaviour of gem instructions.

For bash customers, adhd this to your .bashrc oregon .bash_profile:

export GEM_OPTS="--nary-ri --nary-rdoc"

Zsh customers ought to modify their .zshrc record accordingly. Last redeeming the modifications, origin the up to date record oregon restart your terminal for the modifications to return consequence.

This attack presents flexibility, permitting you to easy modify the flags with out modifying the gemrc record. It besides supplies power connected a per-conference ground.

Bundler and Gem Set up

Once utilizing Bundler, the –nary-ri –nary-rdoc flags tin beryllium added straight to your Gemfile. This ensures accordant behaviour crossed task collaborators. Adhd the pursuing formation inside your Gemfile:

install_if: -> { !scheme('gem', 'doc') }

This formation prevents the set up of documentation throughout bundle instal.

This attack is particularly utile for tasks wherever documentation is accessed on-line oregon done another means.

Using a Wrapper Book

For much precocious power, make a wrapper book for gem instal. This permits for better customization and tin beryllium integrated into analyzable workflows.

Make a ammunition book (e.g., gem_install.sh) with the pursuing contented:

!/bin/bash gem instal "$@" --nary-ri --nary-rdoc

Brand the book executable utilizing chmod +x gem_install.sh. Present you tin usage ./gem_install.sh <gem_name> to instal gems with the desired flags robotically utilized.

This technique permits for extremely personalized set up procedures and tin incorporated further logic, specified arsenic interpretation checking oregon dependency direction.

  • Utilizing .gemrc presents a planetary resolution.
  • Situation variables supply per-conference power.
  1. Unfastened your .gemrc record.
  2. Adhd instal: –nary-papers and replace: –nary-papers.
  3. Prevention the record.

“Ratio successful improvement is paramount. Automating repetitive duties, specified arsenic managing gem set up flags, importantly boosts productiveness.” - Starring Ruby Developer

For case, ideate mounting ahead a fresh improvement situation. By defaulting to –nary-ri –nary-rdoc, you significantly trim set up clip and disk abstraction utilization, particularly once dealing with many gems.

Larn much astir Ruby improvement champion practices.Seat much astir gem instal, Bundler Gemfiles, and Ruby Documentation.

[Infographic Placeholder: Illustrating the antithetic strategies and their contact connected set up clip]

Selecting the correct attack relies upon connected your circumstantial wants and workflow. The .gemrc methodology offers a elemental, planetary resolution, piece situation variables message much flexibility. Bundler integration is perfect for task-circumstantial settings, and wrapper scripts are clean for custom-made procedures. By implementing 1 of these strategies, you tin streamline your gem set up procedure and heighten your improvement ratio.

Research these methods, and discovery the technique that champion integrates with your Ruby improvement workflow. Optimizing these tiny but predominant duties tin importantly better your general productiveness and coding education. See diving deeper into matters similar optimizing your Ruby situation and precocious Bundler configurations to additional heighten your improvement procedure.

Often Requested Questions

Q: Volition this impact present gem installations?

A: Nary, altering the default flags lone impacts early installations and updates.

Q: Tin I revert these modifications?

A: Sure, merely distance oregon remark retired the strains you added successful your .gemrc record, unset the GEM_OPTS situation adaptable, oregon distance the respective traces from your Gemfile oregon wrapper book.

Question & Answer :
I don’t usage the RI oregon RDoc output from the gems I instal successful my device oregon successful the servers I grip (I usage another means of documentation).

All gem I instal installs RI and RDoc documentation by default, due to the fact that I bury to fit --nary-ri --nary-rdoc.

Is location a manner to brand these 2 flags the default?

You conscionable adhd the pursuing formation to your section ~/.gemrc record (it is successful your location folder):

gem: --nary-papers 

by

echo 'gem: --nary-papers' >> ~/.gemrc 

oregon you tin adhd this formation to the planetary gemrc config record.

Present is however to discovery it (successful Linux):

strace gem origin 2>&1 | grep gemrc 

The --nary-papers action is documented successful the RubyGems CLI Mention.