vite_ruby 3.0.0.beta.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dd16ba0c6a663008ac6fdf8679db418557dd9a6930dd3e5ef3df70a0e6ac326
-  data.tar.gz: 960ce8db783f8305d8fa5ff41330226ac44e0cfc0feb702a30400c60d4910d08
+  metadata.gz: 9606e4636341971487203132916240e61c6f78de01009ee2cc001ad8cc13f12a
+  data.tar.gz: 521ccded8cafa3b17ae62408650c0673c78b1441fc669532b240555702b51642
 SHA512:
-  metadata.gz: 7f9e9b3727563b7a8c2c81fababf599a0c4158ee3d2e06c2fd16a4643cea8a461f178425d0f044ba467000e468642e3932873f18ac3866cd09f02a7c201c9392
-  data.tar.gz: abcd610257b8edaa0b1d8849d35750ad399b250178bcf1f501935e373b85b02465b247ca43918186f20ed37bf8e33bef29852cfa1af9a716c18b089db8de497e
+  metadata.gz: b903a283f653cd02e89272174d66efd5991266c174418e978ed680205ea703d2d2a9384b16a155618788eaaae3748cb900eeca5b354e3e4277de7709a7784605
+  data.tar.gz: 60e731442205c932f7033317ea75651370474ae419d70f6204fa59059be61d54f472f583d136d93672167ac0777d049a229928f79896b6a96448525b44e5be83

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [3.0.1](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@3.0.0...vite_ruby@3.0.1) (2021-10-27)
+
+
+### Features
+
+* expose the `--watch` flag for the build command ([4e20d0a](https://github.com/ElMassimo/vite_ruby/commit/4e20d0a7b697b535e13335dac5a75fb8a193a133))
+
+
+
+# [3.0.0](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.20...vite_ruby@3.0.0) (2021-08-16)
+
+See https://github.com/ElMassimo/vite_ruby/pull/116 for features and breaking changes.
+
 ## [1.2.20](https://github.com/ElMassimo/vite_ruby/compare/vite_ruby@1.2.18...vite_ruby@1.2.20) (2021-07-30)
 
 

data/default.vite.json

@@ -1,5 +1,5 @@
 {
-  "additionalInputGlobs": ["{assets,fonts,icons,images}/**/*"],
+  "additionalEntrypoints": ["~/{assets,fonts,icons,images}/**/*"],
   "assetHost": null,
   "assetsDir": "assets",
   "autoBuild": false,
@@ -10,6 +10,7 @@
   "publicDir": "public",
   "entrypointsDir": "entrypoints",
   "sourceCodeDir": "app/frontend",
+  "skipCompatibilityCheck": false,
   "host": "localhost",
   "https": null,
   "port": 3036,

data/lib/tasks/vite.rake

@@ -40,13 +40,15 @@ namespace :vite do
   end
 end
 
-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:build"].invoke
+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:build"].invoke
+    end
+  else
+    Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build'])
   end
-else
-  Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build'])
 end
 
 # Any prerequisite task that installs packages should also install build dependencies.

data/lib/vite_ruby/builder.rb

@@ -57,7 +57,7 @@ private
   # changes, and skip Vite builds if no files have changed.
   def watched_files_digest
     Dir.chdir File.expand_path(config.root) do
-      files = Dir[*watched_paths].reject { |f| File.directory?(f) }
+      files = Dir[*config.watched_paths].reject { |f| File.directory?(f) }
       file_ids = files.sort.map { |f| "#{ File.basename(f) }/#{ Digest::SHA1.file(f).hexdigest }" }
       Digest::SHA1.hexdigest(file_ids.join('/'))
     end
@@ -88,24 +88,4 @@ private
       logger.error '❌ Check that vite and vite-plugin-ruby are in devDependencies and have been installed. ' if stderr.include?('ERR! canceled')
     end
   end
-
-  # Internal: Files and directories that should be watched for changes.
-  #
-  # NOTE: You can specify additional ones in vite.json using "watchAdditionalPaths": [...]
-  def watched_paths
-    [
-      *config.watch_additional_paths,
-      "#{ config.source_code_dir }/**/*",
-      'package-lock.json',
-      'package.json',
-      'pnpm-lock.yaml',
-      'postcss.config.js',
-      'tailwind.config.js',
-      'vite.config.js',
-      'vite.config.ts',
-      'windi.config.ts',
-      'yarn.lock',
-      config.config_path,
-    ].freeze
-  end
 end

data/lib/vite_ruby/cli/build.rb

@@ -6,6 +6,7 @@ class ViteRuby::CLI::Build < ViteRuby::CLI::Vite
   desc 'Bundle all entrypoints using Vite.'
   shared_options
   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)
 
   def call(**options)
     super { |args| ViteRuby.commands.build_from_task(*args) }

data/lib/vite_ruby/commands.rb

@@ -71,7 +71,7 @@ class ViteRuby::Commands
       warn <<~WARN
 
         vite binstub not found.
-        Have you run `bundle binstub vite`?
+        Have you run `bundle binstub vite_ruby`?
         Make sure the bin directory and bin/vite are not included in .gitignore
       WARN
     end
@@ -108,6 +108,8 @@ class ViteRuby::Commands
       packages = `npm ls vite vite-plugin-ruby`
       packages_msg = packages.include?('vite@') ? "installed packages:\n#{ packages }" : '❌ Check that vite and vite-plugin-ruby have been added as development dependencies and installed.'
       $stdout.puts packages_msg
+
+      ViteRuby::CompatibilityCheck.verify_plugin_version(config.root)
     end
   end
 

data/lib/vite_ruby/compatibility_check.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# Internal: Verifies that the installed vite-plugin-ruby version is compatible
+# with the current version of vite_ruby.
+#
+# This helps to prevent more subtle runtime errors if there is a mismatch in the
+# manifest schema.
+module ViteRuby::CompatibilityCheck
+  class << self
+    # Public: Attempt to verify that the vite-plugin-ruby version is compatible.
+    def verify_plugin_version(root)
+      package = JSON.parse(root.join('package.json').read) rescue {}
+      requirement = package.dig('devDependencies', 'vite-plugin-ruby') ||
+                    package.dig('dependencies', 'vite-plugin-ruby')
+
+      raise_unless_satisfied(requirement, ViteRuby::DEFAULT_PLUGIN_VERSION)
+    end
+
+    # Internal: Notifies the user of a possible incompatible plugin.
+    def raise_unless_satisfied(npm_req, ruby_req)
+      unless compatible_plugin?(npm_req, ruby_req)
+        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 upgrade both by running:
+
+              bundle exec vite upgrade
+        ERROR
+      end
+    end
+
+    # Internal: Returns true unless the check is performed and does not meet the
+    # requirement.
+    def compatible_plugin?(npm_req, ruby_req)
+      npm_req, ruby_req = [npm_req, ruby_req]
+        .map { |req| Gem::Requirement.new(req.sub('^', '~>')) }
+
+      current_version = npm_req.requirements.first.second
+
+      ruby_req.satisfied_by?(current_version)
+    rescue StandardError
+      true
+    end
+  end
+end

data/lib/vite_ruby/config.rb

@@ -52,6 +52,18 @@ class ViteRuby::Config
     end.merge(ViteRuby.env)
   end
 
+  # Internal: Files and directories that should be watched for changes.
+  def watched_paths
+    [
+      *(watch_additional_paths + additional_entrypoints).reject { |dir|
+        dir.start_with?('~/') || dir.start_with?(source_code_dir)
+      },
+      "#{ source_code_dir }/**/*",
+      config_path,
+      *DEFAULT_WATCHED_PATHS,
+    ].freeze
+  end
+
 private
 
   # Internal: Coerces all the configuration values, in case they were passed
@@ -61,7 +73,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'])
-    coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https')
+    coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https', 'skip_compatibility_check')
   end
 
   # Internal: Coerces configuration options to boolean.
@@ -71,6 +83,7 @@ private
 
   def initialize(attrs)
     @config = attrs.tap { |config| coerce_values(config) }.freeze
+    ViteRuby::CompatibilityCheck.verify_plugin_version(root) unless skip_compatibility_check
   end
 
   class << self
@@ -134,7 +147,7 @@ private
       multi_env_config.fetch('all', {})
         .merge(multi_env_config.fetch(mode, {}))
     rescue Errno::ENOENT => error
-      warn "Check that your vite.json configuration file is available in the load path:\n\n\t#{ error.message }\n\n"
+      $stderr << "Check that your vite.json configuration file is available in the load path:\n\n\t#{ error.message }\n\n"
       {}
     end
   end
@@ -143,11 +156,24 @@ private
   DEFAULT_CONFIG = load_json("#{ __dir__ }/../../default.vite.json").freeze
 
   # Internal: Configuration options that can not be provided as env vars.
-  NOT_CONFIGURABLE_WITH_ENV = %w[additional_input_globs watch_additional_paths].freeze
+  NOT_CONFIGURABLE_WITH_ENV = %w[additional_entrypoints watch_additional_paths].freeze
 
   # Internal: Configuration options that can be provided as env vars.
   CONFIGURABLE_WITH_ENV = (DEFAULT_CONFIG.keys + %w[mode root] - NOT_CONFIGURABLE_WITH_ENV).freeze
 
+  # Internal: If any of these files is modified the build won't be skipped.
+  DEFAULT_WATCHED_PATHS = %w[
+    package-lock.json
+    package.json
+    pnpm-lock.yaml
+    postcss.config.js
+    tailwind.config.js
+    vite.config.js
+    vite.config.ts
+    windi.config.ts
+    yarn.lock
+  ].freeze
+
 public
 
   # Define getters for the configuration options.

data/lib/vite_ruby/manifest.rb

@@ -85,6 +85,9 @@ protected
 
 private
 
+  # Internal: The prefix used by Vite.js to request files with an absolute path.
+  FS_PREFIX = '/@fs/'
+
   extend Forwardable
 
   def_delegators :@vite_ruby, :config, :builder, :dev_server_running?
@@ -135,7 +138,9 @@ private
   def resolve_references(manifest)
     manifest.each_value do |entry|
       entry['file'] = prefix_vite_asset(entry['file'])
-      entry['css'] = entry['css'].map { |path| prefix_vite_asset(path) } if entry['css']
+      %w[css assets].each do |key|
+        entry[key] = entry[key].map { |path| prefix_vite_asset(path) } if entry[key]
+      end
       entry['imports']&.map! { |name| manifest.fetch(name) }
     end
   end
@@ -143,13 +148,26 @@ private
   # Internal: Resolves the manifest entry name for the specified resource.
   def resolve_entry_name(name, type: nil)
     name = with_file_extension(name.to_s, type)
-    name = name[1..-1] if name.start_with?('/')
 
-    # Prefix scripts and stylesheets with the entrypoints dir.
-    if (type || File.dirname(name) == '.') && !name.start_with?(config.entrypoints_dir)
-      File.join(config.entrypoints_dir, name)
+    raise ArgumentError, "Asset names can not be relative. Found: #{ name }" if name.start_with?('.') && !name.include?('legacy-polyfills')
+
+    # Explicit path, relative to the source_code_dir.
+    name.sub(%r{^~/(.+)$}) { return Regexp.last_match(1) }
+
+    # Explicit path, relative to the project root.
+    name.sub(%r{^/(.+)$}) { return resolve_absolute_entry(Regexp.last_match(1)) }
+
+    # Sugar: Prefix with the entrypoints dir if the path is not nested.
+    name.include?('/') ? name : File.join(config.entrypoints_dir, name)
+  end
+
+  # Internal: Entry names in the manifest are relative to the Vite.js.
+  # During develoment, files outside the root must be requested explicitly.
+  def resolve_absolute_entry(name)
+    if dev_server_running?
+      File.join(FS_PREFIX, config.root, name)
     else
-      name
+      config.root.join(name).relative_path_from(config.vite_root_dir).to_s
     end
   end
 

data/lib/vite_ruby/version.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class ViteRuby
-  VERSION = '3.0.0.beta.1'
+  VERSION = '3.0.1'
 
   # Internal: Versions used by default when running `vite install`.
-  DEFAULT_VITE_VERSION = '^2.5.0-beta.2'
-  DEFAULT_PLUGIN_VERSION = '^3.0.0-beta.2'
+  DEFAULT_VITE_VERSION = '^2.6.13'
+  DEFAULT_PLUGIN_VERSION = '^3.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.1
+  version: 3.0.1
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -184,6 +184,7 @@ files:
 - lib/vite_ruby/cli/version.rb
 - lib/vite_ruby/cli/vite.rb
 - lib/vite_ruby/commands.rb
+- lib/vite_ruby/compatibility_check.rb
 - lib/vite_ruby/config.rb
 - lib/vite_ruby/dev_server_proxy.rb
 - lib/vite_ruby/error.rb
@@ -200,8 +201,8 @@ homepage: https://github.com/ElMassimo/vite_ruby
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.0.0.beta.1/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.0.0.beta.1/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.0.1/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.0.1/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: []
@@ -214,9 +215,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: