schema2type

Using schema2type, you can generate TypeScript type definitions from Rails'schema.rb automatically.

Start with a schema.rb:

ActiveRecord::Schema.define(version: xxxx) do
  create_table "Users", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
    t.string "name"
    t.integer "age"
    t.bigint "sales"
    t.boolean "paid", null: false
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["patient_id"], name: "index_histories_on_patient_id"
  end
end

Automatically have the following TypesScript type generated

declare namespace schema {
  type User = {
    name: string | null
    age: number | null
    sales: number | null
    paid: boolean
    created_at: Date
    updated_at: Date
  }
}

Installation

Add this line to your application's Gemfile:

gem 'schema2type'

And then execute:

$ bundle

Or install it yourself as:

$ gem install schema2type

Usage

bundle exec schema2type -s db/schema.rb -o schema.d.ts -n schema

options

command	require	default	detail
-s	true	-	Path of your schema.rb
-o	true	-	Output file name of TypeScript
-n	false	"schema"	Name of declare namespace

License

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