vite_ruby 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 272fe6da1fb380725808470d8a54d547343027d8f81df36f0535bda3a6a0f0db
-  data.tar.gz: 0d906d89d6f6d5ce8502555117013fc0a1f325e26533419972f089913ea8da69
+  metadata.gz: b89bf35a3d3734c64977195bf0695546b121e9ff83d02859475f503fdd65f865
+  data.tar.gz: dda1241e89c4f794504e51c9c47cffa8eb37238fc17406432a876e49328600eb
 SHA512:
-  metadata.gz: a094dd8a9123615b06e1266515015d5c2ef8a82842b006a6262f552e0412e68465b8c7a45c2a16749d23abba5577d9a4c89ec125b59b68bad5767db9f800750a
-  data.tar.gz: 765d8ddd8023f28029eeff363815257b3b1b1601c652f6df213a53c9a39a1f9bd47ee63af11b8c9dc6ab2c845843988aebec4195c3cb885c131c56e40c488615
+  metadata.gz: 62a5252117efadda1bedaf21b8bcb63b86f6489eed35706e2afbc2ecb9c8258f944c1b6b4276884b5920671b528e96bc9c00a4fd034932b79842dcbc8ec50612
+  data.tar.gz: d0425780b02d50a35a79d6791134bf400aebdf07abb9c19c70e692976c68062ec681364486d44c95c5592a4f802db856daca6afe0b3fa7cb8b8b669c5d8e3ccc

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [3.1.2](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.1.1...vite_ruby@3.1.2) (2022-05-12)
+
+
+### Features
+
+* add support for SSR builds (experimental) ([#212](https://github.com/ElMassimo/vite_ruby/issues/212)) ([4d6cd2b](https://github.com/ElMassimo/vite_ruby/commit/4d6cd2b84f670b1703e3bde7033e822be97bf505))
+* ignore any vite dirs in .gitignore installation (for ssr builds) ([fd68420](https://github.com/ElMassimo/vite_ruby/commit/fd68420dfaeb79b97f8edade5bf17bfe81fd2486))
+
+
+
 ## [3.1.1](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.1.0...vite_ruby@3.1.1) (2022-04-14)
 
 

data/default.vite.json

@@ -17,5 +17,8 @@
   "hideBuildConsoleOutput": false,
   "viteBinPath": "node_modules/.bin/vite",
   "watchAdditionalPaths": [],
-  "base": ""
+  "base": "",
+  "ssrBuildEnabled": false,
+  "ssrEntrypoint": "~/ssr/ssr.{js,ts,jsx,tsx}",
+  "ssrOutputDir": "public/ssr"
 }

data/lib/tasks/vite.rake

@@ -9,27 +9,38 @@ namespace :vite do
     ViteRuby.commands.install_binstubs
   end
 
-  desc 'Compile JavaScript packs using vite for production with digests'
+  desc 'Bundle frontend entrypoints using ViteRuby'
   task build: :'vite:verify_install' do
     ViteRuby.commands.build_from_task
   end
 
-  desc 'Remove old compiled vites'
+  desc 'Bundle a Node.js app from the SSR entrypoint using ViteRuby'
+  task build_ssr: :'vite:verify_install' do
+    ViteRuby.commands.build_from_task('--ssr')
+  end
+
+  desc 'Bundle entrypoints using Vite Ruby (SSR only if enabled)'
+  task build_all: :'vite:verify_install' do
+    ViteRuby.commands.build_from_task
+    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 vite build output directory'
+  desc 'Remove the build output directory for ViteRuby'
   task clobber: :'vite:verify_install' do
     ViteRuby.commands.clobber
   end
 
-  desc 'Verifies if ViteRuby is properly installed in this application'
+  desc 'Verify if ViteRuby is properly installed in the app'
   task :verify_install do
     ViteRuby.commands.verify_install
   end
 
-  desc 'Ensures build dependencies like Vite are installed when compiling assets'
+  desc 'Ensure build dependencies like Vite are installed before bundling'
   task :install_dependencies do
     system({ 'NODE_ENV' => 'development' }, 'npx ci --yes')
   end
@@ -45,10 +56,10 @@ unless ENV['VITE_RUBY_SKIP_ASSETS_PRECOMPILE_EXTENSION'] == 'true'
     Rake::Task['assets:precompile'].enhance do |task|
       prefix = task.name.split(/#|assets:precompile/).first
       Rake::Task["#{ prefix }vite:install_dependencies"].invoke
-      Rake::Task["#{ prefix }vite:build"].invoke
+      Rake::Task["#{ prefix }vite:build_all"].invoke
     end
   else
-    Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build'])
+    Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build_all'])
   end
 
   unless Rake::Task.task_defined?('assets:clean')

data/lib/vite_ruby/build.rb

@@ -1,17 +1,26 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'time'
 
 # Internal: Value object with information about the last build.
-ViteRuby::Build = Struct.new(:success, :timestamp, :vite_ruby, :digest, :current_digest) do
+ViteRuby::Build = Struct.new(:success, :timestamp, :vite_ruby, :digest, :current_digest, :last_build_path) do
   # Internal: Combines information from a previous build with the current digest.
-  def self.from_previous(attrs, current_digest)
+  def self.from_previous(last_build_path, current_digest)
+    attrs = begin
+      # Reads metadata recorded on the last build, if it exists.
+      last_build_path.exist? ? JSON.parse(last_build_path.read.to_s) : {}
+    rescue JSON::JSONError, Errno::ENOENT, Errno::ENOTDIR
+      {}
+    end
+
     new(
       attrs['success'],
       attrs['timestamp'] || 'never',
       attrs['vite_ruby'] || 'unknown',
       attrs['digest'] || 'none',
       current_digest,
+      last_build_path,
     )
   end
 
@@ -42,11 +51,23 @@ ViteRuby::Build = Struct.new(:success, :timestamp, :vite_ruby, :digest, :current
       Time.now.strftime('%F %T'),
       ViteRuby::VERSION,
       current_digest,
+      current_digest,
+      last_build_path,
     )
   end
 
+  # Internal: Writes the result of the new build to a local file.
+  def write_to_cache
+    last_build_path.write to_json
+  end
+
   # Internal: Returns a JSON string with the metadata of the build.
   def to_json(*_args)
-    JSON.pretty_generate(to_h)
+    JSON.pretty_generate(
+      success: success,
+      timestamp: timestamp,
+      vite_ruby: vite_ruby,
+      digest: digest,
+    )
   end
 end

data/lib/vite_ruby/builder.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
 require 'digest/sha1'
 
 # Public: Keeps track of watched files and triggers builds as needed.
@@ -12,7 +11,8 @@ 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(*args)
-    last_build = last_build_metadata
+    last_build = last_build_metadata(ssr: args.include?('--ssr'))
+
     if args.delete('--force') || last_build.stale?
       build_with_vite(*args).tap { |success| record_build_metadata(success, last_build) }
     elsif last_build.success
@@ -25,8 +25,8 @@ class ViteRuby::Builder
   end
 
   # Internal: Reads the result of the last compilation from disk.
-  def last_build_metadata
-    ViteRuby::Build.from_previous(last_build_attrs, watched_files_digest)
+  def last_build_metadata(ssr: false)
+    ViteRuby::Build.from_previous(last_build_path(ssr: ssr), watched_files_digest)
   end
 
 private
@@ -35,22 +35,15 @@ private
 
   def_delegators :@vite_ruby, :config, :logger, :run
 
-  # 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: 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
+    build.with_result(success).write_to_cache
   end
 
   # 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")
+  def last_build_path(ssr:)
+    config.build_cache_dir.join("last#{ '-ssr' if ssr }-build-#{ config.mode }.json")
   end
 
   # Internal: Returns a digest of all the watched files, allowing to detect

data/lib/vite_ruby/cli/build.rb

@@ -5,6 +5,7 @@ class ViteRuby::CLI::Build < ViteRuby::CLI::Vite
 
   desc 'Bundle all entrypoints using Vite.'
   shared_options
+  option(:ssr, desc: 'Build the SSR entrypoint instead', type: :boolean)
   option(:force, desc: 'Force the build even if assets have not changed', type: :boolean)
   option(:watch, desc: 'Start the Rollup watcher and rebuild on files changes', type: :boolean)
 

data/lib/vite_ruby/cli/install.rb

@@ -91,9 +91,7 @@ private
     append(gitignore_file, <<~GITIGNORE)
 
       # Vite Ruby
-      /public/vite
-      /public/vite-dev
-      /public/vite-test
+      /public/vite*
       node_modules
       # Vite uses dotenv and suggests to ignore local-only env files. See
       # https://vitejs.dev/guide/env-and-mode.html#env-files

data/lib/vite_ruby/cli/ssr.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class ViteRuby::CLI::SSR < ViteRuby::CLI::Vite
+  DEFAULT_ENV = CURRENT_ENV || 'production'
+
+  desc 'Run the resulting app from building in SSR mode.'
+  executable_options
+
+  def call(mode:, inspect: false, trace_deprecation: false)
+    ViteRuby.env['VITE_RUBY_MODE'] = mode
+    cmd = [
+      'node',
+      ('--inspect-brk' if inspect),
+      ('--trace-deprecation' if trace_deprecation),
+      ViteRuby.config.ssr_output_dir.join('ssr.js'),
+    ]
+    Kernel.exec(*cmd.compact.map(&:to_s))
+  end
+end

data/lib/vite_ruby/cli/vite.rb

@@ -3,14 +3,18 @@
 class ViteRuby::CLI::Vite < Dry::CLI::Command
   CURRENT_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV']
 
-  def self.shared_options
+  def self.executable_options
     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
 
+  def self.shared_options
+    executable_options
+    option(:debug, desc: 'Run Vite in verbose mode, printing all debugging output', aliases: ['verbose'], type: :boolean)
+    option(:clobber, desc: 'Clear cache and previous builds', type: :boolean, aliases: %w[clean clear])
+  end
+
   def call(mode:, args: [], clobber: false, **boolean_opts)
     ViteRuby.env['VITE_RUBY_MODE'] = mode
     ViteRuby.commands.clobber if clobber

data/lib/vite_ruby/cli.rb

@@ -11,6 +11,7 @@ class ViteRuby::CLI
   register 'clobber', Clobber, aliases: %w[clean clear]
   register 'dev', Dev, aliases: %w[d serve]
   register 'install', Install
+  register 'ssr', SSR
   register 'version', Version, aliases: ['v', '-v', '--version', 'info']
   register 'upgrade', Upgrade, aliases: ['update']
   register 'upgrade_packages', UpgradePackages, aliases: ['update_packages']

data/lib/vite_ruby/commands.rb

@@ -23,7 +23,7 @@ class ViteRuby::Commands
 
   # Public: Removes all build cache and previously compiled assets.
   def clobber
-    dirs = [config.build_output_dir, config.build_cache_dir, config.vite_cache_dir]
+    dirs = [config.build_output_dir, config.ssr_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

data/lib/vite_ruby/compatibility_check.rb

@@ -24,7 +24,7 @@ module ViteRuby::CompatibilityCheck
         raise ArgumentError, <<~ERROR
           vite-plugin-ruby@#{ npm_req } might not be compatible with vite_ruby-#{ ViteRuby::VERSION }
 
-          You may disable this check if needed: https://vite-ruby.netlify.app/config/#skipCompatibilityCheck
+          You may disable this check if needed: https://vite-ruby.netlify.app/config/#skipcompatibilitycheck
 
           You may upgrade both by running:
 

data/lib/vite_ruby/config.rb

@@ -79,6 +79,7 @@ private
     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'])
     coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https', 'skip_compatibility_check')
   end
 

data/lib/vite_ruby/version.rb

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

data/lib/vite_ruby.rb

@@ -11,6 +11,7 @@ loader.ignore("#{ __dir__ }/install")
 loader.ignore("#{ __dir__ }/tasks")
 loader.ignore("#{ __dir__ }/exe")
 loader.inflector.inflect('cli' => 'CLI')
+loader.inflector.inflect('ssr' => 'SSR')
 loader.inflector.inflect('io' => 'IO')
 loader.setup
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -179,6 +179,7 @@ files:
 - lib/vite_ruby/cli/dev.rb
 - lib/vite_ruby/cli/file_utils.rb
 - lib/vite_ruby/cli/install.rb
+- lib/vite_ruby/cli/ssr.rb
 - lib/vite_ruby/cli/upgrade.rb
 - lib/vite_ruby/cli/upgrade_packages.rb
 - lib/vite_ruby/cli/version.rb
@@ -201,8 +202,8 @@ homepage: https://github.com/ElMassimo/vite_ruby
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.1.1/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.1.1/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.1.2/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.1.2/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: []