RubyGems - vite_rails - Versions diffs - 1.0.1 → 1.0.6 - Mend

vite_rails 1.0.1 → 1.0.6

Files changed (18) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +13 -1
data/README.md +69 -2
data/lib/install/bin/vite +17 -0
data/lib/install/config/vite.config.ts +11 -0
data/lib/install/config/vite.json +14 -0
data/lib/install/javascript/entrypoints/application.js +18 -0
data/lib/install/template.rb +7 -29
data/lib/tasks/vite/build.rake +1 -1
data/lib/tasks/vite/info.rake +0 -1
data/lib/vite_rails.rb +6 -1
data/lib/vite_rails/config.rb +0 -2
data/lib/vite_rails/dev_server_proxy.rb +6 -4
data/lib/vite_rails/helper.rb +29 -8
data/lib/vite_rails/manifest.rb +16 -12
data/lib/vite_rails/version.rb +1 -1
data/package.json +4 -20
metadata +8 -4

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89b280f3a27da1896e3036c387874f6f2c5c0033aa3cb9f77cac84fecba57be3
-  data.tar.gz: 70e6f39a6f35af3e7a95cbd92cf7a2b9d2b4c0429335611ebf3cbab60386c775
+  metadata.gz: e6696b0e5605b6b818d3512247732ca61379c1c54ffd2da4d4fba9aa45b0fb9e
+  data.tar.gz: 679a936095a88dfbc9a03b3bf0fe04003ebde7aad4d4cf1b65bd2dcf23c2fd22
 SHA512:
-  metadata.gz: 7b97f37e3822e99622b2a668cd957a27aeb1a00b98efe3e750c90169f4ae8dc2312a4c7460de6b4582a8414a92b704b668c880190314fd1d3632002b3f77c587
-  data.tar.gz: 76cce62bdedfc515e62e1777746a7a39ebe500a0e8afbd5b7c9255372a984a1042747d7e8dc52d4992d03370649c677c7c603cab75d3a6b5c9af2c0c447ef0a9
+  metadata.gz: 4bf20acab3ed24be1785dcf2663d037ac4e026d1c73fb8a9b74b2487cda253a9e22b3e352930415296b1f746c9b777adfc664c2993664cfb2cb908e1b8850d1e
+  data.tar.gz: 44a029814b091587cd2d50589276cd1c757c18302e0155878c88c0e5cd0005353e24b32bc6c74205a0752291c5c24e51182b259e22f97c69ba16d713ebafbbe1

data/CHANGELOG.md CHANGED

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

@@ -22,6 +22,7 @@
 [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.
@@ -32,11 +33,12 @@
 - 🤖 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 📖
-Coming Soon!
+A documentation website is coming soon!
 ## Installation 💿
@@ -55,6 +57,71 @@ 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:
+```js
+import { createApp } from 'vue'
+import App from '~/App.vue'
+import '~/channels'
+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.
+```html
+<head>
+  <title>Joie</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= 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>
+```
+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"
+  }
+}
+```
+Check [this file][config file] to see all config options, documentation is coming soon.
 ## Inspiration 💡
 - [webpacker]

data/lib/install/bin/vite ADDED

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+ENV['RAILS_ENV'] ||= ENV['RACK_ENV'] || 'development'
+ENV['NODE_ENV']  ||= ENV['RAILS_ENV'] == 'development' ? 'development' : 'production'
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+require 'bundler/setup'
+require 'vite_rails'
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  ViteRails.run(ARGV)
+end

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

@@ -0,0 +1,11 @@
+import { defineConfig } from 'vite'
+import RubyPlugin from 'vite-plugin-ruby'
+export default defineConfig({
+  plugins: [
+    RubyPlugin(),
+  ],
+  optimizeDeps: {
+    exclude: [/webpack/, /vite-plugin-ruby/],
+  },
+})

data/lib/install/config/vite.json ADDED

@@ -0,0 +1,14 @@
+{
+  "all": {
+    "watchAdditionalPaths": []
+  },
+  "development": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-dev",
+    "port": 3036
+  },
+  "test": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-test"
+  }
+}

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

@@ -0,0 +1,18 @@
+// 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()
+// Example: Import a stylesheet in app/javascript/index.css
+// import '~/index.css'
+console.log('Vite ⚡️ Rails')

data/lib/install/template.rb CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

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

data/package.json CHANGED

@@ -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 CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 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
@@ -119,7 +119,11 @@ files:
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- lib/install/bin/vite
 - lib/install/binstubs.rb
+- lib/install/config/vite.config.ts
+- lib/install/config/vite.json
+- lib/install/javascript/entrypoints/application.js
 - lib/install/template.rb
 - lib/tasks/vite/binstubs.rake
 - lib/tasks/vite/build.rake
@@ -182,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.1
-  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.1/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.6
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.6/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: