repl_type_completor

ReplTypeCompletor

ReplTypeCompletor is a type based completor for REPL. It uses RBS type information, performs static type analytics, uses dynamic runtime information from binding.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add repl_type_completor

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install repl_type_completor

Usage

Require the library

require 'repl_type_completor'

Load RBS with one of these. It will load core library signatures, ./rbs_collection.yaml and ./sig/**/*.rbs.

ReplTypeCompletor.preload_rbs # Recommended. Preload using thread
ReplTypeCompletor.load_rbs # Could take a seconds in large projects

Now you can get completion candidates.

array = [1, 2, 3]
code_to_complete = 'array.map do str = _1.chr; str.up'
result = ReplTypeCompletor.analyze(code_to_complete, binding: binding, filename: __FILE__)
result.completion_candidates #=> ["case", "case!", "to"]
result.doc_namespace('case') #=> "String#upcase"

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/repl_type_completor.

When something is wrong, these methods will provide some debug information.

ReplTypeCompletor.info
ReplTypeCompletor.rbs_load_started?
ReplTypeCompletor.rbs_loaded?
ReplTypeCompletor.rbs_load_error
ReplTypeCompletor.last_completion_error
ReplTypeCompletor.analyze(code_to_complete, binding: binding, filename: __FILE__)

License

The gem is available as open source under the terms of the MIT License.