vite_ruby 2.0.0.beta.6 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0058a6fc7f925f10e97f390c028abbbecc2c4c9cc5e27f214cbcba826c42fe69'
-  data.tar.gz: ebc2076502683d817f99c284fc2f6ec7adfa75dfd41f8f623a72e221cd56da5a
+  metadata.gz: '059c10492c1cc0b47f4347ef78f0de17c9220392611945ba189b5169c02729ba'
+  data.tar.gz: 534b84c6bd67bf9e7e0a74bec9ad8d277ebe37693829d3d995a26eba5b8ac2b2
 SHA512:
-  metadata.gz: 728652c1e4f0884bde8a1823f9a70ffdf12ce509fdb8f7ae898133d8f9084cbcc1a0204da38212c8281f02e4e77f0ec8a481c85ce7e3f74be189965d34fbe791
-  data.tar.gz: 6ed6080dcb36974a061d974188ede76c700b27e97a63ec5b357225acbd04dc5f555a13bc45f4790c73d9daba20c104181583f3a650a0fd7da6dc544c4b680b10
+  metadata.gz: e23a593394165dfea0f743fab1699535e9c1a531cde25cd53a85d19fb454795851fe85d83907d802d7dae6adbca25b449b0c7b6ab33b6530102fb49a5526aeb4
+  data.tar.gz: dcf237f94f9009a4427a27e807a66c3aae8a77b6ca39370a03c0f860d2d4b2d2bb4ecb93bc0f78f7a979c2105fe126c79c0297bdc32e24d7d88f860af2baf184

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# [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.rb

@@ -23,9 +23,7 @@ class ViteRuby
   COMPANION_LIBRARIES = {
     'vite_rails' => 'rails',
     'vite_hanami' => 'hanami',
-    'vite_roda' => 'roda',
     'vite_padrino' => 'padrino',
-    'vite_sinatra' => 'sinatra',
     'jekyll-vite' => 'jekyll',
     'vite_rails_legacy' => 'rails',
   }

data/lib/vite_ruby/build.rb

@@ -3,16 +3,22 @@
 require 'time'
 
 # Internal: Value object with information about the last build.
-ViteRuby::Build = Struct.new(:success, :timestamp, :digest, :current_digest) do
+ViteRuby::Build = Struct.new(:success, :timestamp, :vite_ruby, :digest, :current_digest) do
   # Internal: Combines information from a previous build with the current digest.
   def self.from_previous(attrs, current_digest)
-    new(attrs['success'], attrs['timestamp'] || 'never', attrs['digest'] || 'none', current_digest)
+    new(
+      attrs['success'],
+      attrs['timestamp'] || 'never',
+      attrs['vite_ruby'] || 'unknown',
+      attrs['digest'] || 'none',
+      current_digest,
+    )
   end
 
   # Internal: A build is considered stale when watched files have changed since
   # the last build, or when a certain time has ellapsed in case of failure.
   def stale?
-    digest != current_digest || retry_failed?
+    digest != current_digest || retry_failed? || vite_ruby != ViteRuby::VERSION
   end
 
   # Internal: A build is considered fresh if watched files have not changed, or
@@ -31,7 +37,12 @@ ViteRuby::Build = Struct.new(:success, :timestamp, :digest, :current_digest) do
 
   # Internal: Returns a new build with the specified result.
   def with_result(success)
-    self.class.new(success, Time.now.strftime('%F %T'), current_digest)
+    self.class.new(
+      success,
+      Time.now.strftime('%F %T'),
+      ViteRuby::VERSION,
+      current_digest,
+    )
   end
 
   # Internal: Returns a JSON string with the metadata of the build.

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,22 +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 }/**/*",
-      'yarn.lock',
-      'package-lock.json',
-      'pnpm-lock.yaml',
-      'package.json',
-      'vite.config.ts',
-      'vite.config.js',
-      'windi.config.ts',
-      config.config_path,
-    ].freeze
-  end
 end

data/lib/vite_ruby/cli/file_utils.rb

@@ -24,7 +24,7 @@ module ViteRuby::CLI::FileUtils
     # @api private
     def cp(source, destination)
       mkdir_p(destination)
-      FileUtils.cp(source, destination)
+      FileUtils.cp(source, destination) unless File.exist?(destination)
     end
 
     # Adds a new line at the bottom of the file.
@@ -32,10 +32,10 @@ module ViteRuby::CLI::FileUtils
     # @since 1.2.11
     # @api private
     def append(path, contents)
