vite_ruby 1.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 436737196c45af00694c405d697cea826566bec8ab5e0ef246f5917b253df3cf
-  data.tar.gz: c052a43c6faa9c07318658f870a50db7aabdf7beb7074e80dc9026272125becc
+  metadata.gz: 75c25f6f407996069ce830b7822b0d10041f930ce7ce6bc317a6413a73f66ae8
+  data.tar.gz: c8e1bb8d969e408f0b21bdd3a4bb9d0e5a0a61e5d72635bb021c2f423676b170
 SHA512:
-  metadata.gz: b164085097cd79feabc3dffec84129b042a92ede8a37de7aaa04adb1a679be37af609d4eba1f105cb5a924cb173e425c850795f346a2648de7b4dd80b3e9f1d1
-  data.tar.gz: 67bb02e9619228ac48361fac841c46d032f1f0094ea6fc57cfe8dd68431f1fb4a1101de7dea04b911b40057acbf1484eda11046a2dce85c5699a1643b6c129ef
+  metadata.gz: 913332a8629f8521a7af235951e761a103b167ed76f17021691835a8508c52d51e7ac9cdf39f46e73461a98c6d11de99900eccd4c4a45490ee23a405c7904f7c
+  data.tar.gz: 91faeb4e8810c9b260d2dc91b0df4db41f50b3f533ca44c60859200ecfbfddccb3406814f651048f89f4f6e119f6d032cfbe85d603289be65399f9815e68cd34

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+## [1.2.2](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.1...vite_ruby@1.2.2) (2021-03-20)
+
+
+### Bug Fixes
+
+* Avoid prompts when using npx outside a CI ([ed7ccd7](https://github.com/ElMassimo/vite_ruby/commit/ed7ccd7d32c079ab78555ecd36dcb68ad2da331e))
+* Simplify installation of build dependencies by using package manager flags ([5c8bb62](https://github.com/ElMassimo/vite_ruby/commit/5c8bb625926f2ab1788a3e3a22aeafd7104984cb))
+
+
+
+## [1.2.1](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.0...vite_ruby@1.2.1) (2021-03-19)
+
+
+### Bug Fixes
+
+* Use the mode option in `clobber` ([add76b2](https://github.com/ElMassimo/vite_ruby/commit/add76b2a63ea64336235536b8b5670bace357b6e))
+
+
+
+# [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)
 
 

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'
@@ -30,9 +29,9 @@ namespace :vite do
     ViteRuby.commands.verify_install
   end
 
-  desc 'Install all JavaScript dependencies'
+  desc 'Ensures build dependencies like Vite are installed when compiling assets'
   task :install_dependencies do
-    system({ 'NODE_ENV' => 'development' }, 'npx ci')
+    system({ 'NODE_ENV' => 'development' }, 'npx --yes ci')
   end
 
   desc "Provide information on ViteRuby's environment"
@@ -49,3 +48,9 @@ if Rake::Task.task_defined?('assets:precompile')
 else
   Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build'])
 end
+
+# Any prerequisite task that installs packages should also install build dependencies.
+if ARGV.include?('assets:precompile')
+  ENV['NPM_CONFIG_PRODUCTION'] = 'false'
+  ENV['YARN_PRODUCTION'] = 'false'
+end

data/lib/vite_ruby.rb

@@ -94,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

@@ -1,5 +1,7 @@
 # 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.
@@ -7,16 +9,26 @@ ViteRuby::Build = Struct.new(:success, :timestamp, :digest, :current_digest) do
     new(attrs['success'], attrs['timestamp'] || 'never', attrs['digest'] || 'none', current_digest)
   end
 
-  # Internal: Returns true if watched files have changed since the last build.
+  # 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
+    digest != current_digest || retry_failed?
   end
 
-  # Internal: Returns true if watched files have not changed since the last build.
+  # 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)

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,7 +5,8 @@ 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)
@@ -15,8 +16,9 @@ class ViteRuby::CLI::Build < Dry::CLI::Command
   shared_options
   option(:force, desc: 'Force the build even if assets have not changed', type: :boolean)
 
-  def call(mode:, args: [], **boolean_opts)
+  def call(mode:, args: [], clobber: false, **boolean_opts)
     ViteRuby.env['VITE_RUBY_MODE'] = mode
+    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

data/lib/vite_ruby/cli/clobber.rb

@@ -0,0 +1,14 @@
+# 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(mode:, **)
+    ViteRuby.env['VITE_RUBY_MODE'] = mode
+    ViteRuby.commands.clobber
+  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 --package @antfu/ni -- ni -D #{ deps }")
+      stdout, stderr, status = Open3.capture3({}, "npx --yes --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

@@ -23,9 +23,9 @@ class ViteRuby::Commands
 
   # 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.

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/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,9 +10,6 @@
 # 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
@@ -142,39 +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)
-    last_build = builder.last_build_metadata
-    raise ViteRuby::Manifest::MissingEntryError, <<~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) }
-      Visit the Troubleshooting guide for more information:
-        https://vite-ruby.netlify.app/guide/troubleshooting.html#troubleshooting
-      #{ "\nContent in your manifests:\n#{ JSON.pretty_generate(@manifest) }\n" if last_build.success }
-      #{ "\nLast build in #{ config.mode } mode:\n#{ last_build.to_json }\n" unless last_build.success.nil? }
-    MSG
+    raise ViteRuby::MissingEntrypointError, OpenStruct.new(
+      file_name: with_file_extension(name, type),
+      last_build: builder.last_build_metadata,
+      manifest: @manifest,
+      config: config,
+    )
   end
-
-  def possible_causes(last_build)
-    return FAILED_BUILD_CAUSES 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 --force` 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_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

@@ -10,11 +10,12 @@ class ViteRuby::Runner
 
   # Public: Executes Vite with the specified arguments.
   def run(argv, capture: false)
-    if capture
-      capture3_with_output(*command_for(argv), chdir: config.root)
-    else
-      Dir.chdir(config.root) { Kernel.exec(*command_for(argv)) }
-    end
+    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
@@ -29,15 +30,16 @@ private
       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))
+      cmd.append(vite_executable)
       cmd.append(*args)
       cmd.append('--mode', config.mode) unless args.include?('--mode') || args.include?('-m')
     end
   end
 
   # Internal: Resolves to an executable for Vite.
-  def vite_executable(cmd)
-    cmd.include?('node') ? ['./node_modules/.bin/vite'] : ['npx', '--no-install', '--', 'vite']
+  def vite_executable
+    bin_path = config.vite_bin_path
+    File.exist?(bin_path) ? bin_path : "#{ `npm bin`.chomp }/vite"
   end
 
   # Internal: A modified version of capture3 that continuosly prints stdout.

data/lib/vite_ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2021-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -217,13 +217,17 @@ files:
 - 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
@@ -233,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.1.0/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.1.0/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@1.2.2/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.2.2/vite_ruby/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: