ruby / rbs_json_schema

Generate RBS files from JSON Schema

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rbs_json_schema

rbs_json_schema is a RBS type definition generator from JSON Schema. It loads JSON files and writes RBS type definitioins.

Installation

Add this line to your application's Gemfile:

gem 'rbs_json_schema'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rbs_json_schema

Usage

Execute rbs_json_schema command with JSON schema files.

$ bundle exec rbs_json_schema schemas/address.json

Development

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.

Acknowledgement

This software is based on the work of Sushanth Sathesh Rao (@raosush) with the support from Google Summer of Code 2021.

Contributing

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

License

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

About

Generate RBS files from JSON Schema

License:MIT License


Languages

Language:Ruby 99.5%Language:Shell 0.5%