-      mkdir_p(path)
+      content = read_lines(path)
+      return if content.join.include?(contents)
 
-      content = File.readlines(path)
-      content << "\n" unless content.last.end_with?("\n")
+      content << "\n" unless content.last&.end_with?("\n")
       content << "#{ contents }\n"
 
       write(path, content)
@@ -46,7 +46,7 @@ module ViteRuby::CLI::FileUtils
     # @since 1.2.11
     # @api private
     def replace_first_line(path, target, replacement)
-      content = File.readlines(path)
+      content = read_lines(path)
       content[index(content, path, target)] = "#{ replacement }\n"
 
       write(path, content)
@@ -86,6 +86,11 @@ module ViteRuby::CLI::FileUtils
       Pathname.new(path).dirname.mkpath
     end
 
+    # Returns an array with lines in the specified file, empty if it doesn't exist.
+    def read_lines(path)
+      File.exist?(path) ? File.readlines(path) : []
+    end
+
     # @since 1.2.11
     # @api private
     def index(content, path, target)
@@ -103,7 +108,9 @@ module ViteRuby::CLI::FileUtils
     # @since 1.2.11
     # @api private
     def _inject_line_before(path, target, contents, finder)
-      content = File.readlines(path)
+      content = read_lines(path)
+      return if content.join.include?(contents)
+
       i = finder.call(content, path, target)
 
       content.insert(i, "#{ contents }\n")
@@ -113,7 +120,9 @@ module ViteRuby::CLI::FileUtils
     # @since 1.2.11
     # @api private
     def _inject_line_after(path, target, contents, finder)
-      content = File.readlines(path)
+      content = read_lines(path)
+      return if content.join.include?(contents)
+
       i = finder.call(content, path, target)
 
       content.insert(i + 1, "#{ contents }\n")

data/lib/vite_ruby/cli/install.rb

@@ -71,6 +71,7 @@ private
   # Internal: Creates the Vite and vite-plugin-ruby configuration files.
   def create_configuration_files
     copy_template 'config/vite.config.ts', to: root.join('vite.config.ts')
+    append root.join('Procfile.dev'), 'vite: bin/vite dev'
     setup_app_files
     ViteRuby.reload_with(config_path: config.config_path)
   end
@@ -79,13 +80,8 @@ private
   def install_js_dependencies
     package_json = root.join('package.json')
     write(package_json, '{}') unless package_json.exist?
-
-    Dir.chdir(root) do
-      deps = js_dependencies.join(' ')
-      _, stderr, status = ViteRuby::IO.capture("npx --package @antfu/ni -- ni -D #{ deps }", stdin_data: "\n")
-      _, stderr, = ViteRuby::IO.capture("yarn add -D #{ deps }") unless status.success?
-      say("Could not install JS dependencies.\n", stderr) unless stderr.to_s.empty?
-    end
+    deps = js_dependencies.join(' ')
+    run_with_capture("#{ npm_install } -D #{ deps }", stdin_data: "\n")
   end
 
   # Internal: Adds compilation output dirs to git ignore.
@@ -114,8 +110,18 @@ private
   end
 
   def run_with_capture(*args, **options)
-    _, stderr, status = ViteRuby::IO.capture(*args, **options)
-    say(err) unless status.success? || stderr.to_s.empty?
+    Dir.chdir(root) do
+      _, stderr, status = ViteRuby::IO.capture(*args, **options)
+      say(stderr) unless status.success? || stderr.to_s.empty?
+    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'
   end
 
   # Internal: Avoid printing warning about missing vite.json, we will create one.

data/lib/vite_ruby/cli/upgrade_packages.rb

@@ -5,10 +5,7 @@ class ViteRuby::CLI::UpgradePackages < ViteRuby::CLI::Install
 
   def call(**)
     say 'Upgrading npm packages'
-
-    Dir.chdir(root) do
-      deps = js_dependencies.join(' ')
-      run_with_capture("npx --package @antfu/ni -- ni -D #{ deps }")
-    end
+    deps = js_dependencies.join(' ')
+    run_with_capture("#{ npm_install } -D #{ deps }")
   end
 end

data/lib/vite_ruby/commands.rb

@@ -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 = '2.0.0.beta.6'
+  VERSION = '3.0.0'
 
   # 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.5.0'
+  DEFAULT_PLUGIN_VERSION = '^3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.6
+  version: 3.0.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2021-08-16 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@2.0.0.beta.6/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@2.0.0.beta.6/vite_ruby/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.0.0/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.0.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: []
@@ -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: