vite_rails 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09b3f9165e33562bd060ff1c5bc3cb2efb76a68d4de1bc3548a213110df6bba4'
-  data.tar.gz: 3aac713bfb90f0586c2309217b45d64bc394312ed5fb08be44391d3dcb68d459
+  metadata.gz: c1036b7b19ba86a9e76a58b29bac36a0e919bdadeac59846a37a13f5f5d3690b
+  data.tar.gz: 51fc54fa2138c581ca9f92182e14faa2108cba30084656718f7792c3bf5947b4
 SHA512:
-  metadata.gz: '08b9ee75915396e16078094f1870211e5667cc3f9edf9502844be884a556a6c9378bbcdef8374498761643fab94c0302930d18737d98ceaae013c0da0ac9f2d6'
-  data.tar.gz: 482461f60d07e91c99084f74089d10fe07ac2db20aad1c324a45f5b6fbb1f4f815dd436993c21798c4c18e116d5bee729b83abe08e85d02757637731a242d7b0
+  metadata.gz: 13857bbd2f3b308357b82663e140a1630699259274a5bab6c738c84444ab02aba67ef0b361a9598528f60186ec8a3748584885492026a36c928db77976ec7e5b
+  data.tar.gz: e15766ff9f599d4f0e18b2e1a30a3cd38182dc36efc479371c474f54ed0866c8451469952afc267f4247351592a3e6651010b2b5db28ac58e99e3bc60deef3f0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
-## Vite Rails 1.0.0
+## 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

@@ -33,7 +33,7 @@
 - 🤖 Automatic Entrypoint Detection
 - ⚡️ Hot Reload
 - ⚙️ Rake Tasks
-- 🪝 Hooks to <kbd>assets:precompile</kbd> and friends
+- 🤝 Integrated with <kbd>assets:precompile</kbd> and friends
 - And more! (detects changes, and builds automatically if Vite is not running)
 
 ## Documentation 📖

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/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,6 +2,8 @@
 
 # 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
@@ -12,30 +14,49 @@ module ViteRails::Helper
   # 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.4'
+  VERSION = '1.0.5'
 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.4
+  version: 1.0.5
 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
@@ -186,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.4
-  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.4/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.5
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.5/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: