vite_ruby 3.6.2 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1e2c37395b2cfb186b2c79267e25e5c4b129e2aea33ae65149bb7f87d35e64
-  data.tar.gz: 94b174a0c5bda1db5bdccadfad545a5430c94c6515cd14c77489322dca40ac9d
+  metadata.gz: 0c3311945fbd58ebcc238980b0a10715e2a17603ecefd02f4d4aebea7cec7f24
+  data.tar.gz: e2f3336bc55528d31633cc679d70a28370d9eb88f914a940f46b80bd8d99c6db
 SHA512:
-  metadata.gz: 338e68fd7be884ed89e390ad65a3718834ae5ed89e9b0953897225b878808e9286355558b1de0e7d307ab6cdef0ceabf129fe3ecbde706f65f36f6729c715150
-  data.tar.gz: ef26d5734f92a257f3eea83b69f3c8a1f8ad76071854334a0f08207d7b9306c8c616a591b52995d978e21e0d1586d81def989038befaeac075445d844a555f33
+  metadata.gz: e8ab449ee34c34192ea1cca6c8cdc013b6d1d241371e8f2e92578e8cb040aca9f7cb7b2e1209094efc74d18f7bc2387afd960242230604a0a9210e8e37b5445e
+  data.tar.gz: 4ca76ee1e0288ce280e589668a3104e16c4e15a7efb0579301e5164465c18770ae93f68da9b9c3d6566a8b7a683ecffcd71f677241293d9052ef223209b97688

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# [3.8.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.7.0...vite_ruby@3.8.0) (2024-08-12)
+
+
+### Bug Fixes
+
+* remove `vite:clean` rake task as it can potentially break apps ([824b4ef](https://github.com/ElMassimo/vite_ruby/commit/824b4ef8397828423d2ddda117bf27e365954961)), closes [#438](https://github.com/ElMassimo/vite_ruby/issues/438) [#490](https://github.com/ElMassimo/vite_ruby/issues/490) [#404](https://github.com/ElMassimo/vite_ruby/issues/404)
+
+
+### Features
+
+* remove `ostruct` dependency (closes [#489](https://github.com/ElMassimo/vite_ruby/issues/489)) ([1dfec47](https://github.com/ElMassimo/vite_ruby/commit/1dfec4759bf2c107433c5f1618d97439f6d5bd01))
+
+
+
+# [3.7.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.6.2...vite_ruby@3.7.0) (2024-07-17)
+
+
+### Features
+
+* add `package_manager` config option, experimental support for bun ([#481](https://github.com/ElMassimo/vite_ruby/issues/481)) ([4426cb1](https://github.com/ElMassimo/vite_ruby/commit/4426cb1007dbb58f4637a4423b1e7d640db96841)), closes [#324](https://github.com/ElMassimo/vite_ruby/issues/324)
+* change default execution to use `npx vite` instead ([#480](https://github.com/ElMassimo/vite_ruby/issues/480)) ([330f61f](https://github.com/ElMassimo/vite_ruby/commit/330f61fedadf1274547a069856125e52002d0065)), closes [#462](https://github.com/ElMassimo/vite_ruby/issues/462)
+
+
+
 ## [3.6.2](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.6.1...vite_ruby@3.6.2) (2024-07-16)
 
 

data/default.vite.json

@@ -7,6 +7,7 @@
   "publicOutputDir": "vite",
   "configPath": "config/vite.json",
   "devServerConnectTimeout": 0.01,
+  "packageManager": null,
   "publicDir": "public",
   "entrypointsDir": "entrypoints",
   "sourceCodeDir": "app/frontend",
@@ -16,7 +17,7 @@
   "https": null,
   "port": 3036,
   "hideBuildConsoleOutput": false,
-  "viteBinPath": "node_modules/.bin/vite",
+  "viteBinPath": null,
   "watchAdditionalPaths": [],
   "base": "",
   "ssrBuildEnabled": false,

data/lib/tasks/vite.rake

@@ -25,11 +25,6 @@ namespace :vite do
     ViteRuby.commands.build_from_task('--ssr') if ViteRuby.config.ssr_build_enabled
   end
 
-  desc 'Remove old bundles created by ViteRuby'
-  task :clean, [:keep, :age] => :'vite:verify_install' do |_, args|
-    ViteRuby.commands.clean_from_task(args)
-  end
-
   desc 'Remove the build output directory for ViteRuby'
   task clobber: :'vite:verify_install' do
     ViteRuby.commands.clobber
@@ -43,10 +38,13 @@ namespace :vite do
   desc 'Ensure build dependencies like Vite are installed before bundling'
   task :install_dependencies do
     install_env_args = ENV['VITE_RUBY_SKIP_INSTALL_DEV_DEPENDENCIES'] == 'true' ? {} : { 'NODE_ENV' => 'development' }
-    cmd = ViteRuby.commands.legacy_npm_version? ? 'npx ci --yes' : 'npx --yes ci'
-    result = system(install_env_args, cmd)
-    # Fallback to `yarn` if `npx` is not available.
-    system(install_env_args, 'yarn install --frozen-lockfile') if result.nil?
+
+    install_cmd = case (pkg = ViteRuby.config.package_manager)
+    when 'npm' then 'npm ci'
+    else "#{ pkg } install --frozen-lockfile"
+    end
+
+    system(install_env_args, install_cmd)
   end
 
   desc "Provide information on ViteRuby's environment"
@@ -73,14 +71,6 @@ unless ENV['VITE_RUBY_SKIP_ASSETS_PRECOMPILE_EXTENSION'] == 'true'
     end
   end
 
-  unless Rake::Task.task_defined?('assets:clean')
-    desc 'Remove old compiled assets'
-    Rake::Task.define_task('assets:clean', [:keep, :age])
-  end
-  Rake::Task['assets:clean'].enhance do |_, args|
-    Rake::Task['vite:clean'].invoke(*args.to_h.values)
-  end
-
   if Rake::Task.task_defined?('assets:clobber')
     Rake::Task['assets:clobber'].enhance do
       Rake::Task['vite:clobber'].invoke

data/lib/vite_ruby/cli/install.rb

@@ -6,7 +6,11 @@ require 'json'
 class ViteRuby::CLI::Install < Dry::CLI::Command
   desc 'Performs the initial configuration setup to get started with Vite Ruby.'
 
-  def call(**)
+  option(:package_manager, values: %w[npm pnpm yarn bun], aliases: %w[package-manager with], desc: 'The package manager to use when installing JS dependencies.')
+
+  def call(package_manager: nil, **)
+    ENV['VITE_RUBY_PACKAGE_MANAGER'] ||= package_manager if package_manager
+
     $stdout.sync = true
 
     say 'Creating binstub'
@@ -93,8 +97,7 @@ private
       FileUtils.mv root.join('vite.config.ts'), root.join('vite.config.mts'), force: true, verbose: true
     end
 
-    deps = js_dependencies.join(' ')
-    run_with_capture("#{ npm_install } -D #{ deps }", stdin_data: "\n")
+    install_js_packages js_dependencies.join(' ')
   end
 
   # Internal: Adds compilation output dirs to git ignore.
@@ -128,12 +131,8 @@ private
     end
   end
 
-  # Internal: Support all popular package managers.
-  def npm_install
-    return 'yarn add' if root.join('yarn.lock').exist?
-    return 'pnpm install' if root.join('pnpm-lock.yaml').exist?
-
-    'npm install'
+  def install_js_packages(deps)
+    run_with_capture("#{ config.package_manager } add -D #{ deps }", stdin_data: "\n")
   end
 
   # Internal: Avoid printing warning about missing vite.json, we will create one.

data/lib/vite_ruby/cli/upgrade_packages.rb

@@ -5,7 +5,6 @@ class ViteRuby::CLI::UpgradePackages < ViteRuby::CLI::Install
 
   def call(**)
     say 'Upgrading npm packages'
-    deps = js_dependencies.join(' ')
-    run_with_capture("#{ npm_install } -D #{ deps }")
+    install_js_packages js_dependencies.join(' ')
   end
 end

data/lib/vite_ruby/cli/vite.rb

@@ -5,6 +5,7 @@ class ViteRuby::CLI::Vite < Dry::CLI::Command
 
   def self.executable_options
     option(:mode, default: self::DEFAULT_ENV, values: %w[development production test], aliases: ['m'], desc: 'The build mode for Vite')
+    option(:node_options, desc: 'Node options for the Vite executable', aliases: ['node-options'])
     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
@@ -15,10 +16,20 @@ class ViteRuby::CLI::Vite < Dry::CLI::Command
     option(:clobber, desc: 'Clear cache and previous builds', type: :boolean, aliases: %w[clean clear])
   end
 
-  def call(mode:, args: [], clobber: false, **boolean_opts)
+  def call(mode:, args: [], clobber: false, node_options: nil, inspect: nil, trace_deprecation: nil, **boolean_opts)
     ViteRuby.env['VITE_RUBY_MODE'] = mode
     ViteRuby.commands.clobber if clobber
+
+    node_options = [
+      node_options,
+      ('--inspect-brk' if inspect),
+      ('--trace-deprecation' if trace_deprecation),
+    ].compact.join(' ')
+
+    args << %(--node-options="#{ node_options }") unless node_options.empty?
+
     boolean_opts.map { |name, value| args << "--#{ name }" if value }
+
     yield(args)
   end
 end

data/lib/vite_ruby/commands.rb

@@ -28,38 +28,6 @@ class ViteRuby::Commands
     $stdout.puts "Removed vite cache and output dirs:\n\t#{ dirs.join("\n\t") }"
   end
 
-  # Public: Receives arguments from a rake task.
-  def clean_from_task(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.
-  #
-  # keep_up_to - Max amount of backups to preserve.
-  # age_in_seconds - Amount of time to look back in order to preserve them.
-  #
-  # NOTE: By default keeps the last version, or 2 if created in the past hour.
-  #
-  # Examples:
-  #   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 may_clean?
-
-    versions
-      .each_with_index
-      .drop_while { |(mtime, _files), index|
-        max_age = [0, Time.now - Time.at(mtime)].max
-        max_age < age_in_seconds || index < keep_up_to
-      }
-      .each do |(_, files), _|
-        clean_files(files)
-      end
-    true
-  end
-
   # Internal: Installs the binstub for the CLI in the appropriate path.
   def install_binstubs
     `bundle binstub vite_ruby --path #{ config.root.join('bin') }`
@@ -109,11 +77,11 @@ class ViteRuby::Commands
         $stdout.puts "#{ framework }: #{ Gem.loaded_specs[framework]&.version }"
       end
 
-      $stdout.puts "node: #{ `node --version` }"
-      $stdout.puts "npm: #{ `npm --version` }"
-      $stdout.puts "yarn: #{ `yarn --version` rescue nil }"
-      $stdout.puts "pnpm: #{ `pnpm --version` rescue nil }"
       $stdout.puts "ruby: #{ `ruby --version` }"
+      $stdout.puts "node: #{ `node --version` }"
+
+      pkg = config.package_manager
+      $stdout.puts "#{ pkg }: #{ `#{ pkg } --version` rescue nil }"
 
       $stdout.puts "\n"
       packages = `npm ls vite vite-plugin-ruby`
@@ -130,31 +98,6 @@ private
 
   def_delegators :@vite_ruby, :config, :builder, :manifest, :logger, :logger=
 
-  def may_clean?
-    config.build_output_dir.exist? && config.manifest_paths.any?
-  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_paths - files_referenced_in_manifests
-    entries.reject { |file| File.directory?(file) }
-      .group_by { |file| File.mtime(file).utc.to_i }
-      .sort.reverse
-  end
-
-  def files_referenced_in_manifests
-    config.manifest_paths.flat_map { |path|
-      JSON.parse(path.read).map { |_, entry| entry['file'] }
-    }.compact.uniq.map { |path| config.build_output_dir.join(path).to_s }
-  end
-
   def with_node_env(env)
     original = ENV['NODE_ENV']
     ENV['NODE_ENV'] = env

data/lib/vite_ruby/config.rb

@@ -96,10 +96,11 @@ private
   def coerce_values(config)
     config['mode'] = config['mode'].to_s
     config['port'] = config['port'].to_i
-    config['root'] = Pathname.new(config['root'])
-    config['build_cache_dir'] = config['root'].join(config['build_cache_dir'])
-    config['ssr_output_dir'] = config['root'].join(config['ssr_output_dir'])
+    config['root'] = root = Pathname.new(config['root'])
+    config['build_cache_dir'] = root.join(config['build_cache_dir'])
+    config['ssr_output_dir'] = root.join(config['ssr_output_dir'])
     coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https', 'skip_compatibility_check', 'skip_proxy')
+    config['package_manager'] ||= detect_package_manager(root)
   end
 
   # Internal: Coerces configuration options to boolean.
@@ -107,6 +108,15 @@ private
     names.each { |name| config[name] = [true, 'true'].include?(config[name]) }
   end
 
+  def detect_package_manager(root)
+    return 'npm' if root.join('package-lock.json').exist?
+    return 'pnpm' if root.join('pnpm-lock.yaml').exist?
+    return 'bun' if root.join('bun.lockb').exist?
+    return 'yarn' if root.join('yarn.lock').exist?
+
+    'npm'
+  end
+
   def initialize(attrs)
     @config = attrs.tap { |config| coerce_values(config) }.freeze
     ViteRuby::CompatibilityCheck.verify_plugin_version(root) unless skip_compatibility_check
@@ -189,6 +199,7 @@ private
 
   # Internal: If any of these files is modified the build won't be skipped.
   DEFAULT_WATCHED_PATHS = %w[
+    bun.lockb
     package-lock.json
     package.json
     pnpm-lock.yaml
@@ -196,8 +207,8 @@ private
     tailwind.config.js
     vite.config.js
     vite.config.mjs
-    vite.config.ts
     vite.config.mts
+    vite.config.ts
     windi.config.ts
     yarn.lock
   ].freeze

data/lib/vite_ruby/manifest.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 # Public: Registry for accessing resources managed by Vite, using a generated
 # manifest file which maps entrypoint names to file paths.
 #
@@ -214,7 +212,7 @@ private
 
   # Internal: Raises a detailed message when an entry is missing in the manifest.
   def missing_entry_error(name, **options)
-    raise ViteRuby::MissingEntrypointError, OpenStruct.new(
+    raise ViteRuby::MissingEntrypointError.new(
       file_name: resolve_entry_name(name, **options),
       last_build: builder.last_build_metadata,
       manifest: @manifest,

data/lib/vite_ruby/missing_entrypoint_error.rb

@@ -5,11 +5,10 @@
 # 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
+  attr_reader :file_name, :last_build, :manifest, :config
 
-  def initialize(info)
-    @info = info
+  def initialize(file_name:, last_build:, manifest:, config:)
+    @file_name, @last_build, @manifest, @config = file_name, last_build, manifest, config
     super <<~MSG
       Vite Ruby can't find #{ file_name } in the manifests.
 

data/lib/vite_ruby/runner.rb

@@ -28,24 +28,26 @@ private
   # Internal: Returns an Array with the command to run.
   def command_for(args)
     [config.to_env(env)].tap do |cmd|
-      args = args.clone
-      cmd.push('node', '--inspect-brk') if args.delete('--inspect')
-      cmd.push('node', '--trace-deprecation') if args.delete('--trace_deprecation')
-      cmd.push(*vite_executable)
-      cmd.push(*args)
+      exec_args, vite_args = args.partition { |arg| arg.start_with?('--node-options') }
+      cmd.push(*vite_executable(*exec_args))
+      cmd.push(*vite_args)
       cmd.push('--mode', config.mode) unless args.include?('--mode') || args.include?('-m')
     end
   end
 
   # Internal: Resolves to an executable for Vite.
-  def vite_executable
+  def vite_executable(*exec_args)
     bin_path = config.vite_bin_path
-    return [bin_path] if File.exist?(bin_path)
-
-    if config.root.join('yarn.lock').exist?
-      %w[yarn vite]
-    else
-      ["#{ `npm bin`.chomp }/vite"]
+    return [bin_path] if bin_path && File.exist?(bin_path)
+
+    x = case config.package_manager
+    when 'npm' then %w[npx]
+    when 'pnpm' then %w[pnpm exec]
+    when 'bun' then %w[bun x]
+    when 'yarn' then %w[yarn]
+    else raise ArgumentError, "Unknown package manager #{ config.package_manager.inspect }"
     end
+
+    [*x, *exec_args, 'vite']
   end
 end

data/lib/vite_ruby/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class ViteRuby
-  VERSION = '3.6.2'
+  VERSION = '3.8.0'
 
   # Internal: Versions used by default when running `vite install`.
   DEFAULT_VITE_VERSION = '^5.0.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.8.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -208,8 +208,8 @@ homepage: https://github.com/ElMassimo/vite_ruby
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.6.2/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.6.2/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.8.0/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.8.0/vite_ruby/CHANGELOG.md
 post_install_message: "Thanks for installing Vite Ruby!\n\nIf you upgraded the gem
   manually, please run:\n\tbundle exec vite upgrade"
 rdoc_options: []