vite_rails 1.0.7 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f4c178774d28f47732953d6d672db2b2551030534b7a607f157e4692e992160
-  data.tar.gz: 9cb4eeab752ca23b2857487b1217d7e3f5b73afa72663ea8e01372328129368f
+  metadata.gz: 57f866deafddde5401e02ec27cf751eb26a40a0be1fd832d9d3813fd7a69e721
+  data.tar.gz: 7cf22c583a3ac70f4353e227b0da4463b42067dd38f0c36774e665e619b31f2d
 SHA512:
-  metadata.gz: 99ce8a2425f5eeaac8715f6204ec19b80d7b215dfe427cd765f25023c0fb82e72b086cf883e0e36931b4ae8f70457910fd57d21a59258befe139456e89bb130e
-  data.tar.gz: e693145af6596c602eac3136ada51393bf2dd9e06d5d8372739dbef84d811cc8bc3e689411ba308f8535bbeafa0356e8f26452342d2bba9a05132fd839588623
+  metadata.gz: d101294de0e6f585b7df56c2881c465698f4c6ccbe8c4220117d7119c84f21e8b80e6aa2865dd353fa27b3b2c3d7a78095e80466c2d9b5f6eda60b6073a55ed0
+  data.tar.gz: fdbe92f7afafd6f82bafc6525a4099151efcdc385ce49e5cc5f696ea79efe5d411b6eaf093b9b1ec1402140a7d4ac34f629401fb70d9005535eaf38e989cf4cd

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## Vite Rails 1.0.12  (2020-01-29)
+
+- Add support for Vite 2.0.0-beta.56, which modified the manifest to output a `css` field in the manifest.
+- Start generating an assets manifest, since 2.0.0-beta.51 stopped including non-JS entrypoints in the manifest.
+
+## Vite Rails 1.0.11  (2020-01-24)
+
+- Fix bug in `assetHost` that caused `base` to be configured incorrectly.
+- Allow installing `vite` and `vite-plugin-ruby` as devDependencies, and install them when precompiling assets.
+- Move `base` to the configuration root after Vite's update in beta.38
+
+## Vite Rails 1.0.10  (2020-01-23)
+
+- Use `path_to_asset` in `vite_asset_path` so that it's prefixed automatically
+  when using a CDN (`config.action_controller.asset_host`).
+
+## Vite Rails 1.0.9  (2020-01-22)
+
+- Ensure `configPath` and `publicDir` are scoped from `root`, both in Ruby and JS.
+
+## Vite Rails 1.0.8  (2020-01-21)
+
+- 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.

data/CONTRIBUTING.md

@@ -6,7 +6,6 @@
 
 ```
 bundle install
-yarn
 ```
 
 ## Making sure your changes pass all tests

data/README.md

@@ -1,15 +1,26 @@
 <h1 align="center">
-  Vite ⚡️ Rails
+  <a href="https://vite-rails.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_rails/main/docs/public/logo.svg" width="120px"/>
+  </a>
+
+  <br>
+
+  <a href="https://vite-rails.netlify.app/">
+    Vite Rails
+  </a>
+
+  <br>
+
   <p align="center">
-<!--     <a href="https://github.com/ElMassimo/vite_rails/actions">
+    <a href="https://github.com/ElMassimo/vite_rails/actions">
       <img alt="Build Status" src="https://github.com/ElMassimo/vite_rails/workflows/build/badge.svg"/>
-    </a> -->
-    <!-- <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
       <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/gpa.svg"/>
     </a>
     <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
       <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/coverage.svg"/>
-    </a> -->
+    </a>
     <a href="https://rubygems.org/gems/vite_rails">
       <img alt="Gem Version" src="https://img.shields.io/gem/v/vite_rails.svg?colorB=e9573f"/>
     </a>
@@ -20,6 +31,7 @@
 </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/
