vite_ruby 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ef54a43f8457a31e8af99da6da97e50b9c406c7f0595f7840057dbf830c557
-  data.tar.gz: fa00714f7a3ad4c63562950b596c564ffc1a8a1592c88a7e313f8a74027a05cb
+  metadata.gz: d9655dc4d615097239f9382298b8e2080b0ea63b9d23423cbb6c603817b6a3a1
+  data.tar.gz: 7046d45ec63fdcdb7e712113d0d6861a6c6df11ed06e0befac721315cb31546c
 SHA512:
-  metadata.gz: 65f96a4b01af3c5a773fb6545d893ec072b5eaea006a7456878f651fdac459bd27ea9172dca776b5194011e513b6a10ed623c3c73705f1206825f88dc4909f76
-  data.tar.gz: 60d845e48ac820e6791a7dafa4d5d549fb652b52c7e60bdcdca22cf6c62862717f04bef0043b9e3bbad6fddd9167eab58e93c5654ca1c5858c452960f07413a5
+  metadata.gz: c7553b547d6a411ec608128285c84321a96707906b29c8e5c94f91d8a63db65a8054cb6d529bbaf1f30acc1bbbe98df392ea1bea8f0c80b8c827e6a630e4ab38
+  data.tar.gz: 4c9b45b1804d5d8aa10cc8997bbe4ab4277d9d2de44c497e679c9d67bb65dcae516210a8b3813ed84aa4627d28656112a40c69878e7f89aab0b6df045cf496f2

data/CHANGELOG.md

