-> Community documentation has been moved to the [Inertia Rails repository](https://github.com/inertiajs/inertia-rails).
->
-> Please visit the official Inertia Rails documentation at https://inertia-rails.dev.
-
## Installation
Install the gem and add to the application's Gemfile by executing:
@@ -20,139 +27,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
$ gem install inertia_rails-contrib
-## Usage
-
-### Installation generator
-
-`InertiaRailsContrib` comes with a generator that installs and sets up Inertia in a Rails application. It automatically detects if the [Vite Rails](https://vite-ruby.netlify.app/guide/rails.html) gem is installed and will attempt to install it if not present.
-
-To install and setup Inertia in a Rails application, execute the following command in the terminal:
-
-```bash
-bundle add inertia_rails-contrib
-bin/rails generate inertia:install
-```
-
-This command will:
-- Check for Vite Rails and install it if not present
-- Ask if you want to use TypeScript
-- Ask you to choose your preferred frontend framework (React, Vue, Svelte 4, or Svelte 5)
-- Ask if you want to install Tailwind CSS
-- Install necessary dependencies
-- Set up the application to work with Inertia
-- Copy example Inertia controller and views (can be skipped with the `--skip-example` option)
-
-Example output:
-
-```bash
-$ bin/rails generate inertia:install
-Installing Inertia's Rails adapter
-Could not find a package.json file to install Inertia to.
-Would you like to install Vite Ruby? (y/n) y
- run bundle add vite_rails from "."
-Vite Rails gem successfully installed
- run bundle exec vite install from "."
-Vite Rails successfully installed
-Would you like to use TypeScript? (y/n) y
-Adding TypeScript support
-What framework do you want to use with Inertia? [react, vue, svelte4, svelte] (react)
- run npm add @types/react @types/react-dom typescript --silent from "."
-Would you like to install Tailwind CSS? (y/n) y
-Installing Tailwind CSS
- run npm add tailwindcss postcss autoprefixer @tailwindcss/forms @tailwindcss/typography @tailwindcss/container-queries --silent from "."
- create tailwind.config.js
- create postcss.config.js
- create app/frontend/entrypoints/application.css
-Adding Tailwind CSS to the application layout
- insert app/views/layouts/application.html.erb
-Adding Inertia's Rails adapter initializer
- create config/initializers/inertia_rails.rb
-Installing Inertia npm packages
- run npm add @vitejs/plugin-react react react-dom --silent from "."
- run npm add @inertiajs/react@latest --silent from "."
-Adding Vite plugin for react
- insert vite.config.ts
- prepend vite.config.ts
-Copying inertia.ts entrypoint
- create app/frontend/entrypoints/inertia.ts
-Adding inertia.ts script tag to the application layout
- insert app/views/layouts/application.html.erb
-Adding Vite React Refresh tag to the application layout
- insert app/views/layouts/application.html.erb
- gsub app/views/layouts/application.html.erb
-Copying example Inertia controller
- create app/controllers/inertia_example_controller.rb
-Adding a route for the example Inertia controller
- route get 'inertia-example', to: 'inertia_example#index'
-Copying page assets
- create app/frontend/pages/InertiaExample.module.css
- create app/frontend/assets/react.svg
- create app/frontend/assets/inertia.svg
- create app/frontend/assets/vite_ruby.svg
- create app/frontend/pages/InertiaExample.tsx
- create tsconfig.json
- create tsconfig.app.json
- create tsconfig.node.json
- create app/frontend/vite-env.d.ts
-Copying bin/dev
- create bin/dev
-Inertia's Rails adapter successfully installed
-```
-
-With that done, you can now start the Rails server and the Vite development server (we recommend using [Overmind](https://github.com/DarthSim/overmind)):
-
-```bash
-bin/dev
-```
-
-And navigate to `http://localhost:3100/inertia-example` to see the example Inertia page.
-
-### Scaffold generator
-
-`InertiaRailsContrib` also comes with a scaffold generator that generates a new resource with Inertia responses. To use it, execute the following command in the terminal:
-
-```bash
-bin/rails generate inertia:scaffold ModelName field1:type field2:type
-```
-
-Example output:
-
-```bash
-$ bin/rails generate inertia:scaffold Post title:string body:text
- invoke active_record
- create db/migrate/20240611123952_create_posts.rb
- create app/models/post.rb
- invoke test_unit
- create test/models/post_test.rb
- create test/fixtures/posts.yml
- invoke resource_route
- route resources :posts
- invoke scaffold_controller
- create app/controllers/posts_controller.rb
- invoke inertia_templates
- create app/frontend/pages/Post
- create app/frontend/pages/Post/Index.svelte
- create app/frontend/pages/Post/Edit.svelte
- create app/frontend/pages/Post/Show.svelte
- create app/frontend/pages/Post/New.svelte
- create app/frontend/pages/Post/Form.svelte
- create app/frontend/pages/Post/Post.svelte
- invoke resource_route
- invoke test_unit
- create test/controllers/posts_controller_test.rb
- create test/system/posts_test.rb
- invoke helper
- create app/helpers/posts_helper.rb
- invoke test_unit
-```
-
-#### Tailwind CSS integration
-
-`InertiaRailsContrib` tries to detect the presence of Tailwind CSS in the application and generate the templates accordingly. If you want to specify templates type, use the `--inertia-templates` option:
-
-- `inertia_templates` - default
-- `inertia_tw_templates` - Tailwind CSS
-
## 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.
diff --git a/inertia_rails-contrib.gemspec b/inertia_rails-contrib.gemspec
index 9c815d7..12befb0 100644
--- a/inertia_rails-contrib.gemspec
+++ b/inertia_rails-contrib.gemspec
@@ -26,6 +26,5 @@ Gem::Specification.new do |spec|
spec.files = Dir["{app,lib}/**/*", "CHANGELOG.md", "LICENSE.txt", "README.md"]
spec.require_paths = ["lib"]
- spec.add_dependency "railties", ">= 6.0.0"
- spec.add_dependency "inertia_rails"
+ spec.add_dependency "inertia_rails", ">= 3.5.0"
end
diff --git a/lib/generators/inertia/controller/controller_generator.rb b/lib/generators/inertia/controller/controller_generator.rb
deleted file mode 100644
index fa5a0f3..0000000
--- a/lib/generators/inertia/controller/controller_generator.rb
+++ /dev/null
@@ -1,16 +0,0 @@
-require "rails/generators/rails/controller/controller_generator"
-require "inertia_rails_contrib/generators_helper"
-
-module Inertia
- module Generators
- class ControllerGenerator < Rails::Generators::ControllerGenerator
- include InertiaRailsContrib::GeneratorsHelper
-
- source_root File.expand_path("./templates", __dir__)
-
- remove_hook_for :template_engine
-
- hook_for :inertia_templates, required: true, default: InertiaRailsContrib::GeneratorsHelper.guess_inertia_template
- end
- end
-end
diff --git a/lib/generators/inertia/controller/templates/controller.rb.tt b/lib/generators/inertia/controller/templates/controller.rb.tt
deleted file mode 100644
index 53eb0eb..0000000
--- a/lib/generators/inertia/controller/templates/controller.rb.tt
+++ /dev/null
@@ -1,10 +0,0 @@
-<% module_namespacing do -%>
-class <%= class_name %>Controller < <%= parent_class_name.classify %>
-<% actions.each do |action| -%>
- def <%= action %>
- render inertia: '<%= "#{inertia_base_path}/#{action.camelize}" %>'
- end
-<%= "\n" unless action == actions.last -%>
-<% end -%>
-end
-<% end -%>
diff --git a/lib/generators/inertia/install/frameworks.yml b/lib/generators/inertia/install/frameworks.yml
deleted file mode 100644
index 6a11dc6..0000000
--- a/lib/generators/inertia/install/frameworks.yml
+++ /dev/null
@@ -1,98 +0,0 @@
-react:
- inertia_package: "@inertiajs/react"
- packages:
- - "@vitejs/plugin-react"
- - "react"
- - "react-dom"
- packages_ts:
- - "@types/react"
- - "@types/react-dom"
- - "typescript"
- vite_plugin_import: "import react from '@vitejs/plugin-react'"
- vite_plugin_call: "react()"
- copy_files_ts:
- "InertiaExample.tsx": "%{js_destination_path}/pages/InertiaExample.tsx"
- "tsconfig.json": "tsconfig.json"
- "tsconfig.app.json": "tsconfig.app.json"
- "tsconfig.node.json": "tsconfig.node.json"
- "vite-env.d.ts": "%{js_destination_path}/vite-env.d.ts"
- copy_files_js:
- "InertiaExample.jsx": "%{js_destination_path}/pages/InertiaExample.jsx"
- copy_files:
- "InertiaExample.module.css": "%{js_destination_path}/pages/InertiaExample.module.css"
- "../assets/react.svg": "%{js_destination_path}/assets/react.svg"
- "../assets/inertia.svg": "%{js_destination_path}/assets/inertia.svg"
- "../assets/vite_ruby.svg": "%{js_destination_path}/assets/vite_ruby.svg"
-
-vue:
- inertia_package: "@inertiajs/vue3"
- packages:
- - "vue"
- - "@vitejs/plugin-vue"
- packages_ts:
- - "typescript"
- - "vue-tsc"
- vite_plugin_import: "import vue from '@vitejs/plugin-vue'"
- vite_plugin_call: "vue()"
- copy_files:
- "../assets/vue.svg": "%{js_destination_path}/assets/vue.svg"
- "../assets/inertia.svg": "%{js_destination_path}/assets/inertia.svg"
- "../assets/vite_ruby.svg": "%{js_destination_path}/assets/vite_ruby.svg"
- copy_files_ts:
- "InertiaExample.ts.vue": "%{js_destination_path}/pages/InertiaExample.vue"
- "tsconfig.json": "tsconfig.json"
- "tsconfig.app.json": "tsconfig.app.json"
- "tsconfig.node.json": "tsconfig.node.json"
- "vite-env.d.ts": "%{js_destination_path}/vite-env.d.ts"
- copy_files_js:
- "InertiaExample.vue": "%{js_destination_path}/pages/InertiaExample.vue"
-
-svelte4:
- inertia_package: "@inertiajs/svelte"
- packages:
- - "svelte@4"
- - "@sveltejs/vite-plugin-svelte@3"
- packages_ts:
- - "@tsconfig/svelte@4"
- - "svelte-check"
- - "typescript"
- - "tslib"
- vite_plugin_import: "import { svelte } from '@sveltejs/vite-plugin-svelte'"
- vite_plugin_call: "svelte()"
- copy_files_ts:
- "InertiaExample.ts.svelte": "%{js_destination_path}/pages/InertiaExample.svelte"
- "tsconfig.json": "tsconfig.json"
- "tsconfig.node.json": "tsconfig.node.json"
- "vite-env.d.ts": "%{js_destination_path}/vite-env.d.ts"
- copy_files_js:
- "InertiaExample.svelte": "%{js_destination_path}/pages/InertiaExample.svelte"
- copy_files:
- "svelte.config.js": "svelte.config.js"
- "../assets/svelte.svg": "%{js_destination_path}/assets/svelte.svg"
- "../assets/inertia.svg": "%{js_destination_path}/assets/inertia.svg"
- "../assets/vite_ruby.svg": "%{js_destination_path}/assets/vite_ruby.svg"
-
-svelte:
- inertia_package: "@inertiajs/svelte"
- packages:
- - "svelte@5"
- - "@sveltejs/vite-plugin-svelte@4"
- packages_ts:
- - "@tsconfig/svelte@5"
- - "svelte-check"
- - "typescript"
- - "tslib"
- vite_plugin_import: "import { svelte } from '@sveltejs/vite-plugin-svelte'"
- vite_plugin_call: "svelte()"
- copy_files_ts:
- "InertiaExample.ts.svelte": "%{js_destination_path}/pages/InertiaExample.svelte"
- "tsconfig.json": "tsconfig.json"
- "tsconfig.node.json": "tsconfig.node.json"
- "vite-env.d.ts": "%{js_destination_path}/vite-env.d.ts"
- copy_files_js:
- "InertiaExample.svelte": "%{js_destination_path}/pages/InertiaExample.svelte"
- copy_files:
- "svelte.config.js": "svelte.config.js"
- "../assets/svelte.svg": "%{js_destination_path}/assets/svelte.svg"
- "../assets/inertia.svg": "%{js_destination_path}/assets/inertia.svg"
- "../assets/vite_ruby.svg": "%{js_destination_path}/assets/vite_ruby.svg"
diff --git a/lib/generators/inertia/install/helpers.rb b/lib/generators/inertia/install/helpers.rb
deleted file mode 100644
index 054b4a8..0000000
--- a/lib/generators/inertia/install/helpers.rb
+++ /dev/null
@@ -1,48 +0,0 @@
-module Inertia
- module Generators
- module Helpers
- ### FS Helpers
- def js_destination_path
- return ViteRuby.config.source_code_dir if defined?(ViteRuby)
- if file?("config/vite.json")
- source_code_dir = JSON.parse(File.read(file_path("config/vite.json"))).dig("all", "sourceCodeDir")
- return source_code_dir if source_code_dir
- end
-
- "app/frontend"
- end
-
- def js_destination_root
- file_path(js_destination_path)
- end
-
- def js_file_path(*relative_path)
- File.join(js_destination_root, *relative_path)
- end
-
- def file?(*relative_path)
- File.file?(file_path(*relative_path))
- end
-
- def file_path(*relative_path)
- File.join(destination_root, *relative_path)
- end
-
- # Interactivity Helpers
- def ask(*)
- unless options[:interactive]
- say_error "Specify all options when running the generator non-interactively.", :red
- exit(1)
- end
-
- super
- end
-
- def yes?(*)
- return false unless options[:interactive]
-
- super
- end
- end
- end
-end
diff --git a/lib/generators/inertia/install/install_generator.rb b/lib/generators/inertia/install/install_generator.rb
deleted file mode 100644
index 8315216..0000000
--- a/lib/generators/inertia/install/install_generator.rb
+++ /dev/null
@@ -1,286 +0,0 @@
-require "yaml"
-require "rails/generators"
-require "rails/generators/base"
-
-require_relative "helpers"
-
-module Inertia
- module Generators
- class InstallGenerator < Rails::Generators::Base
- include Helpers
-
- FRAMEWORKS = YAML.load_file(File.expand_path("./frameworks.yml", __dir__))
-
- source_root File.expand_path("./templates", __dir__)
-
- class_option :framework, type: :string,
- desc: "The framework you want to use with Inertia",
- enum: FRAMEWORKS.keys,
- default: nil
-
- class_option :inertia_version, type: :string, default: "latest",
- desc: "The version of Inertia.js to install"
-
- class_option :typescript, type: :boolean, default: false,
- desc: "Whether to use TypeScript"
-
- class_option :package_manager, type: :string, default: nil, enum: %w[npm yarn bun pnpm],
- desc: "The package manager you want to use to install Inertia's npm packages"
-
- class_option :interactive, type: :boolean, default: true,
- desc: "Whether to prompt for optional installations"
-
- class_option :install_tailwind, type: :boolean, default: false,
- desc: "Whether to install Tailwind CSS"
- class_option :install_vite, type: :boolean, default: false,
- desc: "Whether to install Vite Ruby"
- class_option :example_page, type: :boolean, default: true,
- desc: "Whether to add an example Inertia page"
-
- class_option :verbose, type: :boolean, default: false,
- desc: "Run the generator in verbose mode"
-
- remove_class_option :skip_namespace, :skip_collision_check
-
- def install
- say "Installing Inertia's Rails adapter"
-
- if inertia_resolved_version.version == "0"
- say_error "Could not find the Inertia.js package version #{options[:inertia_version]}.", :red
- exit(false)
- end
-
- install_vite unless ruby_vite_installed?
-
- install_typescript if typescript?
-
- install_tailwind if install_tailwind?
-
- install_inertia
-
- install_example_page if options[:example_page]
-
- say "Copying bin/dev"
- copy_file "#{__dir__}/templates/dev", "bin/dev"
- chmod "bin/dev", 0o755, verbose: verbose?
-
- say "Inertia's Rails adapter successfully installed", :green
- end
-
- private
-
- def install_inertia
- say "Adding Inertia's Rails adapter initializer"
- template "initializer.rb", file_path("config/initializers/inertia_rails.rb")
-
- say "Installing Inertia npm packages"
- add_packages(*FRAMEWORKS[framework]["packages"])
- add_packages(inertia_package)
-
- unless File.read(vite_config_path).include?(FRAMEWORKS[framework]["vite_plugin_import"])
- say "Adding Vite plugin for #{framework}"
- insert_into_file vite_config_path, "\n #{FRAMEWORKS[framework]["vite_plugin_call"]},", after: "plugins: ["
- prepend_file vite_config_path, "#{FRAMEWORKS[framework]["vite_plugin_import"]}\n"
- end
-
- say "Copying #{inertia_entrypoint} entrypoint"
- template "#{framework}/#{inertia_entrypoint}", js_file_path("entrypoints/#{inertia_entrypoint}")
-
- if application_layout.exist?
- say "Adding #{inertia_entrypoint} script tag to the application layout"
- headers = <<-ERB
- <%= #{vite_tag} "inertia" %>
- <%= inertia_headers %>
- ERB
- insert_into_file application_layout.to_s, headers, after: "<%= vite_client_tag %>\n"
-
- if framework == "react" && !application_layout.read.include?("vite_react_refresh_tag")
- say "Adding Vite React Refresh tag to the application layout"
- insert_into_file application_layout.to_s, "<%= vite_react_refresh_tag %>\n ", before: "<%= vite_client_tag %>"
- end
-
- gsub_file application_layout.to_s, /