vite_rails 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4596570b8e1f1df1839336f50463239af3bb3c251769b7bfa7be112d245a0f3
-  data.tar.gz: 226884d61c9e133381b025e14dbbd1c9cca922cac7bf52cd9fe5ae77ec2d6550
+  metadata.gz: 01d2a1c3a1fb46873e2b8057e91829a74e6c52a010941ec8abe6ca8055242b71
+  data.tar.gz: 8fbe4d912f70e84631a0131cfc884e4dd547f10105955d6fb1c877d69a22c03c
 SHA512:
-  metadata.gz: 405f84061588ece09e3f52d4137c27421d80f74826c5e6c7fe82ec7691abf703236a1cc13a265006c6f99673511f6ab0ae236028aa9a225c41a7595dde4218fb
-  data.tar.gz: cc212a87a1b4a5f678866d3e42d1c751465544badff3ecb58d462b59a6dbedc339e89d6e3b9b1fc43f14d4171d4a4115bc580f7493f992ad03a0cae086a9bb8f
+  metadata.gz: 2807123abe076535c1b5a918d5d6d303b137e1e8025d036692162313ed479500db1fd09ba153e355e33b1a58a9072d19c17b17dc147cd09f841cceffb8d12daa
+  data.tar.gz: 2200102393275515c8dc4ef981a9676460f27e35d48bba8c906535401aea934b5cd08fddbc19bd61bf7aaaf385c2fc7f27ca99eddca12f2ea364373fb7d2fde0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
-## Vite Rails 1.0.0
+## Vite Rails 1.0.8  (2020-01-20)
+
+- Change the default of `sourceCodeDir` to `app/frontend`, add instructions for folks migrating
+from a `app/javascript` structure.
+
+## 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,26 +19,35 @@
   </p>
 </h1>
 
+[website]: https://vite-rails.netlify.app/
+[configuration reference]: https://vite-rails.netlify.app/config/
+[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
+[example app]: https://github.com/ElMassimo/vite_rails/tree/main/examples/blog
+[heroku]: https://vite-rails-demo.herokuapp.com/
 
-[__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! 😍
 
+Check an [example app] running on [Heroku].
+
 ## Features ⚡️
 
-- 🤖 Automatic Entrypoint Detection
-- ⚡️ Hot Reload
-- ⚙️ Rake Tasks
-- 🪝 Hooks to <kbd>assets:precompile</kbd> and friends
-- And more! (detects changes, and builds automatically if Vite is not running)
+- 🤖 Automatic entrypoint detection
+- ⚡️ Blazing fast hot reload
+- 🚀 Zero-config deployments
+- 🤝 Integrated with <kbd>assets:precompile</kbd>
+- [And more!][features]
 
 ## Documentation 📖
 
-A documentation website is coming soon!
+Visit the [documentation website][website] to check out the [guides] and searchable [configuration reference].
 
 ## Installation 💿
 
@@ -57,74 +66,27 @@ bin/rake vite:install
 
 This will generate configuration files and a sample setup.
 
-## Usage 🚀
-
-Drawing inspiration from [webpacker], any files in `app/javascript/entrypoints`
-will be considered entries to your application (SPAs or pages).
-
-These files will be detected, and passed on to Vite, all configuration is done
-for you.
-
-### Imports ⤵️
-
-For convenience, a `~/` import alias is configured to `app/javascript`, allowing
-you to use absolute paths:
+Additional installation instructions are available in the [documentation website][website].
 
-```js
-import { createApp } from 'vue'
-import App from '~/App.vue'
-import '~/channels'
+## Getting Started 💻
 
-createApp(App).mount('#app')
-```
-
-### Tags 🏷
-
-`vite_typescript_tag`, `vite_javascript_tag`, and `vite_stylesheet_tag` can be
-used to output `<script>` and `<link>` tags in your Rails layouts or templates.
+Restart your Rails server, and then run <kbd>bin/vite</kbd> to start the Vite development server.
 
-```html
-<head>
-  <title>Joie</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
+Add the following your `views/layouts/application.html.erb`:
 
-  <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
-  <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
-
-  <%= vite_stylesheet_tag 'strange' %>
-  <%= vite_typescript_tag 'application' %>
-</head>
+```erb
+<%= vite_client_tag %>
+<%= vite_javascript_tag 'application' %>
 ```
 
-For other types of assets, you can use `vite_asset_path` and pass that to the appropriate tag helper.
-
-## Configuration ⚙️
-
-This is what your `config/vite.json` might look like:
-
-```json
-{
-  "all": {
-    "watchAdditionalPaths": []
-  },
-  "development": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-dev",
-    "port": 3036
-  },
-  "test": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-test"
-  }
-}
-```
+Visit any page and you should see a printed console output: `Vite ⚡️ Rails`.
 
-Check [this file][config file] to see all config options, documentation is coming soon.
+For more [guides] and a full [configuration reference], check the [documentation website][website].
 
-## Inspiration 💡
+## Special Thanks 🙏
 
 - [webpacker]
+- [vite]
 
 ## License
 

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

@@ -1,3 +1,10 @@
+// To see this message, add the following to the `<head>` section in your
+// views/layouts/application.html.erb
+//
+//    <%= vite_client_tag %>
+//    <%= vite_javascript_tag 'application' %>
+console.log('Vite ⚡️ Rails')
+
 // Example: Load Rails libraries in Vite.
 //
 // import '@rails/ujs'
@@ -11,8 +18,5 @@
 // Turbolinks.start()
 // ActiveStorage.start()
 
-// Example: Import a stylesheet in app/javascript/index.css
+// Example: Import a stylesheet in app/frontend/index.css
 // import '~/index.css'
-
-console.log('Vite ⚡️ Rails')
-

data/lib/install/template.rb

@@ -3,7 +3,7 @@
 # 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
+copy_file "#{ __dir__ }/config/vite.config.ts", Rails.root.join('vite.config.ts')
 
 say 'Creating entrypoints directory'
 directory "#{ __dir__ }/javascript/entrypoints", ViteRails.config.source_code_dir.join(ViteRails.config.entrypoints_dir)
@@ -26,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")
@@ -42,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/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.3'
+  VERSION = '1.0.8'
 end

data/package.json

@@ -2,27 +2,15 @@
   "name": "only-for-workflows",
   "version": "unknown",
   "scripts": {
-    "test": "jest",
-    "lint": "eslint package/"
+    "docs": "npm -C docs run docs",
+    "docs:build": "npm -C docs run docs:build",
+    "docs:search": "npm -C docs run docs:search",
+    "docs:lint": "npm -C docs run lint",
+    "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.2"
   }
 }

data/package/default.vite.json

@@ -6,7 +6,7 @@
   "configPath": "config/vite.json",
   "publicDir": "public",
   "entrypointsDir": "entrypoints",
-  "sourceCodeDir": "app/javascript",
+  "sourceCodeDir": "app/frontend",
   "host": "localhost",
   "https": null,
   "port": 3036,

data/test/test_app/app/javascript/entrypoints/application.js

@@ -1,10 +1,2 @@
 /* eslint no-console:0 */
-// This file is automatically compiled by Vite, along with any other files
-// present in this directory. You're encouraged to place your actual application logic in
-// a relevant structure within app/javascript and only use these pack files to reference
-// that code so it'll be compiled.
-//
-// To reference this file, add <%= javascript_pack_tag 'application' %> to the appropriate
-// layout file, like app/views/layouts/application.html.erb
-
 console.log('Hello World from ViteRails')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.8
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-21 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.3
-  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.3/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.8
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.8/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: