Ratbug

Ratbug (Rails and typescript building utilities generator)

Rails plugin to load schema and models, and generate typescript type(or interface) definitions and jbuilder templates.

Installation

Add this line to your application's Gemfile:

gem 'ratbug'

And then execute:

$ bundle install

And Then generate rake task on your environment.

$ rails g ratbug:install

memo

schema.rb must be present sql type schema is another option, but this tool is for schema.rb.

Usage

# $ rails ratbug:execute[<table_names>]
$ rails ratbug:execute[users]

then tmp/ratbug/_user.jbuilder and tmp/ratbug/_user.ts will be generated.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ratbug. 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 Ratbug project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.