https://github.com/ruby/repl_type_completor
https://github.com/ruby/repl_type_completor
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ruby/repl_type_completor
- Owner: ruby
- License: mit
- Created: 2023-11-28T09:26:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T06:29:33.000Z (about 1 year ago)
- Last Synced: 2025-03-29T14:04:56.841Z (12 months ago)
- Language: Ruby
- Size: 192 KB
- Stars: 32
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
```ruby
require 'repl_type_completor'
```
Load RBS with one of these. It will load core library signatures, `./rbs_collection.yaml` and `./sig/**/*.rbs`.
```ruby
ReplTypeCompletor.preload_rbs # Recommended. Preload using thread
ReplTypeCompletor.load_rbs # Could take a seconds in large projects
```
Now you can get completion candidates.
```ruby
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](https://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.
```ruby
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](https://opensource.org/licenses/MIT).