webpacker 4.0.7 → 5.0.0

data/lib/install/loaders/svelte.js

@@ -0,0 +1,9 @@
+module.exports = {
+  test: /\.svelte(\.erb)?$/,
+  use: [{
+    loader: 'svelte-loader',
+    options: {
+      hotReload: false
+    }
+  }],
+}

data/lib/install/loaders/typescript.js

@@ -1,7 +1,7 @@
 const PnpWebpackPlugin = require('pnp-webpack-plugin')
 
 module.exports = {
-  test: /\.(ts|tsx)?(\.erb)?$/,
+  test: /\.tsx?(\.erb)?$/,
   use: [
     {
       loader: 'ts-loader',

data/lib/install/svelte.rb

@@ -0,0 +1,29 @@
+require "webpacker/configuration"
+
+say "Copying svelte loader to config/webpack/loaders"
+copy_file "#{__dir__}/loaders/svelte.js", Rails.root.join("config/webpack/loaders/svelte.js").to_s
+
+say "Adding svelte loader to config/webpack/environment.js"
+insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
+  "const svelte = require('./loaders/svelte')\n",
+  after: /require\(('|")@rails\/webpacker\1\);?\n/
+
+insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.prepend('svelte', svelte)\n",
+  before: "module.exports"
+
+say "Copying Svelte example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/svelte/hello_svelte.js",
+  "#{Webpacker.config.source_entry_path}/hello_svelte.js"
+
+say "Copying Svelte app file to #{Webpacker.config.source_path}"
+copy_file "#{__dir__}/examples/svelte/app.svelte",
+  "#{Webpacker.config.source_path}/app.svelte"
+
+say "Installing all Svelte dependencies"
+run "yarn add svelte svelte-loader"
+
+say "Updating webpack paths to include .svelte file extension"
+insert_into_file Webpacker.config.config_path, "- .svelte\n".indent(4), after: /\s+extensions:\n/
+
+say "Webpacker now supports Svelte 🎉", :green

data/lib/install/template.rb

@@ -1,7 +1,7 @@
 # Install Webpacker
 copy_file "#{__dir__}/config/webpacker.yml", "config/webpacker.yml"
 
-puts "Copying webpack core config"
+say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack"
 
 say "Copying postcss.config.js to app root directory"
@@ -36,7 +36,7 @@ end
 
 if Webpacker::VERSION =~ /^[0-9]+\.[0-9]+\.[0-9]+$/
   say "Installing all JavaScript dependencies [#{Webpacker::VERSION}]"
-  run "yarn add @rails/webpacker"
+  run "yarn add @rails/webpacker@#{Webpacker::VERSION}"
 else
   say "Installing all JavaScript dependencies [from prerelease rails/webpacker]"
   run "yarn add @rails/webpacker@next"

data/lib/install/typescript.rb

@@ -21,7 +21,7 @@ copy_file "#{__dir__}/loaders/typescript.js", Rails.root.join("config/webpack/lo
 say "Adding typescript loader to config/webpack/environment.js"
 insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
   "const typescript =  require('./loaders/typescript')\n",
-  after: "require('@rails/webpacker')\n"
+  after: /require\(('|")@rails\/webpacker\1\);?\n/
 
 insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
   "environment.loaders.prepend('typescript', typescript)\n",

data/lib/install/vue.rb

@@ -6,7 +6,7 @@ copy_file "#{__dir__}/loaders/vue.js", Rails.root.join("config/webpack/loaders/v
 say "Adding vue loader plugin to config/webpack/environment.js"
 insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
   "const { VueLoaderPlugin } = require('vue-loader')\n",
-  after: "require('@rails/webpacker')\n"
+  after: /require\(('|")@rails\/webpacker\1\);?\n/
 
 insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
   "environment.plugins.prepend('VueLoaderPlugin', new VueLoaderPlugin())\n",

data/lib/tasks/installers.rake

@@ -6,6 +6,7 @@ installers = {
   "Erb": :erb,
   "Coffee": :coffee,
   "Typescript": :typescript,
+  "Svelte": :svelte,
   "Stimulus": :stimulus
 }.freeze
 

data/lib/tasks/webpacker.rake

@@ -2,6 +2,7 @@ tasks = {
   "webpacker:info"                    => "Provides information on Webpacker's environment",
   "webpacker:install"                 => "Installs and setup webpack with Yarn",
   "webpacker:compile"                 => "Compiles webpack bundles based on environment",
+  "webpacker:clean"                   => "Remove old compiled webpacks",
   "webpacker:clobber"                 => "Removes the webpack compiled output directory",
   "webpacker:check_node"              => "Verifies if Node.js is installed",
   "webpacker:check_yarn"              => "Verifies if Yarn is installed",
@@ -13,6 +14,7 @@ tasks = {
   "webpacker:install:vue"             => "Installs and setup example Vue component",
   "webpacker:install:angular"         => "Installs and setup example Angular component",
   "webpacker:install:elm"             => "Installs and setup example Elm component",
+  "webpacker:install:svelte"          => "Installs and setup example Svelte component",
   "webpacker:install:stimulus"        => "Installs and setup example Stimulus component",
   "webpacker:install:erb"             => "Installs Erb loader with an example",
   "webpacker:install:coffee"          => "Installs CoffeeScript loader with an example",

data/lib/tasks/webpacker/check_node.rake

@@ -1,3 +1,4 @@
+require "semantic_range"
 namespace :webpacker do
   desc "Verifies if Node.js is installed"
   task :check_node do
@@ -6,19 +7,25 @@ namespace :webpacker do
       raise Errno::ENOENT if node_version.blank?
 
       pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
-      node_requirement = JSON.parse(pkg_path.read)["engines"]["node"]
+      node_range = JSON.parse(pkg_path.read)["engines"]["node"]
+      is_valid = SemanticRange.satisfies?(node_version, node_range) rescue false
+      semver_major = node_version[/\d+/] rescue nil
+      is_unstable = semver_major.to_i.odd? rescue false
 
-      requirement = Gem::Requirement.new(node_requirement)
-      version = Gem::Version.new(node_version.strip.tr("v", ""))
+      if is_unstable
+        $stderr.puts "Warning: you are using an unstable release of Node.js (#{node_version}). If you encounter issues with Node.js, consider switching to an Active LTS release. More info: https://docs.npmjs.com/try-the-latest-stable-version-of-node"
+      end
 
-      unless requirement.satisfied_by?(version)
-        $stderr.puts "Webpacker requires Node.js #{requirement} and you are using #{version}"
+      unless is_valid
+        $stderr.puts "Webpacker requires Node.js \"#{node_range}\" and you are using #{node_version}"
         $stderr.puts "Please upgrade Node.js https://nodejs.org/en/download/"
-        $stderr.puts "Exiting!" && exit!
+        $stderr.puts "Exiting!"
+        exit!
       end
     rescue Errno::ENOENT
       $stderr.puts "Node.js not installed. Please download and install Node.js https://nodejs.org/en/download/"
-      $stderr.puts "Exiting!" && exit!
+      $stderr.puts "Exiting!"
+      exit!
     end
   end
 end

data/lib/tasks/webpacker/check_yarn.rake

@@ -1,3 +1,4 @@
+require "semantic_range"
 namespace :webpacker do
   desc "Verifies if Yarn is installed"
   task :check_yarn do
@@ -6,19 +7,25 @@ namespace :webpacker do
       raise Errno::ENOENT if yarn_version.blank?
 
       pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
-      yarn_requirement = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      yarn_range = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      is_valid = SemanticRange.satisfies?(yarn_version, yarn_range) rescue false
+      is_unsupported = SemanticRange.satisfies?(yarn_version, ">=2.0.0") rescue false
 
-      requirement = Gem::Requirement.new(yarn_requirement)
-      version = Gem::Version.new(yarn_version)
-
-      unless requirement.satisfied_by?(version)
-        $stderr.puts "Webpacker requires Yarn #{requirement} and you are using #{version}"
-        $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
-        $stderr.puts "Exiting!" && exit!
+      unless is_valid
+        $stderr.puts "Webpacker requires Yarn \"#{yarn_range}\" and you are using #{yarn_version}"
+        if is_unsupported
+          $stderr.puts "This version of Webpacker does not support Yarn #{yarn_version}. Please downgrade to a supported version of Yarn https://yarnpkg.com/lang/en/docs/install/"
+          $stderr.puts "For information on using Webpacker with Yarn 2.0, see https://github.com/rails/webpacker/issues/2112"
+        else
+          $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
+        end
+        $stderr.puts "Exiting!"
+        exit!
       end
     rescue Errno::ENOENT
       $stderr.puts "Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/"
-      $stderr.puts "Exiting!" && exit!
+      $stderr.puts "Exiting!"
+      exit!
     end
   end
 end

data/lib/tasks/webpacker/clean.rake

@@ -0,0 +1,25 @@
+$stdout.sync = true
+
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Remove old compiled webpacks"
+  task :clean, [:keep, :age] => ["webpacker:verify_install", :environment] do |_, args|
+    Webpacker.ensure_log_goes_to_stdout do
+      Webpacker.clean(Integer(args.keep || 2), Integer(args.age || 3600))
+    end
+  end
+end
+
+skip_webpacker_clean = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clean
+  # Run clean if the assets:clean is run
+  if Rake::Task.task_defined?("assets:clean")
+    Rake::Task["assets:clean"].enhance do
+      Rake::Task["webpacker:clean"].invoke
+    end
+  else
+    Rake::Task.define_task("assets:clean" => "webpacker:clean")
+  end
+end

data/lib/tasks/webpacker/clobber.rake

@@ -8,9 +8,13 @@ namespace :webpacker do
   end
 end
 
-# Run clobber if the assets:clobber is run
-if Rake::Task.task_defined?("assets:clobber")
-  Rake::Task["assets:clobber"].enhance do
-    Rake::Task["webpacker:clobber"].invoke
+skip_webpacker_clobber = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clobber
+  # Run clobber if the assets:clobber is run
+  if Rake::Task.task_defined?("assets:clobber")
+    Rake::Task["assets:clobber"].enhance do
+      Rake::Task["webpacker:clobber"].invoke
+    end
   end
 end

data/lib/tasks/webpacker/compile.rake

@@ -1,13 +1,5 @@
 $stdout.sync = true
 
-def ensure_log_goes_to_stdout
-  old_logger = Webpacker.logger
-  Webpacker.logger = ActiveSupport::Logger.new(STDOUT)
-  yield
-ensure
-  Webpacker.logger = old_logger
-end
-
 def yarn_install_available?
   rails_major = Rails::VERSION::MAJOR
   rails_minor = Rails::VERSION::MINOR
@@ -26,8 +18,8 @@ end
 namespace :webpacker do
   desc "Compile JavaScript packs using webpack for production with digests"
   task compile: ["webpacker:verify_install", :environment] do
-    Webpacker.with_node_env("production") do
-      ensure_log_goes_to_stdout do
+    Webpacker.with_node_env(ENV.fetch("NODE_ENV", "production")) do
+      Webpacker.ensure_log_goes_to_stdout do
         if Webpacker.compile
           # Successful compilation!
         else

data/lib/tasks/webpacker/yarn_install.rake

@@ -1,6 +1,10 @@
 namespace :webpacker do
   desc "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn"
   task :yarn_install do
-    system "yarn install --no-progress"
+    valid_node_envs = %w[test development production]
+    node_env = ENV.fetch("NODE_ENV") do
+      valid_node_envs.include?(Rails.env) ? Rails.env : "production"
+    end
+    system({ "NODE_ENV" => node_env }, "yarn install --no-progress --frozen-lockfile")
   end
 end

data/lib/webpacker.rb

@@ -22,9 +22,17 @@ module Webpacker
     ENV["NODE_ENV"] = original
   end
 
+  def ensure_log_goes_to_stdout
+    old_logger = Webpacker.logger
+    Webpacker.logger = ActiveSupport::Logger.new(STDOUT)
+    yield
+  ensure
+    Webpacker.logger = old_logger
+  end
+
   delegate :logger, :logger=, :env, to: :instance
   delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance
-  delegate :bootstrap, :clobber, :compile, to: :commands
+  delegate :bootstrap, :clean, :clobber, :compile, to: :commands
 end
 
 require "webpacker/instance"

data/lib/webpacker/commands.rb

@@ -1,10 +1,43 @@
 class Webpacker::Commands
-  delegate :config, :compiler, :manifest, to: :@webpacker
+  delegate :config, :compiler, :manifest, :logger, to: :@webpacker
 
   def initialize(webpacker)
     @webpacker = webpacker
   end
 
+  # Cleanup old assets in the compile directory. By default it will
+  # keep the latest version, 2 backups created within the past hour.
+  #
+  # Examples
+  #
+  #   To force only 1 backup to be kept, set count=1 and age=0.
+  #
+  #   To only keep files created within the last 10 minutes, set count=0 and
+  #   age=600.
+  #
+  def clean(count = 2, age = 3600)
+    if config.public_output_path.exist? && config.public_manifest_path.exist?
+      versions
+        .sort
+        .reverse
+        .each_with_index
+        .drop_while do |(mtime, _), index|
+          max_age = [0, Time.now - Time.at(mtime)].max
+          max_age < age && index < count
+        end
+        .each do |(_, files), index|
+          files.each do |file|
+            if File.file?(file)
+              File.delete(file)
+              logger.info "Removed #{file}"
+            end
+          end
+        end
+    end
+
+    true
+  end
+
   def clobber
     config.public_output_path.rmtree if config.public_output_path.exist?
     config.cache_path.rmtree if config.cache_path.exist?
@@ -19,4 +52,23 @@ class Webpacker::Commands
       manifest.refresh if success
     end
   end
+
+  private
+    def versions
+      all_files       = Dir.glob("#{config.public_output_path}/**/*")
+      manifest_config = Dir.glob("#{config.public_manifest_path}*")
+
+      packs = all_files - manifest_config - current_version
+      packs.reject { |file| File.directory?(file) }.group_by { |file| File.mtime(file).utc.to_i }
+    end
+
+    def current_version
+      packs = manifest.refresh.values.map do |value|
+        next if value.is_a?(Hash)
+
+        File.join(config.root_path, "public", "#{value}*")
+      end.compact
+
+      Dir.glob(packs).uniq
+    end
 end

data/lib/webpacker/compiler.rb

@@ -19,9 +19,15 @@ class Webpacker::Compiler
   def compile
     if stale?
       run_webpack.tap do |success|
-        record_compilation_digest if success
+        # We used to only record the digest on success
+        # However, the output file is still written on error, (at least with ts-loader), meaning that the
+        # digest should still be updated. If it's not, you can end up in a situation where a recompile doesn't
+        # take place when it should.
+        # See https://github.com/rails/webpacker/issues/2113
+        record_compilation_digest
       end
     else
+      logger.info "Everything's up-to-date. Nothing to do"
       true
     end
   end
@@ -56,7 +62,7 @@ class Webpacker::Compiler
     end
 
     def run_webpack
-      logger.info "Compiling…"
+      logger.info "Compiling..."
 
       stdout, stderr, status = Open3.capture3(
         webpack_env,
@@ -67,12 +73,13 @@ class Webpacker::Compiler
       if status.success?
         logger.info "Compiled all packs in #{config.public_output_path}"
         logger.error "#{stderr}" unless stderr.empty?
-      else
-        logger.error "Compilation failed:\n#{stderr}"
-      end
 
-      if config.webpack_compile_output?
-        logger.info stdout
+        if config.webpack_compile_output?
+          logger.info stdout
+        end
+      else
+        non_empty_streams = [stdout, stderr].delete_if(&:empty?)
+        logger.error "Compilation failed:\n#{non_empty_streams.join("\n\n")}"
       end
 
       status.success?
@@ -81,7 +88,7 @@ class Webpacker::Compiler
     def default_watched_paths
       [
         *config.resolved_paths_globbed,
-        "#{config.source_path.relative_path_from(config.root_path)}/**/*",
+        config.source_path_globbed,
         "yarn.lock", "package.json",
         "config/webpack/**/*"
       ].freeze

data/lib/webpacker/configuration.rb

@@ -23,12 +23,16 @@ class Webpacker::Configuration
     root_path.join(fetch(:source_path))
   end
 
+  def source_path_globbed
+    globbed_path_with_extensions(source_path.relative_path_from(root_path))
+  end
+
   def resolved_paths
     fetch(:resolved_paths)
   end
 
   def resolved_paths_globbed
-    resolved_paths.map { |p| "#{p}/**/*" }
+    resolved_paths.map { |p| globbed_path_with_extensions(p) }
   end
 
   def source_entry_path
@@ -102,4 +106,8 @@ class Webpacker::Configuration
       @defaults ||= \
         HashWithIndifferentAccess.new(YAML.load_file(File.expand_path("../../install/config/webpacker.yml", __FILE__))[env])
     end
+
+    def globbed_path_with_extensions(path)
+      "#{path}/**/*{#{extensions.join(',')}}"
+    end
 end

data/lib/webpacker/dev_server.rb

@@ -32,7 +32,7 @@ class Webpacker::DevServer
 
   def https?
     case fetch(:https)
-    when true, "true"
+    when true, "true", Hash
       true
     else
       false