@@ -1,3 +1,61 @@
+# [1.2.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.1.2...vite_ruby@1.2.0) (2021-03-19)
+
+
+### Bug Fixes
+
+* Improve error messages when the Vite executable is missing ([#41](https://github.com/ElMassimo/vite_ruby/issues/41)) ([a79edc6](https://github.com/ElMassimo/vite_ruby/commit/a79edc6cc603c1094ede9e899226e98f734e7bbe))
+
+
+### Features
+
+* Add `clobber` to the CLI, usable as `--clear` in the `dev` and `build` commands ([331d861](https://github.com/ElMassimo/vite_ruby/commit/331d86163c12eb3303d3975a94ecc205fa59dd41))
+* Allow `clobber` to receive a `--mode` option. ([e6e7a6d](https://github.com/ElMassimo/vite_ruby/commit/e6e7a6dd0a2acf205d06877f76deb924c1d5aba7))
+
+
+
+## [1.1.2](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.1.1...vite_ruby@1.1.2) (2021-03-19)
+
+
+### Features
+
+* Automatically retry failed builds after a certain time ([cbb3058](https://github.com/ElMassimo/vite_ruby/commit/cbb305863a49c46e7a0d95c773f56f7d822d01d9))
+
+
+
+## [1.1.1](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.1.0...vite_ruby@1.1.1) (2021-03-19)
+
+
+### Bug Fixes
+
+* handle getaddrinfo errors when checking dev server ([#39](https://github.com/ElMassimo/vite_ruby/issues/39)) ([df57d6b](https://github.com/ElMassimo/vite_ruby/commit/df57d6ba5d8ed20e15bd2de3a57c8ff711671d28))
+
+
+
+# [1.1.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.0.5...vite_ruby@1.1.0) (2021-03-07)
+
+
+### Bug Fixes
+
+* Add development mutex in manifest to prevent re-entrant builds ([a6c6976](https://github.com/ElMassimo/vite_ruby/commit/a6c6976ba3821d8d6f26d012de13a440cb91c95b))
+* Allow passing --inspect and other options to the build command ([1818ea4](https://github.com/ElMassimo/vite_ruby/commit/1818ea4f1d211923dfe0c04037baca8b2fd3b991))
+
+
+### Features
+
+* Record status and timestamp of each build to provide better errors ([a35a64a](https://github.com/ElMassimo/vite_ruby/commit/a35a64ad4ca802da7bb6d5f5139985da864293a4))
+* Stream build output to provide feedback as the command runs ([2bce338](https://github.com/ElMassimo/vite_ruby/commit/2bce33888513f6961da11ddfa9f9c703182abfa6))
+
+
+
+## [1.0.5](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.0.4...vite_ruby@1.0.5) (2021-03-03)
+
+
+### Bug Fixes
+
+* Fix installation of JS packages, prevent silent failures (closes [#22](https://github.com/ElMassimo/vite_ruby/issues/22)) ([#23](https://github.com/ElMassimo/vite_ruby/issues/23)) ([d972e6f](https://github.com/ElMassimo/vite_ruby/commit/d972e6f3968988460753e7a831c8e9199bbd6891))
+
+
+
 ## [1.0.4](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.0.3...vite_ruby@1.0.4) (2021-02-25)
 
 

data/README.md

@@ -70,6 +70,8 @@ Please use [Issues] to report bugs you find, and [Discussions] to make feature r
 
 Don't hesitate to _⭐️ star the project_ if you find it useful!
 
+Using it in production? Always love to hear about it! 😃
+
 
 ## Special Thanks 🙏
 

data/default.vite.json

@@ -13,5 +13,6 @@
   "https": null,
   "port": 3036,
   "hideBuildConsoleOutput": false,
+  "viteBinPath": "node_modules/.bin/vite",
   "watchAdditionalPaths": []
 }

data/lib/tasks/vite.rake

@@ -22,7 +22,6 @@ namespace :vite do
   desc 'Remove the vite build output directory'
   task clobber: :'vite:verify_install' do
     ViteRuby.commands.clobber
-    $stdout.puts "Removed vite build output directory #{ ViteRuby.config.build_output_dir }"
   end
 
   desc 'Verifies if ViteRuby is properly installed in this application'

data/lib/vite_ruby.rb

@@ -28,7 +28,6 @@ class ViteRuby
 
     def_delegators :instance, :config, :commands, :run_proxy?
     def_delegators :config, :mode
-    def_delegators 'ViteRuby::Runner.new', :run
 
     def instance
       @instance ||= ViteRuby.new
@@ -52,6 +51,11 @@ class ViteRuby
       load File.expand_path('tasks/vite.rake', __dir__)
     end
 
+    # Internal: Executes the vite binary.
+    def run(argv, **options)
+      ViteRuby::Runner.new(instance).run(argv, **options)
+    end
+
     # Internal: Refreshes the config after setting the env vars.
     def reload_with(env_vars)
       env.update(env_vars)
@@ -75,9 +79,6 @@ class ViteRuby
     end
   end
 
-  extend Forwardable
-  def_delegators :builder, :build
-
   attr_writer :logger
 
   def logger
@@ -93,7 +94,7 @@ class ViteRuby
     Socket.tcp(config.host, config.port, connect_timeout: config.dev_server_connect_timeout).close
     @running_at = Time.now
     true
-  rescue SystemCallError
+  rescue StandardError
     @running_at = false
   end
 

data/lib/vite_ruby/build.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'time'
+
+# Internal: Value object with information about the last build.
+ViteRuby::Build = Struct.new(:success, :timestamp, :digest, :current_digest) do
+  # Internal: Combines information from a previous build with the current digest.
+  def self.from_previous(attrs, current_digest)
+    new(attrs['success'], attrs['timestamp'] || 'never', attrs['digest'] || 'none', current_digest)
+  end
+
+  # Internal: A build is considered stale when watched files have changed since
+  # the last build, or when a certain time has ellapsed in case of failure.
+  def stale?
+    digest != current_digest || retry_failed?
+  end
+
+  # Internal: A build is considered fresh if watched files have not changed, or
+  # the last failed build happened recently.
+  def fresh?
+    !stale?
+  end
+
+  # Internal: To avoid cascading build failures, if the last build failed and it
+  # happened within a short time window, a new build should not be triggered.
+  def retry_failed?
+    !success && Time.parse(timestamp) + 3 < Time.now # 3 seconds
+  rescue ArgumentError
+    true
+  end
+
+  # Internal: Returns a new build with the specified result.
+  def with_result(success)
+    self.class.new(success, Time.now.strftime('%F %T'), current_digest)
+  end
+
+  # Internal: Returns a JSON string with the metadata of the build.
+  def to_json(*_args)
+    JSON.pretty_generate(to_h)
+  end
+end

data/lib/vite_ruby/builder.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'digest/sha1'
 
 # Public: Keeps track of watched files and triggers builds as needed.
@@ -10,23 +11,22 @@ class ViteRuby::Builder
 
   # Public: Checks if the watched files have changed since the last compilation,
   # and triggers a Vite build if any files have changed.
-  def build
-    if stale?
-      build_with_vite.tap { record_files_digest }
-    else
-      logger.debug 'Skipping build. Vite assets are already up-to-date ⚡️'
+  def build(*args)
+    last_build = last_build_metadata
+    if args.delete('--force') || last_build.stale?
+      build_with_vite(*args).tap { |success| record_build_metadata(success, last_build) }
+    elsif last_build.success
+      logger.debug "Skipping vite build. Watched files have not changed since the last build at #{ last_build.timestamp }"
       true
+    else
+      logger.error "Skipping vite build. Watched files have not changed since the build failed at #{ last_build.timestamp } ❌"
+      false
     end
   end
 
-  # Public: Returns true if all the assets built by Vite are up to date.
-  def fresh?
-    previous_files_digest&.== watched_files_digest
-  end
-
-  # Public: Returns true if any of the assets built by Vite is out of date.
-  def stale?
-    !fresh?
+  # Internal: Reads the result of the last compilation from disk.
+  def last_build_metadata
+    ViteRuby::Build.from_previous(last_build_attrs, watched_files_digest)
   end
 
 private
@@ -35,21 +35,22 @@ private
 
   def_delegators :@vite_ruby, :config, :logger
 
-  # Internal: Writes a digest of the watched files to disk for future checks.
-  def record_files_digest
-    config.build_cache_dir.mkpath
-    files_digest_path.write(watched_files_digest)
+  # Internal: Reads metadata recorded on the last build, if it exists.
+  def last_build_attrs
+    last_build_path.exist? ? JSON.parse(last_build_path.read.to_s) : {}
+  rescue JSON::JSONError, Errno::ENOENT, Errno::ENOTDIR
+    {}
   end
 
-  # Internal: The path of where a digest of the watched files is stored.
-  def files_digest_path
-    config.build_cache_dir.join("last-compilation-digest-#{ config.mode }")
+  # Internal: Writes a digest of the watched files to disk for future checks.
+  def record_build_metadata(success, build)
+    config.build_cache_dir.mkpath
+    last_build_path.write build.with_result(success).to_json
   end
 
-  # Internal: Reads a digest of watched files from disk.
-  def previous_files_digest
-    files_digest_path.read if files_digest_path.exist? && config.manifest_path.exist?
-  rescue Errno::ENOENT, Errno::ENOTDIR
+  # Internal: The file path where metadata of the last build is stored.
+  def last_build_path
+    config.build_cache_dir.join("last-build-#{ config.mode }.json")
   end
 
   # Internal: Returns a digest of all the watched files, allowing to detect
@@ -65,11 +66,11 @@ private
   # Public: Initiates a Vite build command to generate assets.
   #
   # Returns true if the build is successful, or false if it failed.
-  def build_with_vite
+  def build_with_vite(*args)
     logger.info 'Building with Vite ⚡️'
 
-    stdout, stderr, status = ViteRuby.run(['build'], capture: true)
-    log_build_result(stdout, stderr, status)
+    stdout, stderr, status = ViteRuby.run(['build', *args], capture: true)
+    log_build_result(stdout, stderr.to_s, status)
 
     status.success?
   end
@@ -77,14 +78,14 @@ private
   # Internal: Outputs the build results.
   #
   # NOTE: By default it also outputs the manifest entries.
-  def log_build_result(stdout, stderr, status)
+  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?
-      logger.info(stdout) unless config.hide_build_console_output
+      logger.error stderr.to_s unless stderr.empty?
     else
-      non_empty_streams = [stdout, stderr].delete_if(&:empty?)
-      logger.error "Build with Vite failed:\n#{ non_empty_streams.join("\n\n") }"
+      logger.error stderr
+      logger.error 'Build with Vite failed! ❌'
+      logger.error '❌ Check that vite and vite-plugin-ruby are in devDependencies and have been installed. ' if stderr.include?('ERR! canceled')
     end
   end
 
@@ -96,7 +97,11 @@ private
       *config.watch_additional_paths,
       "#{ config.source_code_dir }/**/*",
       'yarn.lock',
+      'package-lock.json',
+      'pnpm-lock.yaml',
       'package.json',
+      'vite.config.ts',
+      'vite.config.js',
       config.config_path,
     ].freeze
   end

data/lib/vite_ruby/cli.rb

@@ -8,6 +8,7 @@ class ViteRuby::CLI
   extend Dry::CLI::Registry
 
   register 'build', Build, aliases: ['b']
+  register 'clobber', Clobber, aliases: %w[clean clear]
   register 'dev', Dev, aliases: %w[d serve]
   register 'install', Install, aliases: %w[setup init]
   register 'version', Version, aliases: ['v', '-v', '--version', 'info']

data/lib/vite_ruby/cli/build.rb

@@ -5,14 +5,21 @@ class ViteRuby::CLI::Build < Dry::CLI::Command
   DEFAULT_ENV = CURRENT_ENV || 'production'
 
   def self.shared_options
-    option(:mode, default: self::DEFAULT_ENV, values: %w[development production], aliases: ['m'], desc: 'The build mode for Vite.')
+    option(:mode, default: self::DEFAULT_ENV, values: %w[development production test], aliases: ['m'], desc: 'The build mode for Vite')
+    option(:clobber, desc: 'Clear cache and previous builds', type: :boolean, aliases: %w[clean clear])
+    option(:debug, desc: 'Run Vite in verbose mode, printing all debugging output', aliases: ['verbose'], type: :boolean)
+    option(:inspect, desc: 'Run Vite in a debugging session with node --inspect-brk', aliases: ['inspect-brk'], type: :boolean)
+    option(:trace_deprecation, desc: 'Run Vite in debugging mode with node --trace-deprecation', aliases: ['trace-deprecation'], type: :boolean)
   end
 
   desc 'Bundle all entrypoints using Vite.'
   shared_options
+  option(:force, desc: 'Force the build even if assets have not changed', type: :boolean)
 
-  def call(mode:)
+  def call(mode:, args: [], clobber: false, **boolean_opts)
     ViteRuby.env['VITE_RUBY_MODE'] = mode
-    block_given? ? yield(mode) : ViteRuby.commands.build_from_task
+    ViteRuby.commands.clobber if clobber
+    boolean_opts.map { |name, value| args << "--#{ name }" if value }
+    block_given? ? yield(args) : ViteRuby.commands.build_from_task(*args)
   end
 end

data/lib/vite_ruby/cli/clobber.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ViteRuby::CLI::Clobber < Dry::CLI::Command
+  desc 'Clear the Vite cache, temp files, and builds'
+
+  current_env = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+
+  option(:mode, default: current_env, values: %w[development production test], aliases: ['m'], desc: 'The mode to use')
+
+  def call(**)
+    ViteRuby.commands.clobber
+  end
+end

data/lib/vite_ruby/cli/dev.rb

@@ -5,8 +5,9 @@ class ViteRuby::CLI::Dev < ViteRuby::CLI::Build
 
   desc 'Start the Vite development server.'
   shared_options
+  option(:force, desc: 'Force Vite to re-bundle dependencies', type: :boolean)
 
-  def call(mode:, args: [])
-    super(mode: mode) { ViteRuby.run(args) }
+  def call(**options)
+    super { |args| ViteRuby.run(args) }
   end
 end

data/lib/vite_ruby/cli/install.rb

@@ -75,7 +75,7 @@ private
     write(package_json, '{}') unless package_json.exist?
     Dir.chdir(root) do
       deps = "vite@#{ ViteRuby::DEFAULT_VITE_VERSION } vite-plugin-ruby@#{ ViteRuby::DEFAULT_PLUGIN_VERSION }"
-      stdout, stderr, status = Open3.capture3({ 'CI' => 'true' }, "npx @antfu/ni -D #{ deps }")
+      stdout, stderr, status = Open3.capture3({ 'CI' => 'true' }, "npx --package @antfu/ni -- ni -D #{ deps }")
       stdout, stderr, = Open3.capture3({}, "yarn add -D #{ deps }") unless status.success?
       say(stdout, "\n", stderr)
     end

data/lib/vite_ruby/commands.rb

@@ -8,24 +8,24 @@ class ViteRuby::Commands
   end
 
   # Public: Defaults to production, and exits if the build fails.
-  def build_from_task
+  def build_from_task(*args)
     with_node_env(ENV.fetch('NODE_ENV', 'production')) {
       ensure_log_goes_to_stdout {
-        build || exit!
+        build(*args) || exit!
       }
     }
   end
 
   # Public: Builds all assets that are managed by Vite, from the entrypoints.
-  def build
-    builder.build.tap { manifest.refresh }
+  def build(*args)
+    builder.build(*args).tap { manifest.refresh }
   end
 
   # Public: Removes all build cache and previously compiled assets.
   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?
+    dirs = [config.build_output_dir, config.build_cache_dir, config.vite_cache_dir]
+    dirs.each { |dir| dir.rmtree if dir.exist? }
+    $stdout.puts "Removed vite cache and output dirs:\n\t#{ dirs.join("\n\t") }"
   end
 
   # Public: Receives arguments from a rake task.
@@ -69,6 +69,7 @@ class ViteRuby::Commands
   def verify_install
     unless File.exist?(config.root.join('bin/vite'))
       warn <<~WARN
+
         vite binstub not found.
         Have you run `bundle binstub vite`?
         Make sure the bin directory and bin/vite are not included in .gitignore
@@ -78,6 +79,7 @@ class ViteRuby::Commands
     config_path = config.root.join(config.config_path)
     unless config_path.exist?
       warn <<~WARN
+
         Configuration #{ config_path } file for vite-plugin-ruby not found.
         Make sure `bundle exec vite install` has run successfully before running dependent tasks.
       WARN
@@ -88,7 +90,7 @@ class ViteRuby::Commands
   # Internal: Prints information about ViteRuby's environment.
   def print_info
     Dir.chdir(config.root) do
-      $stdout.puts "Is bin/vite present?: #{ File.exist? 'bin/vite' }"
+      $stdout.puts "bin/vite present?: #{ File.exist? 'bin/vite' }"
 
       $stdout.puts "vite_ruby: #{ ViteRuby::VERSION }"
       ViteRuby.framework_libraries.each do |framework, library|
@@ -98,11 +100,14 @@ class ViteRuby::Commands
 
       $stdout.puts "node: #{ `node --version` }"
       $stdout.puts "npm: #{ `npm --version` }"
-      $stdout.puts "yarn: #{ `yarn --version` }"
+      $stdout.puts "yarn: #{ `yarn --version` rescue nil }"
+      $stdout.puts "pnpm: #{ `pnpm --version` rescue nil }"
       $stdout.puts "ruby: #{ `ruby --version` }"
 
       $stdout.puts "\n"
-      $stdout.puts "vite-plugin-ruby: \n#{ `npm list vite-plugin-ruby version` }"
+      packages = `npm ls vite vite-plugin-ruby`
+      packages_msg = packages.include?('vite@') ? "installed packages:\n#{ packages }" : '❌ Check that vite and vite-plugin-ruby have been added as development dependencies and installed.'
+      $stdout.puts packages_msg
     end
   end
 
@@ -144,10 +149,12 @@ private
   end
 
   def ensure_log_goes_to_stdout
-    old_logger = logger
-    self.logger = Logger.new($stdout)
+    old_logger, original_sync = logger, $stdout.sync
+
+    $stdout.sync = true
+    self.logger = Logger.new($stdout, formatter: proc { |_, _, progname, msg| progname == 'vite' ? msg : "#{ msg }\n" })
     yield
   ensure
-    self.logger = old_logger
+    self.logger, $stdout.sync = old_logger, original_sync
   end
 end

data/lib/vite_ruby/config.rb

@@ -91,7 +91,7 @@ private
     }
 
     # Internal: Default values for a Ruby application.
-    def config_defaults(asset_host: nil, mode: ENV.fetch('RACK_ENV', 'production'), root: Dir.pwd)
+    def config_defaults(asset_host: nil, mode: ENV.fetch('RACK_ENV', 'development'), root: Dir.pwd)
       {
         'asset_host' => option_from_env('asset_host') || asset_host,
         'config_path' => option_from_env('config_path') || DEFAULT_CONFIG.fetch('config_path'),

data/lib/vite_ruby/dev_server_proxy.rb

@@ -9,7 +9,7 @@ class ViteRuby::DevServerProxy < Rack::Proxy
 
   def initialize(app = nil, options = {})
     @vite_ruby = options.delete(:vite_ruby) || ViteRuby.instance
-    options[:streaming] = false if ViteRuby.mode == 'test' && !options.key?(:streaming)
+    options[:streaming] = false if config.mode == 'test' && !options.key?(:streaming)
     super
   end
 

data/lib/vite_ruby/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Internal: Provides common functionality for errors.
+class ViteRuby::Error < StandardError
+  def message
+    super.sub(':troubleshooting:', <<~MSG)
+      Visit the Troubleshooting guide for more information:
+        https://vite-ruby.netlify.app/guide/troubleshooting.html#troubleshooting
+    MSG
+  end
+end

data/lib/vite_ruby/manifest.rb

@@ -10,11 +10,9 @@
 # NOTE: Using "autoBuild": true` in `config/vite.json` file will trigger a build
 # on demand as needed, before performing any lookup.
 class ViteRuby::Manifest
-  class MissingEntryError < StandardError
-  end
-
   def initialize(vite_ruby)
     @vite_ruby = vite_ruby
+    @build_mutex = Mutex.new if config.auto_build
   end
 
   # Public: Returns the path for the specified Vite entrypoint file.
@@ -65,7 +63,7 @@ protected
   #   manifest.lookup('calendar.js')
   #   => { "file" => "/vite/assets/calendar-1016838bab065ae1e122.js", "imports" => [] }
   def lookup(name, type: nil)
-    build if should_build?
+    @build_mutex.synchronize { builder.build } if should_build?
 
     find_manifest_entry(with_file_extension(name, type))
   end
@@ -74,7 +72,7 @@ private
 
   extend Forwardable
 
-  def_delegators :@vite_ruby, :config, :build, :dev_server_running?
+  def_delegators :@vite_ruby, :config, :builder, :dev_server_running?
 
   # 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.
@@ -141,28 +139,11 @@ private
 
   # Internal: Raises a detailed message when an entry is missing in the manifest.
   def missing_entry_error(name, type: nil, **_options)
-    file_name = with_file_extension(name, type)
-    raise ViteRuby::Manifest::MissingEntryError, <<~MSG
-      Vite Ruby can't find #{ file_name } in #{ config.manifest_path } or #{ config.assets_manifest_path }.
-
-      Possible causes:
-      #{ missing_entry_causes.map { |cause| "\t- #{ cause }" }.join("\n") }
-
-      Content in your manifests:
-      #{ JSON.pretty_generate(@manifest) }
-    MSG
-  end
-
-  def missing_entry_causes
-    local = config.auto_build
-    [
-      (dev_server_running? && 'Vite has not yet re-built your latest changes.'),
-      (local && !dev_server_running? && "\"autoBuild\": false in your #{ config.mode } configuration."),
-      (local && !dev_server_running? && 'The Vite development server has crashed or is no longer available.'),
-      'You have misconfigured config/vite.json file.',
-      (!local && 'Assets have not been precompiled'),
-    ].select(&:itself)
-  rescue StandardError
-    []
+    raise ViteRuby::MissingEntrypointError, OpenStruct.new(
+      file_name: with_file_extension(name, type),
+      last_build: builder.last_build_metadata,
+      manifest: @manifest,
+      config: config,
+    )
   end
 end

data/lib/vite_ruby/missing_entrypoint_error.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Internal: Raised when an entry is not found in the build manifest.
+#
+# NOTE: The complexity here is justified by the improved usability of providing
+# a more specific error message depending on the situation.
+class ViteRuby::MissingEntrypointError < ViteRuby::Error
+  extend Forwardable
+  def_delegators :@info, :file_name, :last_build, :manifest, :config
+
+  def initialize(info)
+    @info = info
+    super <<~MSG
+      Vite Ruby can't find #{ file_name } in #{ config.manifest_path.relative_path_from(config.root) } or #{ config.assets_manifest_path.relative_path_from(config.root) }.
+
+      Possible causes:
+      #{ possible_causes(last_build) }
+      :troubleshooting:
+      #{ "\nContent in your manifests:\n#{ JSON.pretty_generate(manifest) }\n" if last_build.success }
+      #{ "Last build in #{ config.mode } mode:\n#{ last_build.to_json }\n" unless last_build.success.nil? }
+    MSG
+  end
+
+  def possible_causes(last_build)
+    return FAILED_BUILD_CAUSES.sub(':mode:', config.mode) if last_build.success == false
+    return DEFAULT_CAUSES if config.auto_build
+
+    DEFAULT_CAUSES + NO_AUTO_BUILD_CAUSES
+  end
+
+  FAILED_BUILD_CAUSES = <<-MSG
+  - The last build failed. Try running `bin/vite build --clear --mode=:mode:` manually and check for errors.
+  MSG
+
+  DEFAULT_CAUSES = <<-MSG
+  - The file path is incorrect.
+  - The file is not in the entrypoints directory.
+  - Some files are outside the sourceCodeDir, and have not been added to watchAdditionalPaths.
+  MSG
+
+  NO_AUTO_BUILD_CAUSES = <<-MSG
+  - You have not run `bin/vite dev` to start Vite, or the dev server is not reachable.
+  - "autoBuild" is set to `false` in your config/vite.json for this environment.
+  MSG
+end

data/lib/vite_ruby/missing_executable_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Internal: Raised when the Vite executable can not be found.
+class ViteRuby::MissingExecutableError < ViteRuby::Error
+  def initialize(error = nil)
+    super <<~MSG
+      ❌ The vite binary is not available. Have you installed Vite?
+
+      :troubleshooting:
+      #{ error }
+    MSG
+  end
+end

data/lib/vite_ruby/runner.rb

@@ -4,54 +4,63 @@ require 'open3'
 
 # Public: Executes Vite commands, providing conveniences for debugging.
 class ViteRuby::Runner
+  def initialize(vite_ruby)
+    @vite_ruby = vite_ruby
+  end
+
   # Public: Executes Vite with the specified arguments.
-  def run(argv, **options)
-    $stdout.sync = true
-    detect_unsupported_switches!(argv)
-    execute_command(argv.clone, **options)
+  def run(argv, capture: false)
+    Dir.chdir(config.root) {
+      cmd = command_for(argv)
+      capture ? capture3_with_output(*cmd, chdir: config.root) : Kernel.exec(*cmd)
+    }
+  rescue Errno::ENOENT => error
+    raise ViteRuby::MissingExecutableError, error
   end
 
 private
 
-  UNSUPPORTED_SWITCHES = %w[--host --port --https --root -r --config -c].freeze
+  extend Forwardable
 
-  # Internal: Allows to prevent configuration mistakes by ensuring the Ruby app
-  # and vite-plugin-ruby are using the same configuration for the dev server.
-  def detect_unsupported_switches!(args)
-    return unless (unsupported = UNSUPPORTED_SWITCHES & args).any?
-
-    $stdout.puts "Please set the following switches in your vite.json instead: #{ unsupported }."
-    exit!
-  end
-
-  # Internal: Executes the command with the specified arguments.
-  def execute_command(args, capture: false)
-    if capture
-      Open3.capture3(*command_for(args), chdir: ViteRuby.config.root)
-    else
-      Dir.chdir(ViteRuby.config.root) { Kernel.exec(*command_for(args)) }
-    end
-  end
+  def_delegators :@vite_ruby, :config, :logger
 
   # Internal: Returns an Array with the command to run.
   def command_for(args)
-    [vite_env].tap do |cmd|
-      cmd.append('node', '--inspect-brk') if args.include?('--debug')
-      cmd.append('node', '--trace-deprecation') if args.delete('--trace-deprecation')
-      cmd.append(*vite_executable(cmd))
+    [config.to_env].tap do |cmd|
+      args = args.clone
+      cmd.append('node', '--inspect-brk') if args.delete('--inspect')
+      cmd.append('node', '--trace-deprecation') if args.delete('--trace_deprecation')
+      cmd.append(vite_executable)
       cmd.append(*args)
-      cmd.append('--mode', ViteRuby.mode) unless args.include?('--mode') || args.include?('-m')
+      cmd.append('--mode', config.mode) unless args.include?('--mode') || args.include?('-m')
     end
   end
 
-  # Internal: The environment variables to pass to the command.
-  def vite_env
-    ViteRuby.config.to_env
+  # Internal: Resolves to an executable for Vite.
+  def vite_executable
+    bin_path = config.vite_bin_path
+    File.exist?(bin_path) ? bin_path : "#{ `npm bin`.chomp }/vite"
   end
 
-  # Internal: Resolves to an executable for Vite.
-  def vite_executable(cmd)
-    npx = cmd.include?('node') ? `which npx`.chomp("\n") : 'npx' rescue 'npx'
-    [npx, 'vite']
+  # Internal: A modified version of capture3 that continuosly prints stdout.
+  # NOTE: This improves the experience of running bin/vite build.
+  def capture3_with_output(*cmd, **opts)
+    return Open3.capture3(*cmd, opts) if config.hide_build_console_output
+
+    Open3.popen3(*cmd, opts) { |_stdin, stdout, stderr, wait_threads|
+      out = Thread.new { read_lines(stdout) { |l| logger.info('vite') { l } } }
+      err = Thread.new { stderr.read }
+      [out.value, err.value, wait_threads.value]
+    }
+  end
+
+  # Internal: Reads and yield every line in the stream. Returns the full content.
+  def read_lines(io)
+    buffer = +''
+    while line = io.gets
+      buffer << line
+      yield line
+    end
+    buffer
   end
 end

data/lib/vite_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ViteRuby
-  VERSION = '1.0.4'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -28,6 +28,9 @@ dependencies:
   name: rack-proxy
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.1
@@ -35,6 +38,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.1
@@ -42,58 +48,156 @@ dependencies:
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub_any_instance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 description:
 email:
 - maximomussini@gmail.com
@@ -109,16 +213,21 @@ files:
 - exe/vite
 - lib/tasks/vite.rake
 - lib/vite_ruby.rb
+- lib/vite_ruby/build.rb
 - lib/vite_ruby/builder.rb
 - lib/vite_ruby/cli.rb
 - lib/vite_ruby/cli/build.rb
+- lib/vite_ruby/cli/clobber.rb
 - lib/vite_ruby/cli/dev.rb
 - lib/vite_ruby/cli/install.rb
 - lib/vite_ruby/cli/version.rb
 - lib/vite_ruby/commands.rb
 - lib/vite_ruby/config.rb
 - lib/vite_ruby/dev_server_proxy.rb
+- lib/vite_ruby/error.rb
 - lib/vite_ruby/manifest.rb
+- lib/vite_ruby/missing_entrypoint_error.rb
+- lib/vite_ruby/missing_executable_error.rb
 - lib/vite_ruby/runner.rb
 - lib/vite_ruby/version.rb
 - templates/config/vite.config.ts
@@ -128,8 +237,8 @@ homepage: https://github.com/ElMassimo/vite_ruby
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@1.0.4/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.0.4/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@1.2.0/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.2.0/vite_ruby/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: