vite_rails 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a21a899a4c8bb0f107bdb5947e73654aa4ff4f5c8096655fca6afbf3230bca07
-  data.tar.gz: c58dac4d02a4d63b65e0b520b5b124b2b6e4e0d02324fe1a99f6d76b24639778
+  metadata.gz: 7f4c178774d28f47732953d6d672db2b2551030534b7a607f157e4692e992160
+  data.tar.gz: 9cb4eeab752ca23b2857487b1217d7e3f5b73afa72663ea8e01372328129368f
 SHA512:
-  metadata.gz: 3c15259b8704298bdf8ac0a63d93960c75d1f977de62645e9e855d644cb29d1de270e0e1a1357edfe468c816264c9136af3cab1226b13eb3ef2e9aea83f89b8e
-  data.tar.gz: 1ba34b6164b4d0321f402fb3a96df166fa36f98539f3403aa1add892bdc1c056e836456970758349dc8db0189f13e96413bbbf1dd7f88fa6d116b232efe18710
+  metadata.gz: 99ce8a2425f5eeaac8715f6204ec19b80d7b215dfe427cd765f25023c0fb82e72b086cf883e0e36931b4ae8f70457910fd57d21a59258befe139456e89bb130e
+  data.tar.gz: e693145af6596c602eac3136ada51393bf2dd9e06d5d8372739dbef84d811cc8bc3e689411ba308f8535bbeafa0356e8f26452342d2bba9a05132fd839588623

data/CHANGELOG.md

@@ -1,3 +1,19 @@
-## Vite Rails 1.0.0
+## Vite Rails 1.0.7  (2020-01-20)
+
+- Add `vite_client_tag` to ensure the Vite client can be loaded in apps that don't use any imports.
+
+## Vite Rails 1.0.6  (2020-01-20)
+
+- Ensure running `bin/rake assets:precompile` automatically invokes `vite:build`.
+
+## Vite Rails 1.0.5  (2020-01-20)
+
+- Automatically add `<link rel="modulepreload">` and `<link rel="stylesheet">` when using `vite_javascript_tag`, which simplifies usage.
+
+## Vite Rails 1.0.4  (2020-01-19)
+
+- Remove Vue specific examples from installation templates, to ensure they always run.
+
+## Vite Rails 1.0.0 (2020-01-18)
 
 Initial Version

data/README.md

@@ -19,24 +19,30 @@
   </p>
 </h1>
 
+[website]: https://vite-rails.netlify.app/
+[features]: https://vite-rails.netlify.app/guide/introduction.html
+[guides]: https://vite-rails.netlify.app/guide/
+[config]: https://vite-rails.netlify.app/config/
 [vite_rails]: https://github.com/ElMassimo/vite_rails
 [webpacker]: https://github.com/rails/webpacker
 [vite]: http://vitejs.dev/
+[config file]: https://github.com/ElMassimo/vite_rails/blob/main/package/default.vite.json
 
