ReplCompletion is a type based completor for REPL. It uses RBS type information, performs static type analytics, uses dynamic runtime information from binding.
TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
Require the library
require 'repl_completion'
Load RBS with one of these. It will load core library signatures, ./rbs_collection.yaml
and ./sig/**/*.rbs
.
ReplCompletion.preload_rbs # Recommended. Preload using thread
ReplCompletion.load_rbs # Could take a seconds in large projects
Now you can get completion candidates.
array = [1, 2, 3]
class String; def upupup; end; end
result = ReplCompletion.analyze('array.map do str = _1.chr; str.up', binding)
result.completion_candidates #=> ["case", "case!", "to", "upup"]
result.doc_namespace('case') #=> "String#upcase"
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and the created tag, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/repl_completion.
When something is wrong, these methods will provide some debug information.
ReplCompletion.info
ReplCompletion.rbs_load_started?
ReplCompletion.rbs_loaded?
ReplCompletion.rbs_load_error
ReplCompletion.last_completion_error
ReplCompletion.analyze(code_to_complete, binding)
The gem is available as open source under the terms of the MIT License.