RBS provides syntax and semantics definition for the Ruby Signature
language, .rbs
files.
It consists of a parser, the syntax, and class definition interpreter, the semantics.
We haven't published a gem yet.
You need to install the dependencies, and build its parser with bin/setup
.
$ bin/setup
$ bundle exec exe/rbs
$ rbs list
$ rbs ancestors ::Object
$ rbs methods ::Object
$ rbs method ::Object tap
$ rbs list
This command lists all of the classes/modules/interfaces defined in .rbs
files.
$ rbs ancestors Array # ([].class.ancestors)
$ rbs ancestors --singleton Array # (Array.class.ancestors)
This command prints the ancestors of the class.
The name of the command is borrowed from Class#ancestors
, but the semantics is a bit different.
The ancestors
command is more precise (I believe).
$ rbs methods ::Integer # 1.methods
$ rbs methods --singleton ::Object # Object.methods
This command prints all methods provided for the class.
$ rbs method ::Integer '+' # 1+2
$ rbs method --singleton ::Object tap # Object.tap { ... }
This command prints type and properties of the method.
It accepts two global options, -r
and -I
.
-r
is for libraries. You can specify the names of libraries.
$ rbs -r set list
-I
is for application signatures. You can specify the name of directory.
$ rbs -I sig list
- Standard library signature contribution guide
- Writing signatures guide
- Stdlib signatures guide
- Syntax
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
to run the tests. 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 tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/rbs.