Project

bundler-ri

0.0
No release in over 3 years
plugin to search for ri docs in your bundle
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

>= 0
 Project Readme

bundler-ri

A bundler plugin to be able to browse bundle-relevant ri docs. Somewhat of a WIP but it does work (kinda)

rubygems: https://rubygems.org/gems/bundler-ri

Usage

Adds a hook to bundle install that will generate rdoc --ri docs for bundler dependencies and store them in ./.bundle/plugin/ri. You probably don't want to check that into git if you're using this.

With the plugin installed bundle ri will do what ri usually does but its doc search path will include the generated docs for your dependencies.

See: https://bundler.io/man/bundle-plugin.1.html

See: https://guides.rubygems.org/bundler_plugins/

Development

bundle install for the dev dependencies

bundle exec rspec to run the tests

bundle exec standardrb --fix to lint and autocorrect

TODO

  • tests
  • don't regenerate docs we've already generated
  • transitive dependencies (some things like rails really rely on them)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bundler-ri.