docs: Add more help text in the example entrypoints

Thanks for the suggestion @maxjacobson!
ElMassimo · Mar 18, 2021 · 87d6f14 · 87d6f14
1 parent 6b76032
commit 87d6f14
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 29 deletions.
diff --git a/.gitignore b/.gitignore
@@ -47,3 +47,4 @@ selenium-server.log
 .env.*.local
 
 docs/pnpm-lock.yaml
+test/mounted_app/test/dummy/bin/vite
diff --git a/examples/rails/app/frontend/entrypoints/application.ts b/examples/rails/app/frontend/entrypoints/application.ts
@@ -15,3 +15,5 @@ import.meta.globEager('../channels/**/*_channel.js')
 
 Turbolinks.start()
 ActiveStorage.start()
+
+console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')
diff --git a/test/mounted_app/test/dummy/bin/vite b/test/mounted_app/test/dummy/bin/vite
diff --git a/vite_rails/lib/vite_rails/installation.rb b/vite_rails/lib/vite_rails/installation.rb
@@ -44,6 +44,15 @@ def install_sample_files
       inject_line_before layout_file, '</head>', <<-HTML
     <%= vite_client_tag %>
     <%= vite_javascript_tag 'application' %>
+    <!--
+      If using a TypeScript entrypoint file:
+        vite_typescript_tag 'application'
+
+      If using a .jsx or .tsx entrypoint, add the extension:
+        vite_javascript_tag 'application.jsx'
+
+      Visit the guide for more information: https://vite-ruby.netlify.app/guide/rails
+    -->
       HTML
     end
   end

diff --git a/vite_rails/templates/entrypoints/application.js b/vite_rails/templates/entrypoints/application.js
@@ -5,6 +5,14 @@
 //    <%= vite_javascript_tag 'application' %>
 console.log('Vite ⚡️ Rails')
 
+// If using a TypeScript entrypoint file:
+//     <%= vite_typecript_tag 'application.jsx' %>
+//
+// If you want to use .jsx or .tsx, add the extension:
+//     <%= vite_javascript_tag 'application.jsx' %>
+
+console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')
+
 // Example: Load Rails libraries in Vite.
 //
 // import '@rails/ujs'

diff --git a/vite_rails_legacy/lib/vite_rails_legacy/installation.rb b/vite_rails_legacy/lib/vite_rails_legacy/installation.rb
@@ -25,6 +25,15 @@ def install_sample_files
       inject_line_before layout_file, '</head>', <<-HTML
     <%= vite_client_tag %>
     <%= vite_javascript_tag 'application' %>
+    <!--
+      If using a TypeScript entrypoint file:
+        vite_typescript_tag 'application'
+
+      If using a .jsx or .tsx entrypoint, add the extension:
+        vite_javascript_tag 'application.jsx'
+
+      Visit the guide for more information: https://vite-ruby.netlify.app/guide/rails
+    -->
       HTML
     end
   end

diff --git a/vite_rails_legacy/templates/entrypoints/application.js b/vite_rails_legacy/templates/entrypoints/application.js
@@ -5,6 +5,14 @@
 //    <%= vite_javascript_tag 'application' %>
 console.log('Vite ⚡️ Rails')
 
+// If using a TypeScript entrypoint file:
+//     <%= vite_typecript_tag 'application.jsx' %>
+//
+// If you want to use .jsx or .tsx, add the extension:
+//     <%= vite_javascript_tag 'application.jsx' %>
+
+console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')
+
 // Example: Load Rails libraries in Vite.
 //
 // import '@rails/ujs'
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,3 +47,4 @@ selenium-server.log
		.env.*.local

		docs/pnpm-lock.yaml
		test/mounted_app/test/dummy/bin/vite
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,3 +15,5 @@ import.meta.globEager('../channels/*/_channel.js')

		Turbolinks.start()
		ActiveStorage.start()

		console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')