elmassimo/types_from_serializers

✅ Generate TypeScript interfaces from your JSON serializers

blog . twitter . about

Projects 🛠

My current focus is development experience, and how it can help us achieve increased productivity.

Vite.js

• îles: 🏝 The joyful site generator! Islands of interactivity with Vue in Vite.js
• vite-plugin-image-presets: 🖼 Image presets for Vite.js apps
• vite-plugin-environment: Easily expose environment variables in Vite.js
• vite-plugin-full-reload: ♻️ Automatically reload the page when files are modified
• vite-plugin-bugsnag: Report builds and upload source maps to Bugsnag

Vite.js with Ruby

• vite_ruby: ⚡️♦️ Vite.js in Ruby - bringing joy to your JavaScript experience
• jekyll-vite: ⚡️🩸 Use Vite.js in Jekyll as your assets pipeline
• vite-plugin-erb: Use ERB files in Vite.js projects with a Ruby backend
• vite-plugin-stimulus-hmr: HMR for Stimulus controllers in Vite.js
• stimulus-vite-helpers: Helpers to easily load all your Stimulus - controllers when using Vite.js

Vue.js

• vuex-stores: 🗄 Store objects for Vuex, a simple and more fluid API for state-management.

Rails

• js_from_routes: 🛣️ Generate path helpers and API methods from your Rails routes
• oj_serializers: ⚡️ Faster JSON serialization for Ruby on Rails. Easily migrate away from Active Model Serializers
• types_from_serializers: ✅ Generate TypeScript interfaces from your JSON serializers
• presenter_rails: 🔭 Expose your view models in a convenient way
• queryable: ❔ Gives your queries a home and avoid tucking scopes inside your models
• resourcerer: ✨ Works like magic to dry up your controllers
• request_store_rails: 📦 Per-request global storage for Rails prepared for multi-threaded apps

Ruby

• better_settings: ⚙ Settings for Ruby apps – fast, immutable, better
• capybara-compose: ✅ Easily write fluent integration tests with Capybara
• i18n_multitenant: 🌎 Provides a convenient way to use tenant-specific translations
• pakiderm: 🐘 Pakiderm will never forget the return value

Demos / Templates / App Starters

• pingcrm-vite: PingCRM on Vite Rails - A Vite.js + Inertia.js + Rails demo
• jumpstart-vite: Jumpstart a new Rails app with Vite.js + Turbo + Stimulus, and more
• vite_rails_docker_example: An example of how to run Vite Rails in Docker

Podcasts & Talks 📣

• Frontend Joy in Ruby on Rails
• Islands Architecture in Vue
• Using Vite.js with Ruby Apps
• TypeScript from Ruby Serializers

Writing ✍️

Here are some articles I've written:

• A Rubyist's Guide to Vite.js
• Vue Components as Custom Elements
• Debugging Libraries: Ruby Edition
• Debugging Libraries: Node.js Edition
• Documentation is a Great Investment
• Generating a JS API from Rails Routes
• Practical Applications of the Singleton Class in Ruby
• Avoiding the N+1 problem in Mongoid

types_from_serializers's Issues

On-demand type generation not working

• I have tried upgrading by running bundle update types_from_serializers.
• I have read the troubleshooting section before opening an issue.

Description 📖

On demand generation on change not working, but I found a workaround that does the job for now.

Reproduction/Logs 🐞📜

Hi Máximo, thanks for another awesome gem.

I'm struggling a bit with the autogeneration of types. It seems to be initializing properly, and indeed tracking changes too.

If I make a change to a serializer, and then check the output of running Rails.application.reloaders in my console, I get the following output:

<TypesFromSerializers::Changes:0x0000ffff9862ec68 @added=#<Set: {}>, @modified=#<Set: {"/app/app/typed_serializers/my_serializer.rb"}>, @removed=#<Set: {}>>

So the tracking does seem to be working, but it nothing is ever re-generated, unless I explicitly call TypesFromSerializers.generate_changed in the rails console, then it works.

So I then tried forcing it by adding another hook in my initializer:

  Rails.application.reloader.to_prepare do
    puts "force serializer generation"
    TypesFromSerializers.generate_changed
  end

But at this stage, it doesn't seem to be aware of file changes. Like this hook has a different context to my rails console. So nothing happens.

As a workaround for now I changed this hook to:

  Rails.application.reloader.to_prepare do
    TypesFromSerializers.generate(force: true)
  end

And it works, and it's fast enough re-generating everything that it's an acceptable workaround.

So that's my issue, and I wanted to ask you if you have an idea why this may be happening? Just to mention I have also installed the listen gem.

Cheers!

Nested Serializers

Howdy! Given this serializer (in a single file, verbatim):

class FooSerializer < BaseSerializer
  class BarSerializer < BaseSerializer
    attributes :id
  end

  belongs_to :bar, serializer: BarSerializer
end

The generated TS file is invalid:

import type FooSerializerBar from './FooSerializer/Bar'

export default interface Foo {
  bar: FooSerializerBar
}

The ./FooSerializer/Bar does not exist.

Am I doing something wrong, or is this currently unsupported?

I find this pattern of nesting serializers is very useful when you need a representation of a child resource that depends on the parent context vs. having one large serializer in the base directory with a lot of flags/conditionals.

Cannot use name_from_serializer

• I have tried upgrading by running bundle update types_from_serializers.
• I have read the troubleshooting section before opening an issue.

Description 📖

When using:

if Rails.env.development?
  TypesFromSerializers.config do |config|
    config.name_from_serializer = ->(name) { name }
  end
end

and then issuing the command:

bundle exec rake types_from_serializers:generate

no serializers are found

bundle exec rake types_from_serializers:generate
Generating TypeScript interfaces...completed in 0.0 seconds.
Found 0 serializers:

while, when removing the line config.name_from_serializer = ->(name) { name }, everything works as it should.

I only wanted to make sure the generated types got a prefix, which should not interfere with the finding of serializers.