vite_ruby 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92002c0637f3091425c9ee24948c46105bf8ac61d2350dec3479f09e3e94d4ec
-  data.tar.gz: 3e7f52fcb96735c8ec3a68618e7e7273a2abcdf81c1ba84be6b1d2f55cb41f0e
+  metadata.gz: d9655dc4d615097239f9382298b8e2080b0ea63b9d23423cbb6c603817b6a3a1
+  data.tar.gz: 7046d45ec63fdcdb7e712113d0d6861a6c6df11ed06e0befac721315cb31546c
 SHA512:
-  metadata.gz: ab1d9e7b5270d3de5d887da7a8d13659c742ea4df871c2e36c02d5de722b9847a5bc14cd20d72ad969a0f79cae053b92dd7015353086c68721dcdd643af61997
-  data.tar.gz: ad906908aabe2d5fba3f0677ffc847fa59008ff186e62135f86b8ad0982727e55cd9a83ef4c7fa075a169c51411efdff8c7a03c78d1cceb52b91316924d47c2d
+  metadata.gz: c7553b547d6a411ec608128285c84321a96707906b29c8e5c94f91d8a63db65a8054cb6d529bbaf1f30acc1bbbe98df392ea1bea8f0c80b8c827e6a630e4ab38
+  data.tar.gz: 4c9b45b1804d5d8aa10cc8997bbe4ab4277d9d2de44c497e679c9d67bb65dcae516210a8b3813ed84aa4627d28656112a40c69878e7f89aab0b6df045cf496f2

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [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)
 
 

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/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,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/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.sub(':mode', ViteRuby.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 `RACK_ENV=:mode 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.2'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Máximo Mussini
@@ -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.2/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@1.1.2/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: