RBS::Inline::Annotator

Add rbs-inline annotation to ruby code by rbs code.

# lib/foo.rb
class Foo
  def foo(a)
    a.to_s
  end
end

+

# sig/foo.rbs
class Foo
  def foo: (Integer) -> String
end

=

# lib/foo.rb
class Foo
  # @rbs a: Integer
  # @rbs return: String
  def foo(a)
    a.to_s
  end
end

Installation

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

bundle add rbs-inline-annotator

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

gem install rbs-inline-annotator

Usage

Add rbs-inline annotation to ruby file

$ bundle exec rbs-inline-annotator -I sig target_dir_or_file

Print result code to stdout only

$ bundle exec rbs-inline-annotator -I sig --mode print-only target_dir_or_file

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/ksss/rbs-inline-annotator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the Rbs::Inline::Annotator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.