vite_ruby 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6024067932bb5062002e46418a1861eb4193916c7454e24245fe3cf83c56795d
-  data.tar.gz: cfc52727b1e4cde4936254cd0025d97942e3b636c5647742dc1c809fb3a9bba4
+  metadata.gz: 99a8b071373aa761774cd95dd665040264cc7646114315edeecc3e355af3ef23
+  data.tar.gz: 1276207af761a598b3ea291ead1ccc2ceafb13117adcc150988d4532b8c71ae3
 SHA512:
-  metadata.gz: 489c44241c90ac71fd978a8142554581505e05acce6268a062738a4f1f9c5e88a2cca39778459cea3e7e79d5116bc7f8ea1b4455f65fe9d436a15164ab5704cc
-  data.tar.gz: 2425fb29d5151d56f2774c435eb2a5b636c765e229aff3a99936300453ec77c281fdac8c85c6885d1cc3ce900a470f3b58cb6135f0a51124ef34c965282d9b38
+  metadata.gz: c213bbcc8ed5aeed6c8862f51fa096be5fc8d9cfa3c708c7e50a607869c94d8989cf5484704ec4f155760b7f6e53f3be2ab11526e7b2c9df1849b121bb7d79d4
+  data.tar.gz: 2f5d739582f2d1135ee5326cc8ffdd5c773dac791828317a61f7ff32a352d54e77f38d32d3d6b174f6439c98ff27479a786352b740f485c834b4f0e68cb67878

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+# [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)
+
+
+
+## [3.6.1](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.6.0...vite_ruby@3.6.1) (2024-07-16)
+
+
+### Bug Fixes
+
+* use ESM by default in new installations ([#479](https://github.com/ElMassimo/vite_ruby/issues/479)) ([cc379ca](https://github.com/ElMassimo/vite_ruby/commit/cc379ca613dd4e5863f8556be62ea623b56cfe0c)), closes [#431](https://github.com/ElMassimo/vite_ruby/issues/431)
+
+
+
+# [3.6.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.5.0...vite_ruby@3.6.0) (2024-06-07)
+
+
+### Features
+
+* allow skipping dependency install in assets:precompile ([#451](https://github.com/ElMassimo/vite_ruby/issues/451)) ([5a922b2](https://github.com/ElMassimo/vite_ruby/commit/5a922b2071446e3880b17503474a0c7806eab6a7))
+
+
+
 # [3.5.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.4.0...vite_ruby@3.5.0) (2023-11-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

@@ -43,10 +43,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"
@@ -59,12 +62,18 @@ unless ENV['VITE_RUBY_SKIP_ASSETS_PRECOMPILE_EXTENSION'] == 'true'
   if Rake::Task.task_defined?('assets:precompile')
     Rake::Task['assets:precompile'].enhance do |task|
       prefix = task.name.split(/#|assets:precompile/).first
-      Rake::Task["#{ prefix }vite:install_dependencies"].invoke
+      unless ENV['VITE_RUBY_SKIP_ASSETS_PRECOMPILE_INSTALL'] == 'true'
+        Rake::Task["#{ prefix }vite:install_dependencies"].invoke
+      end
       Rake::Task["#{ prefix }vite:build_all"].invoke
     end
   else
     desc 'Bundle Vite assets'
-    Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build_all'])
+    if ENV['VITE_RUBY_SKIP_ASSETS_PRECOMPILE_INSTALL'] == 'true'
+      Rake::Task.define_task('assets:precompile' => 'vite:build_all')
+    else
+      Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build_all'])
+    end
   end
 
   unless Rake::Task.task_defined?('assets:clean')

data/lib/vite_ruby/cli/install.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 require 'stringio'
+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'
@@ -79,9 +84,20 @@ private
   # Internal: Installs vite and vite-plugin-ruby at the project level.
   def install_js_dependencies
     package_json = root.join('package.json')
-    write(package_json, '{}') unless package_json.exist?
-    deps = js_dependencies.join(' ')
-    run_with_capture("#{ npm_install } -D #{ deps }", stdin_data: "\n")
+    unless package_json.exist?
+      write package_json, <<~JSON
+        {
+          "private": true,
+          "type": "module"
+        }
+      JSON
+    end
+
+    if (JSON.parse(package_json.read)['type'] != 'module' rescue nil)
+      FileUtils.mv root.join('vite.config.ts'), root.join('vite.config.mts'), force: true, verbose: true
+    end
+
+    install_js_packages js_dependencies.join(' ')
   end
 
   # Internal: Adds compilation output dirs to git ignore.
@@ -115,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

@@ -109,11 +109,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`

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,12 +199,15 @@ 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
     postcss.config.js
     tailwind.config.js
     vite.config.js
+    vite.config.mjs
+    vite.config.mts
     vite.config.ts
     windi.config.ts
     yarn.lock

data/lib/vite_ruby/manifest.rb

@@ -1,5 +1,7 @@
 # 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.
 #

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.5.0'
+  VERSION = '3.7.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.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2024-07-17 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.5.0/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.5.0/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.7.0/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.7.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: []