-[__Vite Rails__][vite_rails] allows you to use [Vite] to power the frontend.
+[__Vite Rails__][vite_rails] allows you to use [Vite] to power the frontend of your Rails app.
 
 [Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
 
 ## Features ⚡️
 
-- 🤖 Automatic Entrypoint Detection
-- ⚡️ Hot Reload
-- ⚙️ Rake Tasks
-- 🪝 Hooks to <kbd>assets:precompile</kbd> and friends
+- 🤖 Automatic entrypoint detection
+- ⚡️ Blazing fast hot reload
+- 🚀 Zero-config deployments
+- 🤝 Integrated with <kbd>assets:precompile</kbd>
+- [And more!][features]
 
 ## Documentation 📖
 
-Coming Soon!
+Visit the [documentation website][website] to check out the [guides] and searchable [configuration reference].
 
 ## Installation 💿
 
@@ -55,6 +61,23 @@ bin/rake vite:install
 
 This will generate configuration files and a sample setup.
 
+Additional installation instructions are available in the [documentation website][website].
+
+## Getting Started 💻
+
+Restart your Rails server, and then run `bin/vite` to start the Vite development server.
+
+Add the following your `views/layouts/application.html.erb`:
+
+```erb
+<%= vite_client_tag %>
+<%= vite_javascript_tag 'application' %>
+```
+
+Visit any page and you should see a printed console output: `Vite ⚡️ Rails`.
+
+For more [guides] and a full [configuration reference], check the [documentation website][website].
+
 ## Inspiration 💡
 
 - [webpacker]

data/lib/install/config/vite.config.ts

@@ -1,10 +1,8 @@
 import { defineConfig } from 'vite'
-import VuePlugin from '@vitejs/plugin-vue'
 import RubyPlugin from 'vite-plugin-ruby'
 
 export default defineConfig({
   plugins: [
-    VuePlugin(),
     RubyPlugin(),
   ],
   optimizeDeps: {

data/lib/install/javascript/entrypoints/application.js

@@ -1,16 +1,18 @@
-import '@rails/ujs'
-import Turbolinks from 'turbolinks'
-import ActiveStorage from '@rails/activestorage'
-import { createApp } from 'vue'
+// Example: Load Rails libraries in Vite.
+//
+// import '@rails/ujs'
+//
+// import Turbolinks from 'turbolinks'
+// import ActiveStorage from '@rails/activestorage'
+//
+// // Import all channels.
+// import.meta.globEager('./**/*_channel.js')
+//
+// Turbolinks.start()
+// ActiveStorage.start()
 
-import App from '~/App.vue'
-import '~/channels'
-import '../../stylesheets/index.css'
-
-Turbolinks.start()
-ActiveStorage.start()
+// Example: Import a stylesheet in app/javascript/index.css
+// import '~/index.css'
 
 console.log('Vite ⚡️ Rails')
 
-createApp(App).mount('#app')
-

data/lib/install/template.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-# Install ViteRails
+# Install Vite Rails
+say 'Creating configuration files'
 copy_file "#{ __dir__ }/config/vite.json", ViteRails.config.config_path
+copy_file "#{ __dir__ }/config/vite.config.ts", Rails.root.join('vite.config.ts')
 
-if Dir.exist?(ViteRails.config.source_code_dir)
-  say 'The JavaScript app source directory already exists. Move it and try again to see a basic setup.'
-else
-  say 'Creating JavaScript app source directory'
-  directory "#{ __dir__ }/javascript", ViteRails.config.source_code_dir
-end
+say 'Creating entrypoints directory'
+directory "#{ __dir__ }/javascript/entrypoints", ViteRails.config.source_code_dir.join(ViteRails.config.entrypoints_dir)
 
 apply "#{ __dir__ }/binstubs.rb"
 
@@ -28,14 +26,6 @@ if git_ignore_path.exist?
   }
 end
 
-install = if Rails.root.join('yarn.lock').exist?
-  'yarn add'
-elsif Rails.root.join('pnpm-lock.yaml').exist?
-  'pnpm install'
-else
-  'npm install'
-end
-
 Dir.chdir(Rails.root) do
   say 'Installing JavaScript dependencies for Vite Rails'
   package_json = File.read("#{ __dir__ }/../../package.json")
@@ -44,19 +34,7 @@ Dir.chdir(Rails.root) do
   plugin_version = package_json.match(/"vite-plugin-ruby": "(.*)"/)[1]
 
   say 'Installing vite as direct dependencies'
-  run "#{ install } vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
-end
-
-if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
-  src = begin
-          "#{ ViteRails.config.protocol }://#{ ViteRails.config.host_with_port }"
-        rescue StandardError
-          'http://localhost:3036'
-        end
-  say 'You need to allow vite-dev-server host as allowed origin for connect-src.', :yellow
-  say 'This can be done in Rails 5.2+ for development environment in the CSP initializer', :yellow
-  say 'config/initializers/content_security_policy.rb with a snippet like this:', :yellow
-  say %(policy.connect_src :self, :https, "http://#{ src }", "ws://#{ src }" if Rails.env.development?), :yellow
+  run "yarn add vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
 end
 
-say 'ViteRails successfully installed 🎉 🍰', :green
+say 'Vite ⚡️ Rails successfully installed! 🎉', :green

data/lib/tasks/vite/build.rake

@@ -3,7 +3,7 @@
 $stdout.sync = true
 
 def enhance_assets_precompile
-  Rake::Task['assets:precompile'] do |task|
+  Rake::Task['assets:precompile'].enhance do |task|
     prefix = task.name.split(/#|assets:precompile/).first
 
     Rake::Task["#{ prefix }vite:build"].invoke

data/lib/tasks/vite/info.rake

@@ -14,7 +14,6 @@ namespace :vite do
       $stdout.puts "vite-plugin-ruby: \n#{ `npm list vite-plugin-ruby version` }"
 
       $stdout.puts "Is bin/vite present?: #{ File.exist? 'bin/vite' }"
-      $stdout.puts "Is bin/vite-dev-server present?: #{ File.exist? 'bin/vite-dev-server' }"
       $stdout.puts "Is bin/yarn present?: #{ File.exist? 'bin/yarn' }"
     end
   end

data/lib/vite_rails.rb

@@ -22,7 +22,7 @@ class ViteRails
   cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
 
   class << self
-    delegate :config, :builder, :manifest, :commands, :dev_server, to: :instance
+    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, to: :instance
     delegate :mode, to: :config
     delegate :bootstrap, :clean, :clobber, :build, to: :commands
 
@@ -62,6 +62,11 @@ class ViteRails
     end
   end
 
+  # Public: Returns true if the Vite development server is running.
+  def dev_server_running?
+    ViteRails.run_proxy? && dev_server.running?
+  end
+
   # Public: Current instance configuration for Vite.
   def config
     @config ||= ViteRails::Config.resolve_config

data/lib/vite_rails/config.rb

@@ -66,8 +66,6 @@ private
     # Internal: Used to load a JSON file from the specified path.
     def load_json(path)
       JSON.parse(File.read(File.expand_path(path))).deep_transform_keys(&:underscore)
-    rescue => error
-      (require 'pry-byebug';binding.pry;);
     end
 
     # Internal: Retrieves a configuration option from environment variables.

data/lib/vite_rails/dev_server_proxy.rb

@@ -14,7 +14,7 @@ class ViteRails::DevServerProxy < Rack::Proxy
 
   # Rack: Intercept asset requests and send them to the Vite server.
   def perform_request(env)
-    if vite_should_handle?(env['REQUEST_URI']) && dev_server.running?
+    if vite_should_handle?(env['REQUEST_URI'], env['HTTP_REFERER']) && dev_server.running?
       env['REQUEST_URI'] = env['REQUEST_URI']
         .sub(vite_asset_url_prefix, '/')
         .sub('.ts.js', '.ts') # Patch: Rails helpers always append the extension.
@@ -36,9 +36,11 @@ private
 
   delegate :config, :dev_server, to: :@vite_rails
 
-  def vite_should_handle?(url)
-    url.start_with?(vite_asset_url_prefix) || url.start_with?(VITE_DEPENDENCY_PREFIX) ||
-      url.include?('?t=') # Direct Hot Reload
+  def vite_should_handle?(url, referer)
+    return true if url.start_with?(vite_asset_url_prefix) # Vite Asset
+    return true if url.start_with?(VITE_DEPENDENCY_PREFIX) # Vite Package Asset
+    return true if url.include?('?t=') # Hot Reload
+    return true if referer && URI.parse(referer).path.start_with?(vite_asset_url_prefix) # Entry Imported from another Entry.
   end
 
   def vite_asset_url_prefix

data/lib/vite_rails/helper.rb

@@ -2,40 +2,66 @@
 
 # Public: Allows to render HTML tags for scripts and styles processed by Vite.
 module ViteRails::Helper
+  DEFAULT_VITE_SKIP_PRELOAD_TAGS = Rails::VERSION::MAJOR <= 5 && Rails::VERSION::MINOR < 2
+
   # Public: Returns the current Vite Rails instance.
   def current_vite_instance
     ViteRails.instance
   end
 
+  # Public: Renders a script tag for vite/client to enable HMR in development.
+  def vite_client_tag
+    content_tag('script', '', src: '/@vite/client', type: 'module') if ViteRails.dev_server_running?
+  end
+
   # Public: Computes the relative path for the specified given Vite asset.
   #
   # Example:
   #   <%= vite_asset_path 'calendar.css' %> # => "/vite/assets/calendar-1016838bab065ae1e122.css"
   def vite_asset_path(name, **options)
-    current_vite_instance.manifest.lookup!(name, **options)
+    current_vite_instance.manifest.lookup!(name, **options).fetch('file')
   end
 
   # Public: Renders a <script> tag for the specified Vite entrypoints.
-  def vite_javascript_tag(*names, type: 'module', **options)
-    javascript_include_tag(*sources_from_vite_manifest_entrypoints(names, type: :javascript), type: type, **options)
+  def vite_javascript_tag(*names,
+                          type: 'module',
+                          asset_type: :javascript,
+                          skip_preload_tags: DEFAULT_VITE_SKIP_PRELOAD_TAGS,
+                          skip_style_tags: false,
+                          crossorigin: 'anonymous',
+                          **options)
+    js_entries = names.map { |name| current_vite_instance.manifest.lookup!(name, type: asset_type) }
+    js_tags = javascript_include_tag(*js_entries.map { |entry| entry['file'] }, type: type, crossorigin: crossorigin, **options)
+
+    unless skip_preload_tags || ViteRails.dev_server_running?
+      preload_paths = js_entries.flat_map { |entry| entry['imports'] }.compact.uniq
+      preload_tags = preload_paths.map { |path| preload_link_tag(path, crossorigin: crossorigin) }
+    end
+
+    unless skip_style_tags || ViteRails.dev_server_running?
+      style_paths = names.map { |name| current_vite_instance.manifest.lookup(name, type: :stylesheet)&.fetch('file') }.compact
+      style_tags = stylesheet_link_tag(*style_paths)
+    end
+
+    safe_join [js_tags, preload_tags, style_tags]
   end
 
   # Public: Renders a <script> tag for the specified Vite entrypoints.
   #
   # NOTE: Because TypeScript is not a valid target in browsers, we only specify
   # the ts file when running the Vite development server.
-  def vite_typescript_tag(*names, type: 'module', **options)
-    javascript_include_tag(*sources_from_vite_manifest_entrypoints(names, type: :typescript), type: type, **options)
+  def vite_typescript_tag(*names, **options)
+    vite_javascript_tag(*names, asset_type: :typescript, **options)
   end
 
   # Public: Renders a <link> tag for the specified Vite entrypoints.
   def vite_stylesheet_tag(*names, **options)
-    stylesheet_link_tag(*sources_from_vite_manifest_entrypoints(names, type: :stylesheet), **options)
+    stylesheet_link_tag(*sources_from_vite_manifest(names, type: :stylesheet), **options)
   end
 
 private
 
-  def sources_from_vite_manifest_entrypoints(names, type:)
-    names.flat_map { |name| vite_asset_path(name, type: type) }.uniq
+  def sources_from_vite_manifest(names, type:)
+    names.map { |name| vite_asset_path(name, type: type) }
   end
 end

data/lib/vite_rails/manifest.rb

@@ -5,7 +5,7 @@
 #
 # Example:
 #   lookup_entrypoint('calendar', type: :javascript)
-#   => "/vite/assets/calendar-1016838bab065ae1e314.js"
+#   => { "file" => "/vite/assets/calendar-1016838bab065ae1e314.js", "imports" => [] }
 #
 # NOTE: Using "autoBuild": true` in `config/vite.json` file will trigger a build
 # on demand as needed, before performing any lookup.
@@ -29,7 +29,8 @@ class ViteRails::Manifest
   # Returns a relative path, or nil if the asset is not found.
   #
   # Example:
-  #   ViteRails.manifest.lookup('calendar.js') # => "/vite/assets/calendar-1016838bab065ae1e122.js"
+  #   ViteRails.manifest.lookup('calendar.js')
+  #   # { "file" => "/vite/assets/calendar-1016838bab065ae1e122.js", "imports" => [] }
   def lookup(name, type:)
     build if should_build?
 
@@ -43,12 +44,7 @@ class ViteRails::Manifest
 
 private
 
-  delegate :config, :builder, :dev_server, to: :@vite_rails
-
-  # Public: Returns true if the Vite development server is running.
-  def dev_server_running?
-    ViteRails.run_proxy? && dev_server.running?
-  end
+  delegate :config, :builder, :dev_server_running?, to: :@vite_rails
 
   # NOTE: Auto compilation is convenient when running tests, when the developer
   # won't focus on the frontend, or when running the Vite server is not desired.
@@ -59,9 +55,9 @@ private
   # Internal: Finds the specified entry in the manifest.
   def find_manifest_entry(name)
     if dev_server_running?
-      "/#{ config.public_output_dir.join(name.to_s) }"
-    elsif file = manifest.dig(name.to_s, 'file')
-      "/#{ config.public_output_dir.join(file) }"
+      { 'file' => "/#{ config.public_output_dir.join(name.to_s) }" }
+    else
+      manifest[name.to_s]
     end
   end
 
@@ -83,7 +79,10 @@ private
   # Internal: Returns a Hash with the entries in the manifest.json.
   def load_manifest
     if config.manifest_path.exist?
-      JSON.parse(config.manifest_path.read)
+      JSON.parse(config.manifest_path.read).each do |_, entry|
+        entry['file'] = within_public_output_dir(entry['file'])
+        entry['imports'] = entry['imports']&.map { |path| within_public_output_dir(path) }
+      end
     else
       {}
     end
@@ -96,6 +95,11 @@ private
     "#{ name }.#{ extension_for_type(entry_type) }"
   end
 
+  # Internal: Scopes the paths in the manifest to the output folder in public.
+  def within_public_output_dir(path)
+    "/#{ config.public_output_dir.join(path) }"
+  end
+
   # Internal: Allows to receive :javascript and :stylesheet as :type in helpers.
   def extension_for_type(entry_type)
     case entry_type

data/lib/vite_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ViteRails
-  VERSION = '1.0.2'
+  VERSION = '1.0.7'
 end

data/package.json

@@ -2,27 +2,11 @@
   "name": "only-for-workflows",
   "version": "unknown",
   "scripts": {
-    "test": "jest",
-    "lint": "eslint package/"
+    "lint": "npm -C package run lint",
+    "test": "npm -C package run test"
   },
   "dependencies": {
-    "vite": "^2.0.0-beta.30",
-    "vite-plugin-ruby": "1.0.0"
-  },
-  "devDependencies": {
-    "@vitejs/plugin-vue": "^1.0.6",
-    "eslint": "^7.16.0",
-    "eslint-config-airbnb": "^18.2.0",
-    "eslint-config-prettier": "^7.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jsx-a11y": "^6.3.1",
-    "eslint-plugin-react": "^7.21.4",
-    "jest": "^26.5.3"
-  },
-  "jest": {
-    "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$",
-    "roots": [
-      "<rootDir>/package"
-    ]
+    "vite": "^2.0.0-beta.34",
+    "vite-plugin-ruby": "^1.0.1"
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,13 +123,7 @@ files:
 - lib/install/binstubs.rb
 - lib/install/config/vite.config.ts
 - lib/install/config/vite.json
-- lib/install/javascript/App.vue
-- lib/install/javascript/assets/logo.png
-- lib/install/javascript/channels/consumer.js
-- lib/install/javascript/channels/index.js
-- lib/install/javascript/components/HelloWorld.vue
 - lib/install/javascript/entrypoints/application.js
-- lib/install/javascript/stylesheets/index.css
 - lib/install/template.rb
 - lib/tasks/vite/binstubs.rake
 - lib/tasks/vite/build.rake
@@ -192,8 +186,8 @@ homepage: https://github.com/ElMassimo/vite_rails
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.2
-  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.2/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.7
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.7/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/install/javascript/App.vue

@@ -1,27 +0,0 @@
-<script>
-import { defineComponent } from 'vue'
-import HelloWorld from '~/components/HelloWorld.vue'
-
-export default defineComponent({
-  name: 'App',
-  components: {
-    HelloWorld
-  }
-})
-</script>
-
-<style>
-#app {
-  font-family: Avenir, Helvetica, Arial, sans-serif;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-  text-align: center;
-  color: #2c3e50;
-  margin-top: 60px;
-}
-</style>
-
-<template>
-  <img alt="Vue logo" src="../assets/logo.png" />
-  <HelloWorld class="strange" msg="Hello Vue 3 + Vite" />
-</template>

data/lib/install/javascript/channels/consumer.js

@@ -1,4 +0,0 @@
-// Action Cable provides the framework to deal with WebSockets in Rails.
-// You can generate new channels where WebSocket features live using the `rails generate channel` command.
-import { createConsumer } from "@rails/actioncable"
-export default createConsumer()

data/lib/install/javascript/channels/index.js

@@ -1,3 +0,0 @@
-// Load all the channels within this directory and all subdirectories.
-// Channel files must be named *_channel.js.
-import.meta.globEager('./**/*_channel.js')

data/lib/install/javascript/components/HelloWorld.vue

@@ -1,53 +0,0 @@
-<script>
-import { ref, defineComponent } from 'vue'
-
-export default defineComponent({
-  name: 'HelloWorld',
-  props: {
-    msg: { type: String, required: true }
-  },
-  setup: () => {
-    const count = ref(0)
-    return { count }
-  }
-})
-</script>
-
-<style scoped>
-a {
-  color: #42b983;
-}
-</style>
-
-<template>
-  <h1 v-bind="$attrs">{{ msg }}</h1>
-  <p>
-    <a href="https://vitejs.dev/guide/features.html" target="_blank">Vite Documentation</a> |
-    <a href="https://v3.vuejs.org/" target="_blank">Vue 3 Documentation</a>
-  </p>
-
-  <p>
-    Recommended setup:
-    <a href="https://code.visualstudio.com/" target="_blank">VSCode</a>
-    +
-    <a
-      href="https://marketplace.visualstudio.com/items?itemName=octref.vetur"
-      target="_blank"
-    >Vetur</a>
-    +
-    <a
-      href="https://marketplace.visualstudio.com/items?itemName=znck.vue-language-features"
-      target="_blank"
-    >Vue DX</a>
-  </p>
-  <p>
-    Make sure to use workspace version of TypeScript to get improved support via
-    <a
-      href="https://github.com/znck/vue-developer-experience"
-      target="_blank"
-    >@vuedx</a>.
-    <br />Note @vuedx is still experimental and this setup is provided for early feedback.
-  </p>
-  <button name="Counter" @click="count++">count is: {{ count }}</button>
-  <p>Edit <code>components/HelloWorld.vue</code> to test hot module replacement.</p>
-</template>

data/lib/install/javascript/stylesheets/index.css

@@ -1,3 +0,0 @@
-body {
-  background: red;
-}