Project

bond-yard

0.0
No commit activity in last 3 years
No release in over 3 years
This bond plugin generates completions for gems that have been documented with yard.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.1.0
>= 0.9.8

Runtime

>= 0.5.2
 Project Readme

Description¶ ↑

This bond plugin generates completions for gems that have been documented with yard.

Install¶ ↑

Install the gem with:

gem install bond-yard

Usage¶ ↑

Add to your ~/.irbrc

require 'bond/yard'

In your .irbrc or in the console, load completions for gems that have been documented with yard:

>> Bond.load_yard_gems 'bond'
Bond: Building/loading bond's .yardoc database ...
=> ['bond']
>> Bond.start :[TAB]
:bare  :debug  :default_mission  :default_search  :eval_binding :eval_debug  :gems  :readline_plugin

For more examples, see here.

Todo¶ ↑

  • Generate method autocompletions for any arguments based on yard docs

  • yard-bond - Alternative implementation which avoids loading the yardoc cache at runtime