README.md

@sigbit/vite-plugin-rails-hmr

Experimental HMR for Rails templates

How does it work?

If a template file is changed, the current page will be re-fetched in the background and patched using snabbdom to support partial DOM updates. This plugin will use file tracing comments injected by the view_source_map gem to isolate DOM patches. The plugin also works without the gem, but without DOM isolation.

Get started

$ yarn add significantbit/vite-plugin-rails-hmr -D

vite.config.js

import { defineConfig } from 'vite'
import RubyPlugin from 'vite-plugin-ruby'
import RailsHmrPlugin from '@sigbit/vite-plugin-rails-hmr'

export default defineConfig({
  plugins: [
    RubyPlugin(),
    RailsHmrPlugin({
      // Default options
      files: ['app/**/*.{html,erb}']
    }),
  ],
})

app/frontend/entrypoints/application.js

import 'virtual:rails-hmr'

config/environments/development.rb

...
config.action_view.annotate_rendered_view_with_filenames = true
...

Caveats

This is only tested when importing the css in a js entrypoint. Using the vite_stylesheet_tag helper might not be working right.