@@ -27,14 +39,20 @@
 [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/
+[Issues]: https://github.com/ElMassimo/vite_rails/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
+[Discussions]: https://github.com/ElMassimo/vite_rails/discussions
 
 [__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
+- 💡 Instant server start
 - ⚡️ Blazing fast hot reload
 - 🚀 Zero-config deployments
 - 🤝 Integrated with <kbd>assets:precompile</kbd>
@@ -65,7 +83,7 @@ Additional installation instructions are available in the [documentation website
 
 ## Getting Started 💻
 
-Restart your Rails server, and then run `bin/vite` to start the Vite development server.
+Restart your Rails server, and then run <kbd>bin/vite</kbd> to start the Vite development server.
 
 Add the following your `views/layouts/application.html.erb`:
 
@@ -78,9 +96,17 @@ 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 💡
+## Contact ✉️
+
+Please use [Issues] to report bugs you find, and [Discussions] to make feature requests or get help.
+
+Don't hesitate to _⭐️ star the project_ if you find it useful!
+
+
+## Special Thanks 🙏
 
 - [webpacker]
+- [vite]
 
 ## License
 

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

@@ -5,7 +5,4 @@ export default defineConfig({
   plugins: [
     RubyPlugin(),
   ],
-  optimizeDeps: {
-    exclude: [/webpack/, /vite-plugin-ruby/],
-  },
 })

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

@@ -6,7 +6,7 @@ copy_file "#{ __dir__ }/config/vite.json", ViteRails.config.config_path
 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)
+directory "#{ __dir__ }/javascript/entrypoints", ViteRails.config.resolved_entrypoints_dir
 
 apply "#{ __dir__ }/binstubs.rb"
 
@@ -33,8 +33,8 @@ Dir.chdir(Rails.root) do
   vite_version = package_json.match(/"vite": "(.*)"/)[1]
   plugin_version = package_json.match(/"vite-plugin-ruby": "(.*)"/)[1]
 
-  say 'Installing vite as direct dependencies'
-  run "yarn add vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
+  say 'Installing vite as build dependencies'
+  run "yarn add -D vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
 end
 
 say 'Vite ⚡️ Rails successfully installed! 🎉', :green

data/lib/tasks/vite/build.rake

@@ -3,21 +3,27 @@
 $stdout.sync = true
 
 def enhance_assets_precompile
+  # Before installing
+  ['yarn:install', 'webpacker:yarn_install'].each do |name|
+    Rake::Task[name].enhance([:'vite:set_node_env']) if Rake::Task.task_defined?(name)
+  end
+
+  # After precompiling
   Rake::Task['assets:precompile'].enhance do |task|
     prefix = task.name.split(/#|assets:precompile/).first
-
     Rake::Task["#{ prefix }vite:build"].invoke
   end
 end
 
 namespace :vite do
+  desc 'Fixes Rails management of node dev dependencies (build dependencies)'
+  task :set_node_env do
+    ENV['NODE_ENV'] = 'development'
+  end
+
   desc 'Compile JavaScript packs using vite for production with digests'
   task build: [:'vite:verify_install', :environment] do
-    ViteRails.with_node_env(ENV.fetch('NODE_ENV', 'production')) do
-      ViteRails.ensure_log_goes_to_stdout do
-        ViteRails.build || exit!
-      end
-    end
+    ViteRails.build_from_rake
   end
 end
 

data/lib/tasks/vite/clean.rake

@@ -5,9 +5,7 @@ $stdout.sync = true
 namespace :vite do
   desc 'Remove old compiled vites'
   task :clean, [:keep, :age] => [:'vite:verify_install', :environment] do |_, args|
-    ViteRails.ensure_log_goes_to_stdout do
-      ViteRails.clean(keep_up_to: Integer(args.keep || 2), age_in_seconds: Integer(args.age || 3600))
-    end
+    ViteRails.clean_from_rake(args)
   end
 end
 

data/lib/tasks/vite/install_dependencies.rake

@@ -1,19 +1,13 @@
 # frozen_string_literal: true
 
 namespace :vite do
-  desc 'Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn'
+  desc 'Install all JavaScript dependencies as specified via Yarn'
   task :install_dependencies do
     valid_node_envs = %w[test development production]
     node_env = ENV.fetch('NODE_ENV') { valid_node_envs.include?(Rails.env) ? Rails.env : 'production' }
     Dir.chdir(Rails.root) do
-      install_command = if Rails.root.join('yarn.lock').exist?
-        v1 = `yarn --version`.start_with?('1')
-        "yarn install #{ v1 ? '--no-progress --frozen-lockfile' : '--immutable' }"
-      elsif Rails.root.join('pnpm-lock.yaml').exist?
-        'pnpm install'
-      else
-        'npm ci'
-      end
+      v1 = `yarn --version`.start_with?('1')
+      install_command = "yarn install #{ v1 ? '--no-progress --frozen-lockfile' : '--immutable' } --production=false"
       system({ 'NODE_ENV' => node_env }, install_command)
     end
   end

data/lib/tasks/vite/verify_install.rake

@@ -11,10 +11,10 @@ namespace :vite do
       WARN
       exit!
     end
-    unless ViteRails.config.config_path.exist?
-      path = ViteRails.config.config_path.relative_path_from(Pathname.new(pwd)).to_s
+    config_path = Rails.root.join(ViteRails.config.config_path)
+    unless config_path.exist?
       warn <<~WARN
-        Configuration #{ path } file for vite-plugin-ruby not found.
+        Configuration #{ config_path } file for vite-plugin-ruby not found.
         Make sure vite:install has run successfully before running dependent tasks.
       WARN
       exit!

data/lib/vite_rails.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/class/attribute_accessors'
+require 'rails'
+require 'active_support/all'
 
 require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
@@ -13,18 +13,10 @@ class ViteRails
   # Internal: Prefix used for environment variables that modify the configuration.
   ENV_PREFIX = 'VITE_RUBY'
 
-  # Public: Additional environment variables to pass to Vite.
-  #
-  # Example:
-  #   ViteRails.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
-  cattr_accessor(:env) { ENV.select { |key, _| key.start_with?(ENV_PREFIX) } }
-
-  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
-
   class << self
-    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, to: :instance
+    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, :run_proxy?, to: :instance
     delegate :mode, to: :config
-    delegate :bootstrap, :clean, :clobber, :build, to: :commands
+    delegate :bootstrap, :clean, :clean_from_rake, :clobber, :build, :build_from_rake, to: :commands
 
     attr_writer :instance
 
@@ -37,34 +29,31 @@ class ViteRails
       ViteRails::Runner.new(args).run
     end
 
-    # Public: The proxy for assets should only run in development mode.
-    def run_proxy?
-      config.mode == 'development'
-    rescue StandardError => error
-      logger.error("Failed to check mode for Vite: #{ error.message }")
-      false
+    # Internal: Allows to obtain any env variables for configuration options.
+    def load_env_variables
+      ENV.select { |key, _| key.start_with?(ENV_PREFIX) }
     end
+  end
 
-    def with_node_env(env)
-      original = ENV['NODE_ENV']
-      ENV['NODE_ENV'] = env
-      yield
-    ensure
-      ENV['NODE_ENV'] = original
-    end
+  # Public: Additional environment variables to pass to Vite.
+  #
+  # Example:
+  #   ViteRails.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
+  cattr_accessor(:env) { load_env_variables }
 
-    def ensure_log_goes_to_stdout
-      old_logger = ViteRails.logger
-      ViteRails.logger = ActiveSupport::Logger.new(STDOUT)
-      yield
-    ensure
-      ViteRails.logger = old_logger
-    end
-  end
+  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
 
   # Public: Returns true if the Vite development server is running.
   def dev_server_running?
-    ViteRails.run_proxy? && dev_server.running?
+    run_proxy? && dev_server.running?
+  end
+
+  # Public: The proxy for assets should only run in development mode.
+  def run_proxy?
+    config.mode == 'development'
+  rescue StandardError => error
+    ViteRails.logger.error("Failed to check mode for Vite: #{ error.message }")
+    false
   end
 
   # Public: Current instance configuration for Vite.

data/lib/vite_rails/builder.rb

@@ -67,9 +67,18 @@ private
   def build_with_vite
     logger.info 'Building with Vite ⚡️'
 
-    stdout, stderr, status = Open3.capture3(vite_env,
-      "#{ which_ruby } ./bin/vite build --mode #{ config.mode }", chdir: File.expand_path(config.root))
+    command = "#{ which_ruby } ./bin/vite build --mode #{ config.mode }"
+    stdout, stderr, status = Open3.capture3(ViteRails.config.to_env, command, chdir: File.expand_path(config.root))
 
+    log_build_result(stdout, stderr, status)
+
+    status.success?
+  end
+
+  # Internal: Outputs the build results.
+  #
+  # NOTE: By default it also outputs the manifest entries.
+  def log_build_result(stdout, stderr, status)
     if status.success?
       logger.info "Build with Vite complete: #{ config.build_output_dir }"
       logger.error(stderr.to_s) unless stderr.empty?
@@ -78,8 +87,6 @@ private
       non_empty_streams = [stdout, stderr].delete_if(&:empty?)
       logger.error "Build with Vite failed:\n#{ non_empty_streams.join("\n\n") }"
     end
-
-    status.success?
   end
 
   # Internal: Used to prefix the bin/vite executable file.
@@ -101,13 +108,4 @@ private
       config.config_path,
     ].freeze
   end
-
-  # Internal: Sets additional environment variables for vite-plugin-ruby.
-  def vite_env
-    ViteRails.env.merge(
-      "#{ ViteRails::ENV_PREFIX }_CONFIG_PATH" => config.config_path,
-      "#{ ViteRails::ENV_PREFIX }_MODE" => config.mode,
-      "#{ ViteRails::ENV_PREFIX }_ROOT" => config.root,
-    ).transform_values(&:to_s)
-  end
 end

data/lib/vite_rails/commands.rb

@@ -11,6 +11,15 @@ class ViteRails::Commands
     manifest.refresh
   end
 
+  # Public: Defaults to production, and exits if the build fails.
+  def build_from_rake
+    with_node_env(ENV.fetch('NODE_ENV', 'production')) {
+      ensure_log_goes_to_stdout {
+        build || exit!
+      }
+    }
+  end
+
   # Public: Builds all assets that are managed by Vite, from the entrypoints.
   def build
     builder.build.tap { manifest.refresh }
@@ -20,6 +29,14 @@ class ViteRails::Commands
   def clobber
     config.build_output_dir.rmtree if config.build_output_dir.exist?
     config.build_cache_dir.rmtree if config.build_cache_dir.exist?
+    config.vite_cache_dir.rmtree if config.vite_cache_dir.exist?
+  end
+
+  # Public: Receives arguments from a rake task.
+  def clean_from_rake(args)
+    ensure_log_goes_to_stdout {
+      clean(keep_up_to: Integer(args.keep || 2), age_in_seconds: Integer(args.age || 3600))
+    }
   end
 
   # Public: Cleanup old assets in the output directory.
@@ -33,21 +50,16 @@ class ViteRails::Commands
   #   To force only 1 backup to be kept: clean(1, 0)
   #   To only keep files created within the last 10 minutes: clean(0, 600)
   def clean(keep_up_to: 2, age_in_seconds: 3600)
-    return false unless config.build_output_dir.exist? && config.manifest_path.exist?
+    return false unless may_clean?
 
-    versions.sort.reverse
+    versions
       .each_with_index
       .drop_while { |(mtime, _), index|
         max_age = [0, Time.now - Time.at(mtime)].max
         max_age < age_in_seconds || index < keep_up_to
       }
-      .each do |(_, files), _index|
-        files.each do |file|
-          next unless File.file?(file)
-
-          File.delete(file)
-          logger.info("Removed #{ file }")
-        end
+      .each do |(_, files), _|
+        clean_files(files)
       end
     true
   end
@@ -56,13 +68,42 @@ private
 
   delegate :config, :builder, :manifest, :logger, to: :@vite_rails
 
+  def may_clean?
+    config.build_output_dir.exist? && config.manifest_path.exist?
+  end
+
+  def clean_files(files)
+    files.select { |file| File.file?(file) }.each do |file|
+      File.delete(file)
+      logger.info("Removed #{ file }")
+    end
+  end
+
   def versions
     all_files = Dir.glob("#{ config.build_output_dir }/**/*")
     entries = all_files - [config.manifest_path] - current_version_files
-    entries.reject { |file| File.directory?(file) }.group_by { |file| File.mtime(file).utc.to_i }
+    entries.reject { |file| File.directory?(file) }
+      .group_by { |file| File.mtime(file).utc.to_i }
+      .sort.reverse
   end
 
   def current_version_files
     Dir.glob(manifest.refresh.values.map { |value| config.build_output_dir.join("#{ value['file'] }*") })
   end
+
+  def with_node_env(env)
+    original = ENV['NODE_ENV']
+    ENV['NODE_ENV'] = env
+    yield
+  ensure
+    ENV['NODE_ENV'] = original
+  end
+
+  def ensure_log_goes_to_stdout
+    old_logger = ViteRails.logger
+    ViteRails.logger = ActiveSupport::Logger.new(STDOUT)
+    yield
+  ensure
+    ViteRails.logger = old_logger
+  end
 end