{{ message }}
def image_pack_tag(name, **options)
image_tag(resolve_path_to_image(name), options)
end
# Creates a link tag for a favicon that references the named pack file.
#
# Example:
#
# <%= favicon_pack_tag 'mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' %>
#
def favicon_pack_tag(name, **options)
favicon_link_tag(resolve_path_to_image(name), options)
end
# Creates a script tag that references the named pack file, as compiled by webpack per the entries list
# in config/webpack/shared.js. By default, this list is auto-generated to match everything in
# app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.
#
# Example:
#
# <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
#
def javascript_pack_tag(*names, **options)
javascript_include_tag(*sources_from_manifest_entries(names, type: :javascript), **options)
end
# Creates script tags that reference the js chunks from entrypoints when using split chunks API,
# as compiled by webpack per the entries list in config/webpack/shared.js.
# By default, this list is auto-generated to match everything in
# app/javascript/packs/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
# See: https://webpack.js.org/plugins/split-chunks-plugin/
# Example:
#
# <%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %> # =>
#
#
#
#
#
# DO:
# <%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
# DON'T:
# <%= javascript_packs_with_chunks_tag 'calendar' %>
# <%= javascript_packs_with_chunks_tag 'map' %>
def javascript_packs_with_chunks_tag(*names, **options)
javascript_include_tag(*sources_from_manifest_entrypoints(names, type: :javascript), **options)
end
# Creates a link tag, for preloading, that references a given Webpacker asset.
# In production mode, the digested reference is automatically looked up.
# See: https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content
# Example:
#
# <%= preload_pack_asset 'fonts/fa-regular-400.woff2' %> # =>
#
def preload_pack_asset(name, **options)
if self.class.method_defined?(:preload_link_tag)
preload_link_tag(current_webpacker_instance.manifest.lookup!(name), options)
else
raise "You need Rails >= 5.2 to use this tag."
end
end
# Creates a link tag that references the named pack file, as compiled by webpack per the entries list
# in config/webpack/shared.js. By default, this list is auto-generated to match everything in
# app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.
#
# Note: If the development server is running and hot module replacement is active, this will return nothing.
# In that setup you need to configure your styles to be inlined in your JavaScript for hot reloading.
#
# Examples:
#
# # When extract_css is false in webpacker.yml:
# <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
# nil
#
# # When extract_css is true in webpacker.yml:
# <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
#
def stylesheet_pack_tag(*names, **options)
if current_webpacker_instance.config.extract_css?
stylesheet_link_tag(*sources_from_manifest_entries(names, type: :stylesheet), **options)
end
end
# Creates link tags that reference the css chunks from entrypoints when using split chunks API,
# as compiled by webpack per the entries list in config/webpack/shared.js.
# By default, this list is auto-generated to match everything in
# app/javascript/packs/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
# See: https://webpack.js.org/plugins/split-chunks-plugin/
#
# Examples:
#
# <%= stylesheet_packs_with_chunks_tag 'calendar', 'map' %> # =>
#
#
#
# DO:
# <%= stylesheet_packs_with_chunks_tag 'calendar', 'map' %>
# DON'T:
# <%= stylesheet_packs_with_chunks_tag 'calendar' %>
# <%= stylesheet_packs_with_chunks_tag 'map' %>
def stylesheet_packs_with_chunks_tag(*names, **options)
if current_webpacker_instance.config.extract_css?
stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
end
end
private
def stylesheet?(name)
File.extname(name) == ".css"
end
def sources_from_manifest_entries(names, type:)
names.map { |name| current_webpacker_instance.manifest.lookup!(name, type: type) }.flatten
end
def sources_from_manifest_entrypoints(names, type:)
names.map { |name| current_webpacker_instance.manifest.lookup_pack_with_chunks!(name, type: type) }.flatten.uniq
end
def resolve_path_to_image(name)
path = name.starts_with?("media/images/") ? name : "media/images/#{name}"
asset_path(current_webpacker_instance.manifest.lookup!(path))
rescue
asset_path(current_webpacker_instance.manifest.lookup!(name))
end
end
webpacker-4.2.2/lib/webpacker/compiler.rb 0000644 0001750 0001750 00000006370 13712041056 017363 0 ustar pravi pravi require "open3"
require "digest/sha1"
class Webpacker::Compiler
# Additional paths that test compiler needs to watch
# Webpacker::Compiler.watched_paths << 'bower_components'
cattr_accessor(:watched_paths) { [] }
# Additional environment variables that the compiler is being run with
# Webpacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'
cattr_accessor(:env) { {} }
delegate :config, :logger, to: :webpacker
def initialize(webpacker)
@webpacker = webpacker
end
def compile
if stale?
run_webpack.tap do |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
# Returns true if all the compiled packs are up to date with the underlying asset files.
def fresh?
watched_files_digest == last_compilation_digest
end
# Returns true if the compiled packs are out of date with the underlying asset files.
def stale?
!fresh?
end
private
attr_reader :webpacker
def last_compilation_digest
compilation_digest_path.read if compilation_digest_path.exist? && config.public_manifest_path.exist?
rescue Errno::ENOENT, Errno::ENOTDIR
end
def watched_files_digest
files = Dir[*default_watched_paths, *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
def record_compilation_digest
config.cache_path.mkpath
compilation_digest_path.write(watched_files_digest)
end
def run_webpack
logger.info "Compiling..."
stdout, stderr, status = Open3.capture3(
webpack_env,
"#{RbConfig.ruby} ./bin/webpack",
chdir: File.expand_path(config.root_path)
)
if status.success?
logger.info "Compiled all packs in #{config.public_output_path}"
logger.error "#{stderr}" unless stderr.empty?
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?
end
def default_watched_paths
[
*config.resolved_paths_globbed,
config.source_path_globbed,
"yarn.lock", "package.json",
"config/webpack/**/*"
].freeze
end
def compilation_digest_path
config.cache_path.join("last-compilation-digest-#{webpacker.env}")
end
def webpack_env
return env unless defined?(ActionController::Base)
env.merge("WEBPACKER_ASSET_HOST" => ENV.fetch("WEBPACKER_ASSET_HOST", ActionController::Base.helpers.compute_asset_host),
"WEBPACKER_RELATIVE_URL_ROOT" => ENV.fetch("WEBPACKER_RELATIVE_URL_ROOT", ActionController::Base.relative_url_root))
end
end
webpacker-4.2.2/lib/webpacker/dev_server_proxy.rb 0000644 0001750 0001750 00000001701 13712041056 021147 0 ustar pravi pravi require "rack/proxy"
class Webpacker::DevServerProxy < Rack::Proxy
delegate :config, :dev_server, to: :@webpacker
def initialize(app = nil, opts = {})
@webpacker = opts.delete(:webpacker) || Webpacker.instance
opts[:streaming] = false if Rails.env.test? && !opts.key?(:streaming)
super
end
def perform_request(env)
if env["PATH_INFO"].start_with?("/#{public_output_uri_path}") && dev_server.running?
env["HTTP_HOST"] = env["HTTP_X_FORWARDED_HOST"] = env["HTTP_X_FORWARDED_SERVER"] = dev_server.host_with_port
env["HTTP_X_FORWARDED_PROTO"] = env["HTTP_X_FORWARDED_SCHEME"] = dev_server.protocol
unless dev_server.https?
env["HTTPS"] = env["HTTP_X_FORWARDED_SSL"] = "off"
end
env["SCRIPT_NAME"] = ""
super(env)
else
@app.call(env)
end
end
private
def public_output_uri_path
config.public_output_path.relative_path_from(config.public_path).to_s + "/"
end
end
webpacker-4.2.2/lib/webpacker/version.rb 0000644 0001750 0001750 00000000144 13712041056 017227 0 ustar pravi pravi module Webpacker
# Change the version in package.json too, please!
VERSION = "4.2.2".freeze
end
webpacker-4.2.2/lib/webpacker/commands.rb 0000644 0001750 0001750 00000002342 13712041056 017345 0 ustar pravi pravi class Webpacker::Commands
delegate :config, :compiler, :manifest, :logger, to: :@webpacker
def initialize(webpacker)
@webpacker = webpacker
end
def clean(count = 2)
if config.public_output_path.exist? && config.public_manifest_path.exist? && versions.count > count
versions.drop(count).flat_map(&:last).each do |file|
File.delete(file) if File.file?(file)
logger.info "Removed #{file}"
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?
end
def bootstrap
manifest.refresh
end
def compile
compiler.compile.tap do |success|
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.group_by { |file| File.mtime(file).utc.to_i }.sort.reverse
end
def current_version
manifest.refresh.values.map do |value|
next if value.is_a?(Hash)
File.join(config.root_path, "public", value)
end.compact
end
end
webpacker-4.2.2/lib/tasks/ 0000755 0001750 0001750 00000000000 13712041056 014400 5 ustar pravi pravi webpacker-4.2.2/lib/tasks/webpacker.rake 0000644 0001750 0001750 00000003642 13712041056 017214 0 ustar pravi pravi 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",
"webpacker:check_binstubs" => "Verifies that webpack & webpack-dev-server are present",
"webpacker:binstubs" => "Installs Webpacker binstubs in this application",
"webpacker:verify_install" => "Verifies if Webpacker is installed",
"webpacker:yarn_install" => "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn",
"webpacker:install:react" => "Installs and setup example React component",
"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",
"webpacker:install:typescript" => "Installs Typescript loader with an example"
}.freeze
desc "Lists all available tasks in Webpacker"
task :webpacker do
puts "Available Webpacker tasks are:"
tasks.each { |task, message| puts task.ljust(30) + message }
end
webpacker-4.2.2/lib/tasks/webpacker/ 0000755 0001750 0001750 00000000000 13712041056 016343 5 ustar pravi pravi webpacker-4.2.2/lib/tasks/webpacker/check_binstubs.rake 0000644 0001750 0001750 00000000617 13712041056 022201 0 ustar pravi pravi namespace :webpacker do
desc "Verifies that webpack & webpack-dev-server are present."
task :check_binstubs do
unless File.exist?("bin/webpack")
$stderr.puts "webpack binstubs not found.\n"\
"Have you run rails webpacker:install ?\n"\
"Make sure the bin directory or binstubs are not included in .gitignore\n"\
"Exiting!"
exit!
end
end
end
webpacker-4.2.2/lib/tasks/webpacker/info.rake 0000644 0001750 0001750 00000001276 13712041056 020150 0 ustar pravi pravi require "webpacker/version"
namespace :webpacker do
desc "Provide information on Webpacker's environment"
task :info do
$stdout.puts "Ruby: #{`ruby --version`}"
$stdout.puts "Rails: #{Rails.version}"
$stdout.puts "Webpacker: #{Webpacker::VERSION}"
$stdout.puts "Node: #{`node --version`}"
$stdout.puts "Yarn: #{`yarn --version`}"
$stdout.puts "\n"
$stdout.puts "@rails/webpacker: \n#{`npm list @rails/webpacker version`}"
$stdout.puts "Is bin/webpack present?: #{File.exist? 'bin/webpack'}"
$stdout.puts "Is bin/webpack-dev-server present?: #{File.exist? 'bin/webpack-dev-server'}"
$stdout.puts "Is bin/yarn present?: #{File.exist? 'bin/yarn'}"
end
end
webpacker-4.2.2/lib/tasks/webpacker/check_node.rake 0000644 0001750 0001750 00000001640 13712041056 021272 0 ustar pravi pravi namespace :webpacker do
desc "Verifies if Node.js is installed"
task :check_node do
begin
node_version = `node -v || nodejs -v`
raise Errno::ENOENT if node_version.blank?
pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
node_requirement = JSON.parse(pkg_path.read)["engines"]["node"]
requirement = Gem::Requirement.new(node_requirement)
version = Gem::Version.new(node_version.strip.tr("v", ""))
unless requirement.satisfied_by?(version)
$stderr.puts "Webpacker requires Node.js #{requirement} and you are using #{version}"
$stderr.puts "Please upgrade Node.js https://nodejs.org/en/download/"
$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!
end
end
end
webpacker-4.2.2/lib/tasks/webpacker/verify_install.rake 0000644 0001750 0001750 00000000662 13712041056 022245 0 ustar pravi pravi require "webpacker/configuration"
namespace :webpacker do
desc "Verifies if Webpacker is installed"
task verify_install: [:check_node, :check_yarn, :check_binstubs] do
unless Webpacker.config.config_path.exist?
$stderr.puts "Configuration config/webpacker.yml file not found. \n"\
"Make sure webpacker:install is run successfully before " \
"running dependent tasks"
exit!
end
end
end
webpacker-4.2.2/lib/tasks/webpacker/check_yarn.rake 0000644 0001750 0001750 00000001622 13712041056 021316 0 ustar pravi pravi namespace :webpacker do
desc "Verifies if Yarn is installed"
task :check_yarn do
begin
yarn_version = `yarn --version`
raise Errno::ENOENT if yarn_version.blank?
pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
yarn_requirement = JSON.parse(pkg_path.read)["engines"]["yarn"]
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!
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!
end
end
end
webpacker-4.2.2/lib/tasks/webpacker/compile.rake 0000644 0001750 0001750 00000002360 13712041056 020640 0 ustar pravi pravi $stdout.sync = true
def yarn_install_available?
rails_major = Rails::VERSION::MAJOR
rails_minor = Rails::VERSION::MINOR
rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
end
def enhance_assets_precompile
# yarn:install was added in Rails 5.1
deps = yarn_install_available? ? [] : ["webpacker:yarn_install"]
Rake::Task["assets:precompile"].enhance(deps) do
Rake::Task["webpacker:compile"].invoke
end
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(ENV.fetch("NODE_ENV", "production")) do
Webpacker.ensure_log_goes_to_stdout do
if Webpacker.compile
# Successful compilation!
else
# Failed compilation
exit!
end
end
end
end
end
# Compile packs after we've compiled all other assets during precompilation
skip_webpacker_precompile = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
unless skip_webpacker_precompile
if Rake::Task.task_defined?("assets:precompile")
enhance_assets_precompile
else
Rake::Task.define_task("assets:precompile" => ["webpacker:yarn_install", "webpacker:compile"])
end
end
webpacker-4.2.2/lib/tasks/webpacker/clobber.rake 0000644 0001750 0001750 00000000750 13712041056 020621 0 ustar pravi pravi require "webpacker/configuration"
namespace :webpacker do
desc "Remove the webpack compiled output directory"
task clobber: ["webpacker:verify_install", :environment] do
Webpacker.clobber
$stdout.puts "Removed webpack output path directory #{Webpacker.config.public_output_path}"
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
end
end
webpacker-4.2.2/lib/tasks/webpacker/install.rake 0000644 0001750 0001750 00000000760 13712041056 020660 0 ustar pravi pravi install_template_path = File.expand_path("../../install/template.rb", __dir__).freeze
bin_path = ENV["BUNDLE_BIN"] || "./bin"
namespace :webpacker do
desc "Install Webpacker in this application"
task install: [:check_node, :check_yarn] do
if Rails::VERSION::MAJOR >= 5
exec "#{RbConfig.ruby} #{bin_path}/rails app:template LOCATION=#{install_template_path}"
else
exec "#{RbConfig.ruby} #{bin_path}/rake rails:template LOCATION=#{install_template_path}"
end
end
end
webpacker-4.2.2/lib/tasks/webpacker/yarn_install.rake 0000644 0001750 0001750 00000001007 13712041056 021704 0 ustar pravi pravi 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"
exit(1) unless $?.success?
end
end
def enhance_yarn_install
Rake::Task["yarn:install"].enhance do
exit(1) unless $?.success?
end
end
if Rake::Task.task_defined?("yarn:install")
enhance_yarn_install
else
# this is mainly for pre-5.x era
Rake::Task.define_task("yarn:install" => "webpacker:yarn_install")
end
webpacker-4.2.2/lib/tasks/webpacker/clean.rake 0000644 0001750 0001750 00000000743 13712041056 020275 0 ustar pravi pravi $stdout.sync = true
require "webpacker/configuration"
namespace :webpacker do
desc "Remove old compiled webpacks"
task :clean, [:keep] => ["webpacker:verify_install", :environment] do |_, args|
Webpacker.ensure_log_goes_to_stdout do
Webpacker.clean(Integer(args.keep || 2))
end
end
end
# 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
end
webpacker-4.2.2/lib/tasks/webpacker/binstubs.rake 0000644 0001750 0001750 00000000776 13712041056 021052 0 ustar pravi pravi binstubs_template_path = File.expand_path("../../install/binstubs.rb", __dir__).freeze
bin_path = ENV["BUNDLE_BIN"] || "./bin"
namespace :webpacker do
desc "Installs Webpacker binstubs in this application"
task binstubs: [:check_node, :check_yarn] do
if Rails::VERSION::MAJOR >= 5
exec "#{RbConfig.ruby} #{bin_path}/rails app:template LOCATION=#{binstubs_template_path}"
else
exec "#{RbConfig.ruby} #{bin_path}/rake rails:template LOCATION=#{binstubs_template_path}"
end
end
end
webpacker-4.2.2/lib/tasks/installers.rake 0000644 0001750 0001750 00000002122 13712041056 017421 0 ustar pravi pravi installers = {
"Angular": :angular,
"Elm": :elm,
"React": :react,
"Vue": :vue,
"Erb": :erb,
"Coffee": :coffee,
"Typescript": :typescript,
"Svelte": :svelte,
"Stimulus": :stimulus
}.freeze
dependencies = {
"Angular": [:typescript]
}
bin_path = ENV["BUNDLE_BIN"] || "./bin"
namespace :webpacker do
namespace :install do
installers.each do |name, task_name|
desc "Install everything needed for #{name}"
task task_name => ["webpacker:verify_install"] do
template = File.expand_path("../install/#{task_name}.rb", __dir__)
base_path =
if Rails::VERSION::MAJOR >= 5
"#{RbConfig.ruby} #{bin_path}/rails app:template"
else
"#{RbConfig.ruby} #{bin_path}/rake rails:template"
end
dependencies[name] ||= []
dependencies[name].each do |dependency|
dependency_template = File.expand_path("../install/#{dependency}.rb", __dir__)
system "#{base_path} LOCATION=#{dependency_template}"
end
exec "#{base_path} LOCATION=#{template}"
end
end
end
end
webpacker-4.2.2/.travis.yml 0000644 0001750 0001750 00000002610 13712041056 014615 0 ustar pravi pravi language: ruby
dist: xenial
before_install:
- gem install rubygems-update && update_rubygems
# Rails 4.2 doesn't support bundler 2.0, so we need to lock bundler to
# v1.17.3. This is just for Ruby 2.5 which ships with bundler 2.x on Travis
# CI while Ruby 2.6 does not.
# https://github.com/travis-ci/travis-rubies/issues/57#issuecomment-458981237
- yes | rvm @global do gem install bundler -v 1.17.3 || true
rvm:
- 2.3.8
- 2.4.6
- 2.5.5
- 2.6.3
- ruby-head
gemfile:
- gemfiles/Gemfile-rails.4.2.x
- gemfiles/Gemfile-rails.5.0.x
- gemfiles/Gemfile-rails.5.1.x
- gemfiles/Gemfile-rails.5.2.x
- gemfiles/Gemfile-rails.6.0.x
- gemfiles/Gemfile-rails-edge
cache:
bundler: true
directories:
- node_modules
yarn: true
install:
- bundle install --jobs 3 --retry 3
- nvm install 10
- node -v
- npm i -g yarn
- yarn
script:
- yarn lint
- yarn test
- bundle exec rubocop
- bundle exec rake test
matrix:
allow_failures:
- gemfile: gemfiles/Gemfile-rails-edge
- rvm: ruby-head
exclude:
- rvm: 2.3.8
gemfile: gemfiles/Gemfile-rails-edge
- rvm: 2.4.6
gemfile: gemfiles/Gemfile-rails-edge
- rvm: 2.5.5
gemfile: gemfiles/Gemfile-rails-edge
- rvm: ruby-head
gemfile: gemfiles/Gemfile-rails.4.2.x
- rvm: 2.3.8
gemfile: gemfiles/Gemfile-rails.6.0.x
- rvm: 2.4.6
gemfile: gemfiles/Gemfile-rails.6.0.x
webpacker-4.2.2/CONTRIBUTING.md 0000644 0001750 0001750 00000001263 13712041056 014740 0 ustar pravi pravi ## Setting Up a Development Environment
1. Install [Yarn](https://yarnpkg.com/)
2. Run the following commands to set up the development environment.
```
bundle install
yarn
```
## Making sure your changes pass all tests
There are a number of automated checks which run on Travis CI when a pull request is created.
You can run those checks on your own locally to make sure that your changes would not break the CI build.
### 1. Check the code for JavaScript style violations
```
yarn lint
```
### 2. Check the code for Ruby style violations
```
bundle exec rubocop
```
### 3. Run the JavaScript test suite
```
yarn test
```
### 4. Run the Ruby test suite
```
bundle exec rake test
```
webpacker-4.2.2/.rubocop.yml 0000644 0001750 0001750 00000005506 13712041056 014765 0 ustar pravi pravi require: rubocop-performance
AllCops:
TargetRubyVersion: 2.2
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
# to ignore them, so only the ones explicitly set in this file are enabled.
DisabledByDefault: true
Exclude:
- 'lib/install/templates/**'
- 'vendor/**/*'
- 'node_modules/**/*'
# Prefer &&/|| over and/or.
Style/AndOr:
Enabled: true
# Do not use braces for hash literals when they are the last argument of a
# method call.
Style/BracesAroundHashParameters:
Enabled: true
# Align `when` with `case`.
Layout/CaseIndentation:
Enabled: true
# Align comments with method definitions.
Layout/CommentIndentation:
Enabled: true
# No extra empty lines.
Layout/EmptyLines:
Enabled: true
# In a regular class definition, no empty lines around the body.
Layout/EmptyLinesAroundClassBody:
Enabled: true
# In a regular method definition, no empty lines around the body.
Layout/EmptyLinesAroundMethodBody:
Enabled: true
# In a regular module definition, no empty lines around the body.
Layout/EmptyLinesAroundModuleBody:
Enabled: true
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
Style/HashSyntax:
Enabled: true
# Method definitions after `private` or `protected` isolated calls need one
# extra level of indentation.
Layout/IndentationConsistency:
Enabled: true
EnforcedStyle: rails
# Two spaces, no tabs (for indentation).
Layout/IndentationWidth:
Enabled: true
Layout/SpaceAfterColon:
Enabled: true
Layout/SpaceAfterComma:
Enabled: true
Layout/SpaceAroundEqualsInParameterDefault:
Enabled: true
Layout/SpaceAroundKeyword:
Enabled: true
Layout/SpaceAroundOperators:
Enabled: true
Layout/SpaceBeforeFirstArg:
Enabled: true
# Defining a method with parameters needs parentheses.
Style/MethodDefParentheses:
Enabled: true
# Use `foo {}` not `foo{}`.
Layout/SpaceBeforeBlockBraces:
Enabled: true
# Use `foo { bar }` not `foo {bar}`.
Layout/SpaceInsideBlockBraces:
Enabled: true
# Use `{ a: 1 }` not `{a:1}`.
Layout/SpaceInsideHashLiteralBraces:
Enabled: true
Layout/SpaceInsideParens:
Enabled: true
# Check quotes usage according to lint rule below.
Style/StringLiterals:
Enabled: true
EnforcedStyle: double_quotes
# Detect hard tabs, no hard tabs.
Layout/Tab:
Enabled: true
# Blank lines should not have any spaces.
Layout/TrailingBlankLines:
Enabled: true
# No trailing whitespace.
Layout/TrailingWhitespace:
Enabled: true
# Use quotes for string literals when they are enough.
Style/UnneededPercentQ:
Enabled: true
# Align `end` with the matching keyword or starting expression except for
# assignments, where it should be aligned with the LHS.
Layout/EndAlignment:
Enabled: true
EnforcedStyleAlignWith: variable
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
Lint/RequireParentheses:
Enabled: true
webpacker-4.2.2/MIT-LICENSE 0000644 0001750 0001750 00000002073 13712041056 014143 0 ustar pravi pravi Copyright (c) 2016-2019 David Heinemeier Hansson, Basecamp
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
webpacker-4.2.2/Gemfile 0000644 0001750 0001750 00000000251 13712041056 013776 0 ustar pravi pravi source "https://rubygems.org"
gemspec
gem "rails"
gem "rake", ">= 11.1"
gem "rack-proxy", require: false
group :test do
gem "minitest", "~> 5.0"
gem "byebug"
end
webpacker-4.2.2/package/ 0000755 0001750 0001750 00000000000 13712041056 014100 5 ustar pravi pravi webpacker-4.2.2/package/config.js 0000644 0001750 0001750 00000002666 13712041056 015715 0 ustar pravi pravi const { resolve } = require('path')
const { safeLoad } = require('js-yaml')
const { readFileSync } = require('fs')
const deepMerge = require('./utils/deep_merge')
const { isArray, ensureTrailingSlash } = require('./utils/helpers')
const { railsEnv } = require('./env')
const defaultConfigPath = require.resolve('../lib/install/config/webpacker.yml')
const configPath = resolve('config', 'webpacker.yml')
const getDefaultConfig = () => {
const defaultConfig = safeLoad(readFileSync(defaultConfigPath), 'utf8')
return defaultConfig[railsEnv] || defaultConfig.production
}
const defaults = getDefaultConfig()
const app = safeLoad(readFileSync(configPath), 'utf8')[railsEnv]
if (isArray(app.extensions) && app.extensions.length) delete defaults.extensions
if (isArray(app.static_assets_extensions) && app.static_assets_extensions.length) {
delete defaults.static_assets_extensions
}
const config = deepMerge(defaults, app)
config.outputPath = resolve(config.public_root_path, config.public_output_path)
// Ensure that the publicPath includes our asset host so dynamic imports
// (code-splitting chunks and static assets) load from the CDN instead of a relative path.
const getPublicPath = () => {
const rootUrl = ensureTrailingSlash(process.env.WEBPACKER_ASSET_HOST || '/')
return `${rootUrl}${config.public_output_path}/`
}
config.publicPath = getPublicPath()
config.publicPathWithoutCDN = `/${config.public_output_path}/`
module.exports = config
webpacker-4.2.2/package/index.js 0000644 0001750 0001750 00000001215 13712041056 015544 0 ustar pravi pravi /* eslint global-require: 0 */
/* eslint import/no-dynamic-require: 0 */
const { resolve } = require('path')
const { existsSync } = require('fs')
const Environment = require('./environments/base')
const loaders = require('./rules')
const config = require('./config')
const devServer = require('./dev_server')
const { nodeEnv } = require('./env')
const createEnvironment = () => {
const path = resolve(__dirname, 'environments', `${nodeEnv}.js`)
const constructor = existsSync(path) ? require(path) : Environment
return new constructor()
}
module.exports = {
config,
devServer,
environment: createEnvironment(),
Environment,
loaders
}
webpacker-4.2.2/package/__tests__/ 0000755 0001750 0001750 00000000000 13712041056 016036 5 ustar pravi pravi webpacker-4.2.2/package/__tests__/config.js 0000644 0001750 0001750 00000002357 13712041056 017650 0 ustar pravi pravi /* global test expect, describe */
const { chdirCwd, chdirTestApp, resetEnv } = require('../utils/helpers')
chdirTestApp()
const config = require('../config')
describe('Config', () => {
beforeEach(() => jest.resetModules() && resetEnv())
afterAll(chdirCwd)
test('public path', () => {
process.env.RAILS_ENV = 'development'
const config = require('../config')
expect(config.publicPath).toEqual('/packs/')
})
test('public path with asset host', () => {
process.env.RAILS_ENV = 'development'
process.env.WEBPACKER_ASSET_HOST = 'http://foo.com/'
const config = require('../config')
expect(config.publicPath).toEqual('http://foo.com/packs/')
})
test('should return extensions as listed in app config', () => {
expect(config.extensions).toEqual([
'.mjs',
'.js',
'.sass',
'.scss',
'.css',
'.module.sass',
'.module.scss',
'.module.css',
'.png',
'.svg',
'.gif',
'.jpeg',
'.jpg'
])
})
test('should return static assets extensions as listed in app config', () => {
expect(config.static_assets_extensions).toEqual([
'.jpg',
'.jpeg',
'.png',
'.gif',
'.tiff',
'.ico',
'.svg',
])
})
})
webpacker-4.2.2/package/__tests__/staging.js 0000644 0001750 0001750 00000001472 13712041056 020034 0 ustar pravi pravi /* test expect, describe, afterAll, beforeEach */
const { resolve } = require('path')
const { chdirTestApp, chdirCwd } = require('../utils/helpers')
chdirTestApp()
describe('Custom environment', () => {
afterAll(chdirCwd)
describe('toWebpackConfig', () => {
beforeEach(() => jest.resetModules())
test('should use staging config and default production environment', () => {
process.env.RAILS_ENV = 'staging'
delete process.env.NODE_ENV
const { environment } = require('../index')
const config = environment.toWebpackConfig()
expect(config.output.path).toEqual(resolve('public', 'packs-staging'))
expect(config.output.publicPath).toEqual('/packs-staging/')
expect(config).toMatchObject({
devtool: 'source-map',
stats: 'normal'
})
})
})
})
webpacker-4.2.2/package/__tests__/production.js 0000644 0001750 0001750 00000001451 13712041056 020563 0 ustar pravi pravi /* test expect, describe, afterAll, beforeEach */
const { resolve } = require('path')
const { chdirTestApp, chdirCwd } = require('../utils/helpers')
chdirTestApp()
describe('Production environment', () => {
afterAll(chdirCwd)
describe('toWebpackConfig', () => {
beforeEach(() => jest.resetModules())
test('should use production config and environment', () => {
process.env.RAILS_ENV = 'production'
process.env.NODE_ENV = 'production'
const { environment } = require('../index')
const config = environment.toWebpackConfig()
expect(config.output.path).toEqual(resolve('public', 'packs'))
expect(config.output.publicPath).toEqual('/packs/')
expect(config).toMatchObject({
devtool: 'source-map',
stats: 'normal'
})
})
})
})
webpacker-4.2.2/package/__tests__/development.js 0000644 0001750 0001750 00000001506 13712041056 020720 0 ustar pravi pravi /* test expect, describe, afterAll, beforeEach */
const { resolve } = require('path')
const { chdirTestApp, chdirCwd } = require('../utils/helpers')
chdirTestApp()
describe('Development environment', () => {
afterAll(chdirCwd)
describe('toWebpackConfig', () => {
beforeEach(() => jest.resetModules())
test('should use development config and environment', () => {
process.env.RAILS_ENV = 'development'
process.env.NODE_ENV = 'development'
const { environment } = require('../index')
const config = environment.toWebpackConfig()
expect(config.output.path).toEqual(resolve('public', 'packs'))
expect(config.output.publicPath).toEqual('/packs/')
expect(config).toMatchObject({
devServer: {
host: 'localhost',
port: 3035
}
})
})
})
})
webpacker-4.2.2/package/__tests__/dev_server.js 0000644 0001750 0001750 00000002520 13712041056 020537 0 ustar pravi pravi /* global test expect, describe */
const { chdirTestApp, chdirCwd } = require('../utils/helpers')
chdirTestApp()
describe('DevServer', () => {
beforeEach(() => jest.resetModules())
afterAll(chdirCwd)
test('with NODE_ENV and RAILS_ENV set to development', () => {
process.env.NODE_ENV = 'development'
process.env.RAILS_ENV = 'development'
process.env.WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
process.env.WEBPACKER_DEV_SERVER_PORT = 5000
const devServer = require('../dev_server')
expect(devServer).toBeDefined()
expect(devServer.host).toEqual('0.0.0.0')
expect(devServer.port).toEqual('5000')
})
test('with custom env prefix', () => {
const config = require('../config')
config.dev_server.env_prefix = 'TEST_WEBPACKER_DEV_SERVER'
process.env.NODE_ENV = 'development'
process.env.RAILS_ENV = 'development'
process.env.TEST_WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
process.env.TEST_WEBPACKER_DEV_SERVER_PORT = 5000
const devServer = require('../dev_server')
expect(devServer).toBeDefined()
expect(devServer.host).toEqual('0.0.0.0')
expect(devServer.port).toEqual('5000')
})
test('with NODE_ENV and RAILS_ENV set to production', () => {
process.env.RAILS_ENV = 'production'
process.env.NODE_ENV = 'production'
expect(require('../dev_server')).toEqual({})
})
})
webpacker-4.2.2/package/__tests__/test.js 0000644 0001750 0001750 00000001363 13712041056 017356 0 ustar pravi pravi /* test expect, describe, afterAll, beforeEach */
const { resolve } = require('path')
const { chdirTestApp, chdirCwd } = require('../utils/helpers')
chdirTestApp()
describe('Test environment', () => {
afterAll(chdirCwd)
describe('toWebpackConfig', () => {
beforeEach(() => jest.resetModules())
test('should use test config and production environment', () => {
process.env.RAILS_ENV = 'test'
process.env.NODE_ENV = 'test'
const { environment } = require('../index')
const config = environment.toWebpackConfig()
expect(config.output.path).toEqual(resolve('public', 'packs-test'))
expect(config.output.publicPath).toEqual('/packs-test/')
expect(config.devServer).toEqual(undefined)
})
})
})
webpacker-4.2.2/package/__tests__/env.js 0000644 0001750 0001750 00000002247 13712041056 017171 0 ustar pravi pravi /* global test expect, describe */
const { chdirTestApp, chdirCwd } = require('../utils/helpers')
chdirTestApp()
describe('Env', () => {
beforeEach(() => jest.resetModules())
afterAll(chdirCwd)
test('with NODE_ENV and RAILS_ENV set to development', () => {
process.env.RAILS_ENV = 'development'
process.env.NODE_ENV = 'development'
expect(require('../env')).toEqual({
railsEnv: 'development',
nodeEnv: 'development'
})
})
test('with undefined NODE_ENV and RAILS_ENV set to development', () => {
process.env.RAILS_ENV = 'development'
delete process.env.NODE_ENV
expect(require('../env')).toEqual({
railsEnv: 'development',
nodeEnv: 'production'
})
})
test('with undefined NODE_ENV and RAILS_ENV', () => {
delete process.env.NODE_ENV
delete process.env.RAILS_ENV
expect(require('../env')).toEqual({
railsEnv: 'production',
nodeEnv: 'production'
})
})
test('with a non-standard environment', () => {
process.env.RAILS_ENV = 'staging'
process.env.NODE_ENV = 'staging'
expect(require('../env')).toEqual({
railsEnv: 'staging',
nodeEnv: 'production'
})
})
})
webpacker-4.2.2/package/rules/ 0000755 0001750 0001750 00000000000 13712041056 015232 5 ustar pravi pravi webpacker-4.2.2/package/rules/file.js 0000644 0001750 0001750 00000001012 13712041056 016501 0 ustar pravi pravi const { join } = require('path')
const { source_path: sourcePath, static_assets_extensions: fileExtensions } = require('../config')
module.exports = {
test: new RegExp(`(${fileExtensions.join('|')})$`, 'i'),
use: [
{
loader: 'file-loader',
options: {
name(file) {
if (file.includes(sourcePath)) {
return 'media/[path][name]-[hash].[ext]'
}
return 'media/[folder]/[name]-[hash:8].[ext]'
},
context: join(sourcePath)
}
}
]
}
webpacker-4.2.2/package/rules/index.js 0000644 0001750 0001750 00000000777 13712041056 016712 0 ustar pravi pravi const babel = require('./babel')
const file = require('./file')
const css = require('./css')
const sass = require('./sass')
const moduleCss = require('./module.css')
const moduleSass = require('./module.sass')
const nodeModules = require('./node_modules')
// Webpack loaders are processed in reverse order
// https://webpack.js.org/concepts/loaders/#loader-features
// Lastly, process static files using file loader
module.exports = {
file,
css,
sass,
moduleCss,
moduleSass,
nodeModules,
babel
}
webpacker-4.2.2/package/rules/sass.js 0000644 0001750 0001750 00000000302 13712041056 016534 0 ustar pravi pravi const getStyleRule = require('../utils/get_style_rule')
module.exports = getStyleRule(/\.(scss|sass)(\.erb)?$/i, false, [
{
loader: 'sass-loader',
options: { sourceMap: true }
}
])
webpacker-4.2.2/package/rules/css.js 0000644 0001750 0001750 00000000144 13712041056 016357 0 ustar pravi pravi const getStyleRule = require('../utils/get_style_rule')
module.exports = getStyleRule(/\.(css)$/i)
webpacker-4.2.2/package/rules/babel.js 0000644 0001750 0001750 00000001267 13712041056 016643 0 ustar pravi pravi const { join, resolve } = require('path')
const { cache_path: cachePath, source_path: sourcePath, resolved_paths: resolvedPaths } = require('../config')
const { nodeEnv } = require('../env')
// Process application Javascript code with Babel.
// Uses application .babelrc to apply any transformations
module.exports = {
test: /\.(js|jsx|mjs)?(\.erb)?$/,
include: [sourcePath, ...resolvedPaths].map((p) => resolve(p)),
exclude: /node_modules/,
use: [
{
loader: 'babel-loader',
options: {
cacheDirectory: join(cachePath, 'babel-loader-node-modules'),
cacheCompression: nodeEnv === 'production',
compact: nodeEnv === 'production'
}
}
]
}
webpacker-4.2.2/package/rules/module.sass.js 0000644 0001750 0001750 00000000271 13712041056 020025 0 ustar pravi pravi const getStyleRule = require('../utils/get_style_rule')
module.exports = getStyleRule(/\.(scss|sass)$/i, true, [
{
loader: 'sass-loader',
options: { sourceMap: true }
}
])
webpacker-4.2.2/package/rules/module.css.js 0000644 0001750 0001750 00000000152 13712041056 017642 0 ustar pravi pravi const getStyleRule = require('../utils/get_style_rule')
module.exports = getStyleRule(/\.(css)$/i, true)
webpacker-4.2.2/package/rules/node_modules.js 0000644 0001750 0001750 00000001473 13712041056 020252 0 ustar pravi pravi const { join } = require('path')
const { cache_path: cachePath } = require('../config')
const { nodeEnv } = require('../env')
// Compile standard ES features for JS in node_modules with Babel.
// Regex details for exclude: https://regex101.com/r/SKPnnv/1
module.exports = {
test: /\.(js|mjs)$/,
include: /node_modules/,
exclude: /(?:@?babel(?:\/|\\{1,2}|-).+)|regenerator-runtime|core-js|^webpack$|^webpack-assets-manifest$|^webpack-cli$|^webpack-sources$|^@rails\/webpacker$/,
use: [
{
loader: 'babel-loader',
options: {
babelrc: false,
presets: [['@babel/preset-env', { modules: false }]],
cacheDirectory: join(cachePath, 'babel-loader-node-modules'),
cacheCompression: nodeEnv === 'production',
compact: false,
sourceMaps: false
}
}
]
}
webpacker-4.2.2/package/environments/ 0000755 0001750 0001750 00000000000 13712041056 016627 5 ustar pravi pravi webpacker-4.2.2/package/environments/base.js 0000644 0001750 0001750 00000010665 13712041056 020107 0 ustar pravi pravi /* eslint global-require: 0 */
/* eslint import/no-dynamic-require: 0 */
const {
basename, dirname, join, relative, resolve
} = require('path')
const { sync } = require('glob')
const extname = require('path-complete-extname')
const webpack = require('webpack')
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const WebpackAssetsManifest = require('webpack-assets-manifest')
const CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin')
const PnpWebpackPlugin = require('pnp-webpack-plugin')
const { isNotObject, prettyPrint } = require('../utils/helpers')
const deepMerge = require('../utils/deep_merge')
const { ConfigList, ConfigObject } = require('../config_types')
const rules = require('../rules')
const config = require('../config')
const getLoaderList = () => {
const result = new ConfigList()
Object.keys(rules).forEach((key) => result.append(key, rules[key]))
return result
}
const getPluginList = () => {
const result = new ConfigList()
result.append(
'Environment',
new webpack.EnvironmentPlugin(JSON.parse(JSON.stringify(process.env)))
)
result.append('CaseSensitivePaths', new CaseSensitivePathsPlugin())
result.append(
'MiniCssExtract',
new MiniCssExtractPlugin({
filename: 'css/[name]-[contenthash:8].css',
chunkFilename: 'css/[name]-[contenthash:8].chunk.css'
})
)
result.append(
'Manifest',
new WebpackAssetsManifest({
integrity: false,
entrypoints: true,
writeToDisk: true,
publicPath: config.publicPathWithoutCDN
})
)
return result
}
const getExtensionsGlob = () => {
const { extensions } = config
return extensions.length === 1 ? `**/*${extensions[0]}` : `**/*{${extensions.join(',')}}`
}
const getEntryObject = () => {
const result = new ConfigObject()
const glob = getExtensionsGlob()
const rootPath = join(config.source_path, config.source_entry_path)
const paths = sync(join(rootPath, glob))
paths.forEach((path) => {
const namespace = relative(join(rootPath), dirname(path))
const name = join(namespace, basename(path, extname(path)))
result.set(name, resolve(path))
})
return result
}
const getModulePaths = () => {
const result = new ConfigList()
result.append('source', resolve(config.source_path))
if (config.resolved_paths) {
config.resolved_paths.forEach((path) => result.append(path, resolve(path)))
}
result.append('node_modules', 'node_modules')
return result
}
const getBaseConfig = () => new ConfigObject({
mode: 'production',
output: {
filename: 'js/[name]-[contenthash].js',
chunkFilename: 'js/[name]-[contenthash].chunk.js',
hotUpdateChunkFilename: 'js/[id]-[hash].hot-update.js',
path: config.outputPath,
publicPath: config.publicPath
},
resolve: {
extensions: config.extensions,
plugins: [PnpWebpackPlugin]
},
resolveLoader: {
modules: ['node_modules'],
plugins: [PnpWebpackPlugin.moduleLoader(module)]
},
node: {
dgram: 'empty',
fs: 'empty',
net: 'empty',
tls: 'empty',
child_process: 'empty'
}
})
module.exports = class Base {
constructor() {
this.loaders = getLoaderList()
this.plugins = getPluginList()
this.config = getBaseConfig()
this.entry = getEntryObject()
this.resolvedModules = getModulePaths()
}
splitChunks(callback = null) {
let appConfig = {}
const defaultConfig = {
optimization: {
// Split vendor and common chunks
// https://twitter.com/wSokra/status/969633336732905474
splitChunks: {
chunks: 'all',
name: false
},
// Separate runtime chunk to enable long term caching
// https://twitter.com/wSokra/status/969679223278505985
runtimeChunk: true
}
}
if (callback) {
appConfig = callback(defaultConfig)
if (isNotObject(appConfig)) {
throw new Error(`
${prettyPrint(appConfig)} is not a valid splitChunks configuration.
See https://webpack.js.org/plugins/split-chunks-plugin/#configuration
`)
}
}
return this.config.merge(deepMerge(defaultConfig, appConfig))
}
toWebpackConfig() {
return this.config.merge({
entry: this.entry.toObject(),
module: {
strictExportPresence: true,
rules: [{ parser: { requireEnsure: false } }, ...this.loaders.values()]
},
plugins: this.plugins.values(),
resolve: {
modules: this.resolvedModules.values()
}
})
}
}
webpacker-4.2.2/package/environments/__tests__/ 0000755 0001750 0001750 00000000000 13712041056 020565 5 ustar pravi pravi webpacker-4.2.2/package/environments/__tests__/base.js 0000644 0001750 0001750 00000004362 13712041056 022042 0 ustar pravi pravi /* global test expect, describe, afterAll, beforeEach */
// environment.js expects to find config/webpacker.yml and resolved modules from
// the root of a Rails project
const { chdirTestApp, chdirCwd } = require('../../utils/helpers')
chdirTestApp()
const { resolve } = require('path')
const rules = require('../../rules')
const { ConfigList } = require('../../config_types')
const Environment = require('../base')
describe('Environment', () => {
afterAll(chdirCwd)
let environment
describe('toWebpackConfig', () => {
beforeEach(() => {
environment = new Environment()
})
test('should return entry', () => {
const config = environment.toWebpackConfig()
expect(config.entry.application).toEqual(
resolve('app', 'javascript', 'packs', 'application.js')
)
})
test('should return output', () => {
const config = environment.toWebpackConfig()
expect(config.output.filename).toEqual('js/[name]-[contenthash].js')
expect(config.output.chunkFilename).toEqual('js/[name]-[contenthash].chunk.js')
})
test('should return default loader rules for each file in config/loaders', () => {
const config = environment.toWebpackConfig()
const defaultRules = Object.keys(rules)
const configRules = config.module.rules
expect(defaultRules.length).toEqual(7)
expect(configRules.length).toEqual(8)
})
test('should return default plugins', () => {
const config = environment.toWebpackConfig()
expect(config.plugins.length).toEqual(4)
})
test('should return default resolveLoader', () => {
const config = environment.toWebpackConfig()
expect(config.resolveLoader.modules).toEqual(['node_modules'])
})
test('should return default resolve.modules with additions', () => {
const config = environment.toWebpackConfig()
expect(config.resolve.modules).toEqual([
resolve('app', 'javascript'),
resolve('app/assets'),
resolve('/etc/yarn'),
'node_modules'
])
})
test('returns plugins property as Array', () => {
const config = environment.toWebpackConfig()
expect(config.plugins).toBeInstanceOf(Array)
expect(config.plugins).not.toBeInstanceOf(ConfigList)
})
})
})
webpacker-4.2.2/package/environments/production.js 0000644 0001750 0001750 00000003710 13712041056 021354 0 ustar pravi pravi const TerserPlugin = require('terser-webpack-plugin')
const CompressionPlugin = require('compression-webpack-plugin')
const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin')
const safePostCssParser = require('postcss-safe-parser')
const Base = require('./base')
module.exports = class extends Base {
constructor() {
super()
this.plugins.append(
'Compression',
new CompressionPlugin({
filename: '[path].gz[query]',
algorithm: 'gzip',
cache: true,
test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
})
)
if ('brotli' in process.versions) {
this.plugins.append(
'Compression Brotli',
new CompressionPlugin({
filename: '[path].br[query]',
algorithm: 'brotliCompress',
cache: true,
test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
})
)
}
this.plugins.append(
'OptimizeCSSAssets',
new OptimizeCSSAssetsPlugin({
parser: safePostCssParser,
map: {
inline: false,
annotation: true
}
})
)
this.config.merge({
devtool: 'source-map',
stats: 'normal',
bail: true,
optimization: {
minimizer: [
new TerserPlugin({
parallel: true,
cache: true,
sourceMap: true,
terserOptions: {
parse: {
// Let terser parse ecma 8 code but always output
// ES5 compliant code for older browsers
ecma: 8
},
compress: {
ecma: 5,
warnings: false,
comparisons: false
},
mangle: {
safari10: true
},
output: {
ecma: 5,
comments: false,
ascii_only: true
}
}
})
]
}
})
}
}
webpacker-4.2.2/package/environments/development.js 0000644 0001750 0001750 00000002557 13712041056 021520 0 ustar pravi pravi const webpack = require('webpack')
const Base = require('./base')
const devServer = require('../dev_server')
const { outputPath: contentBase, publicPath } = require('../config')
module.exports = class extends Base {
constructor() {
super()
if (devServer.hmr) {
this.plugins.append('HotModuleReplacement', new webpack.HotModuleReplacementPlugin())
this.config.output.filename = '[name]-[hash].js'
}
this.config.merge({
mode: 'development',
cache: true,
devtool: 'cheap-module-source-map',
output: {
pathinfo: true
},
devServer: {
clientLogLevel: 'none',
compress: devServer.compress,
quiet: devServer.quiet,
disableHostCheck: devServer.disable_host_check,
host: devServer.host,
port: devServer.port,
https: devServer.https,
hot: devServer.hmr,
contentBase,
inline: devServer.inline,
useLocalIp: devServer.use_local_ip,
public: devServer.public,
publicPath,
historyApiFallback: {
disableDotRule: true
},
headers: devServer.headers,
overlay: devServer.overlay,
stats: {
entrypoints: false,
errorDetails: true,
modules: false,
moduleTrace: false
},
watchOptions: devServer.watch_options
}
})
}
}
webpacker-4.2.2/package/environments/test.js 0000644 0001750 0001750 00000000107 13712041056 020142 0 ustar pravi pravi const Base = require('./base')
module.exports = class extends Base {}
webpacker-4.2.2/package/utils/ 0000755 0001750 0001750 00000000000 13712041056 015240 5 ustar pravi pravi webpacker-4.2.2/package/utils/get_style_rule.js 0000644 0001750 0001750 00000002016 13712041056 020623 0 ustar pravi pravi const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const { resolve } = require('path')
const config = require('../config')
const styleLoader = {
loader: 'style-loader'
}
const getStyleRule = (test, modules = false, preprocessors = []) => {
const use = [
{
loader: 'css-loader',
options: {
sourceMap: true,
importLoaders: 2,
modules: modules ? {
localIdentName: '[name]__[local]___[hash:base64:5]'
} : false
}
},
{
loader: 'postcss-loader',
options: {
config: { path: resolve() },
sourceMap: true
}
},
...preprocessors
]
const options = modules ? { include: /\.module\.[a-z]+$/ } : { exclude: /\.module\.[a-z]+$/ }
if (config.extract_css) {
use.unshift(MiniCssExtractPlugin.loader)
} else {
use.unshift(styleLoader)
}
// sideEffects - See https://github.com/webpack/webpack/issues/6571
return {
test, use, sideEffects: !modules, ...options
}
}
module.exports = getStyleRule
webpacker-4.2.2/package/utils/__tests__/ 0000755 0001750 0001750 00000000000 13712041056 017176 5 ustar pravi pravi webpacker-4.2.2/package/utils/__tests__/get_style_rule.js 0000644 0001750 0001750 00000003644 13712041056 022571 0 ustar pravi pravi const { chdirTestApp, chdirCwd } = require('../helpers')
chdirTestApp()
const getStyleRule = require('../get_style_rule')
describe('getStyleRule', () => {
afterAll(chdirCwd)
test('excludes modules by default', () => {
const cssRule = getStyleRule(/\.(css)$/i)
const expectation = {
test: /\.(css)$/i,
exclude: /\.module\.[a-z]+$/
}
expect(cssRule).toMatchObject(expectation)
})
test('includes modules if set to true', () => {
const cssRule = getStyleRule(/\.(scss)$/i, true)
const expectation = {
test: /\.(scss)$/i,
include: /\.module\.[a-z]+$/
}
expect(cssRule).toMatchObject(expectation)
})
test('adds extra preprocessors if supplied', () => {
const expectation = [{ foo: 'bar' }]
const cssRule = getStyleRule(/\.(css)$/i, true, expectation)
expect(cssRule.use).toMatchObject(expect.arrayContaining(expectation))
})
test('adds mini-css-extract-plugin when extract_css is true', () => {
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const expectation = [MiniCssExtractPlugin.loader]
require('../../config').extract_css = true
const cssRule = getStyleRule(/\.(css)$/i)
expect(cssRule.use).toMatchObject(expect.arrayContaining(expectation))
})
test('adds style-loader when extract_css is true', () => {
const expectation = [{loader: 'style-loader'}]
require('../../config').extract_css = false
const cssRule = getStyleRule(/\.(css)$/i)
expect(cssRule.use).toMatchObject(expect.objectContaining(expectation))
})
test(`doesn't add mini-css-extract-plugin when extract_css is false`, () => {
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const expectation = [MiniCssExtractPlugin.loader]
require('../../config').extract_css = false
const cssRule = getStyleRule(/\.(css)$/i)
expect(cssRule.use).toMatchObject(expect.not.arrayContaining(expectation))
})
})
webpacker-4.2.2/package/utils/__tests__/deep_merge.js 0000644 0001750 0001750 00000000563 13712041056 021634 0 ustar pravi pravi /* global test expect */
const deepMerge = require('../deep_merge')
test('deep merge objects together', () => {
const object1 = { foo: { bar: [1, 2, 3], z: 1 }, x: 0 }
const object2 = { foo: { bar: ['x', 'y'] }, x: 1, y: 2 }
const expectation = { foo: { bar: [1, 2, 3, 'x', 'y'], z: 1 }, x: 1, y: 2 }
expect(deepMerge(object1, object2)).toEqual(expectation)
})
webpacker-4.2.2/package/utils/__tests__/deep_assign.js 0000644 0001750 0001750 00000001763 13712041056 022024 0 ustar pravi pravi /* global test expect */
const deepAssign = require('../deep_assign')
describe('deepAssign()', () => {
test('deeply assigns nested properties', () => {
const object = { foo: { bar: { } } }
const path = 'foo.bar'
const value = { x: 1, y: 2 }
const expectation = { foo: { bar: { x: 1, y: 2 } } }
expect(deepAssign(object, path, value)).toEqual(expectation)
})
test('allows assignment of a literal false', () => {
const object = { foo: { bar: { } } }
const path = 'foo.bar'
const value = false
const expectation = { foo: { bar: false } }
expect(deepAssign(object, path, value)).toEqual(expectation)
})
test('does not allow assignment of other falsy values', () => {
const object = { foo: { bar: { } } }
const path = 'foo.bar'
const values = [undefined, null, 0, '']
values.forEach(value => {
const expectation = new Error(`Value can't be ${value}`)
expect(() => deepAssign(object, path, value)).toThrow(expectation)
})
})
})
webpacker-4.2.2/package/utils/__tests__/objectify.js 0000644 0001750 0001750 00000000426 13712041056 021514 0 ustar pravi pravi /* global test expect */
const objectify = require('../objectify')
test('Get object from a string path', () => {
const object = { foo: { bar: { x: 1 } } }
expect(objectify('foo.bar', object)).toEqual({ x: 1 })
expect(objectify('some.bar', object)).toEqual(undefined)
})
webpacker-4.2.2/package/utils/deep_merge.js 0000644 0001750 0001750 00000001111 13712041056 017664 0 ustar pravi pravi const {
isObject, isArray, isEqual, isEmpty
} = require('./helpers')
const deepMerge = (target, source) => {
if (isEmpty(target)) return source
if (isEmpty(source)) return target
if (isEqual(target, source)) return source
if (isArray(target) && isArray(source)) return [...new Set([...target, ...source])]
if (!(isObject(target) && isObject(source))) return source
return [...Object.keys(target), ...Object.keys(source)].reduce(
(result, key) => ({
...result,
[key]: deepMerge(target[key], source[key])
}),
{}
)
}
module.exports = deepMerge
webpacker-4.2.2/package/utils/deep_assign.js 0000644 0001750 0001750 00000001220 13712041056 020052 0 ustar pravi pravi const { canMerge, prettyPrint } = require('./helpers')
const deepMerge = require('./deep_merge')
const deepAssign = (obj, path, value) => {
if (!value && value !== false) throw new Error(`Value can't be ${value}`)
const keys = path.split('.')
const key = keys.pop()
const objRef = keys.reduce((acc, currentValue) => {
/* eslint no-param-reassign: 0 */
if (!acc[currentValue]) acc[currentValue] = {}
return acc[currentValue]
}, obj)
if (!objRef) throw new Error(`Prop not found: ${path} in ${prettyPrint(obj)}`)
objRef[key] = canMerge(value) ? deepMerge(objRef[key], value) : value
return obj
}
module.exports = deepAssign
webpacker-4.2.2/package/utils/helpers.js 0000644 0001750 0001750 00000002434 13712041056 017243 0 ustar pravi pravi const { stringify } = require('flatted/cjs')
const isObject = (value) => typeof value === 'object'
&& value !== null
&& (value.length === undefined || value.length === null)
const isNotObject = (value) => !isObject(value)
const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
const isEmpty = (value) => value === null || value === undefined
const isString = (key) => key && typeof key === 'string'
const isStrPath = (key) => {
if (!isString(key)) throw new Error(`Key ${key} should be string`)
return isString(key) && key.includes('.')
}
const isArray = (value) => Array.isArray(value)
const isEqual = (target, source) => stringify(target) === stringify(source)
const canMerge = (value) => isObject(value) || isArray(value)
const prettyPrint = (obj) => JSON.stringify(obj, null, 2)
const chdirTestApp = () => {
try {
return process.chdir('test/test_app')
} catch (e) {
return null
}
}
const chdirCwd = () => process.chdir(process.cwd())
const resetEnv = () => {
process.env = {}
}
const ensureTrailingSlash = (path) => (path.endsWith('/') ? path : `${path}/`)
module.exports = {
chdirTestApp,
chdirCwd,
ensureTrailingSlash,
isObject,
isNotObject,
isBoolean,
isArray,
isEqual,
isEmpty,
isStrPath,
canMerge,
prettyPrint,
resetEnv
}
webpacker-4.2.2/package/utils/objectify.js 0000644 0001750 0001750 00000000212 13712041056 017547 0 ustar pravi pravi const objectify = (path, obj) => path.split('.').reduce((prev, curr) => (prev ? prev[curr] : undefined), obj)
module.exports = objectify
webpacker-4.2.2/package/dev_server.js 0000644 0001750 0001750 00000001111 13712041056 016574 0 ustar pravi pravi const { isBoolean } = require('./utils/helpers')
const config = require('./config')
const fetch = (key) => {
const value = process.env[key]
return isBoolean(value) ? JSON.parse(value) : value
}
const devServerConfig = config.dev_server
if (devServerConfig) {
const envPrefix = config.dev_server.env_prefix || 'WEBPACKER_DEV_SERVER'
Object.keys(devServerConfig).forEach((key) => {
const envValue = fetch(`${envPrefix}_${key.toUpperCase().replace(/_/g, '')}`)
if (envValue !== undefined) devServerConfig[key] = envValue
})
}
module.exports = devServerConfig || {}
webpacker-4.2.2/package/config_types/ 0000755 0001750 0001750 00000000000 13712041056 016571 5 ustar pravi pravi webpacker-4.2.2/package/config_types/index.js 0000644 0001750 0001750 00000000217 13712041056 020236 0 ustar pravi pravi const ConfigObject = require('./config_object')
const ConfigList = require('./config_list')
module.exports = {
ConfigObject,
ConfigList
}
webpacker-4.2.2/package/config_types/__tests__/ 0000755 0001750 0001750 00000000000 13712041056 020527 5 ustar pravi pravi webpacker-4.2.2/package/config_types/__tests__/config_list.js 0000644 0001750 0001750 00000006064 13712041056 023373 0 ustar pravi pravi /* global test expect */
const ConfigList = require('../config_list')
test('new', () => {
const list = new ConfigList()
expect(list).toBeInstanceOf(ConfigList)
expect(list).toBeInstanceOf(Array)
})
test('get', () => {
const list = new ConfigList()
list.append('key', 'value')
expect(list.get('key')).toEqual('value')
})
test('append', () => {
const list = new ConfigList()
list.append('key', 'value')
expect(list.append('key1', 'value1')).toEqual([
{ key: 'key', value: 'value' },
{ key: 'key1', value: 'value1' }
])
})
test('prepend', () => {
const list = new ConfigList()
list.append('key', 'value')
expect(list.prepend('key1', 'value1')).toEqual([
{ key: 'key1', value: 'value1' },
{ key: 'key', value: 'value' }
])
})
test('insert without position', () => {
const list = new ConfigList()
list.append('key', 'value')
expect(list.insert('key1', 'value1')).toEqual([
{ key: 'key', value: 'value' },
{ key: 'key1', value: 'value1' }
])
expect(list.insert('key2', 'value2')).toEqual([
{ key: 'key', value: 'value' },
{ key: 'key1', value: 'value1' },
{ key: 'key2', value: 'value2' }
])
})
test('insert before an item', () => {
const list = new ConfigList()
list.append('key', 'value')
list.append('key1', 'value1')
expect(list.insert('key2', 'value2', { before: 'key' })).toEqual([
{ key: 'key2', value: 'value2' },
{ key: 'key', value: 'value' },
{ key: 'key1', value: 'value1' }
])
expect(list.insert('key3', 'value3', { before: 'key2' })).toEqual([
{ key: 'key3', value: 'value3' },
{ key: 'key2', value: 'value2' },
{ key: 'key', value: 'value' },
{ key: 'key1', value: 'value1' }
])
})
test('insert after an item', () => {
const list = new ConfigList()
list.append('key', 'value')
list.append('key1', 'value1')
expect(list.insert('key2', 'value2', { after: 'key' })).toEqual([
{ key: 'key', value: 'value' },
{ key: 'key2', value: 'value2' },
{ key: 'key1', value: 'value1' }
])
expect(list.insert('key3', 'value3', { after: 'key2' })).toEqual([
{ key: 'key', value: 'value' },
{ key: 'key2', value: 'value2' },
{ key: 'key3', value: 'value3' },
{ key: 'key1', value: 'value1' }
])
})
test('delete', () => {
const list = new ConfigList()
list.append('key', 'value')
list.append('key1', 'value1')
expect(list.delete('key')).toEqual([{ key: 'key1', value: 'value1' }])
expect(list.delete('key1')).toEqual([])
})
test('getIndex', () => {
const list = new ConfigList()
list.append('key', 'value')
list.append('key1', 'value1')
expect(list.getIndex('key')).toEqual(0)
expect(list.getIndex('key2')).toEqual(-1)
expect(() => list.getIndex('key2', true)).toThrow('Item key2 not found')
})
test('values', () => {
const list = new ConfigList()
list.append('key', 'value')
list.append('key1', 'value1')
expect(list.values()).toEqual(['value', 'value1'])
})
test('keys', () => {
const list = new ConfigList()
list.append('key', 'value')
list.append('key1', 'value1')
expect(list.keys()).toEqual(['key', 'key1'])
})
webpacker-4.2.2/package/config_types/__tests__/config_object.js 0000644 0001750 0001750 00000002114 13712041056 023656 0 ustar pravi pravi /* global test expect */
const ConfigObject = require('../config_object')
test('new', () => {
const object = new ConfigObject()
expect(object).toBeInstanceOf(ConfigObject)
expect(object).toBeInstanceOf(Object)
})
test('set', () => {
const object = new ConfigObject()
expect(object.set('key', 'value')).toEqual({ key: 'value' })
})
test('get', () => {
const object = new ConfigObject()
object.set('key', 'value')
object.set('key1', 'value1')
expect(object.get('key')).toEqual('value')
})
test('delete', () => {
const object = new ConfigObject()
object.set('key', { key1: 'value' })
expect(object.delete('key.key1')).toEqual({ key: {} })
expect(object.delete('key')).toEqual({})
})
test('toObject', () => {
const object = new ConfigObject()
object.set('key', 'value')
object.set('key1', 'value1')
expect(object.toObject()).toEqual({ key: 'value', key1: 'value1' })
})
test('merge', () => {
const object = new ConfigObject()
object.set('foo', {})
expect(object.merge({ key: 'foo', value: 'bar' })).toEqual(
{ foo: {}, key: 'foo', value: 'bar' }
)
})
webpacker-4.2.2/package/config_types/config_list.js 0000644 0001750 0001750 00000003034 13712041056 021427 0 ustar pravi pravi /**
* @class
* @extends { Array }
*/
class ConfigList extends Array {
static get [Symbol.species]() { return Array }
get(key) {
const index = this.getIndex(key, true)
return this[index].value
}
append(key, value) {
return this.add({ key, value })
}
prepend(key, value) {
return this.add({ key, value }, 'prepend')
}
insert(key, value, pos = {}) {
if (!(pos.before || pos.after)) return this.append(key, value)
const currentIndex = this.getIndex(key)
if (currentIndex >= 0) this.splice(currentIndex, 1)
let newIndex = this.getIndex(pos.before || pos.after)
if (pos.after) newIndex += 1
this.splice(newIndex, 0, { key, value })
return this
}
delete(key) {
const index = this.getIndex(key, true)
this.splice(index, 1)
return this
}
getIndex(key, shouldThrow = false) {
const index = this.findIndex((entry) => (
entry === key
|| entry.key === key
|| (entry.constructor && entry.constructor.name === key)
))
if (shouldThrow && index < 0) throw new Error(`Item ${key} not found`)
return index
}
add({ key, value }, strategy = 'append') {
const index = this.getIndex(key)
if (index >= 0) this.delete(key)
switch (strategy) {
case 'prepend':
this.unshift({ key, value })
break
default:
this.push({ key, value })
}
return this
}
values() {
return this.map((item) => item.value)
}
keys() {
return this.map((item) => item.key)
}
}
module.exports = ConfigList
webpacker-4.2.2/package/config_types/config_object.js 0000644 0001750 0001750 00000002231 13712041056 021720 0 ustar pravi pravi const objectify = require('../utils/objectify')
const deepAssign = require('../utils/deep_assign')
const deepMerge = require('../utils/deep_merge')
const { isStrPath, prettyPrint } = require('../utils/helpers')
/**
* @class
* @extends { Object }
*/
class ConfigObject extends Object {
constructor(props = {}) {
super()
this.merge(props)
}
get(key) {
return isStrPath(key) ? objectify(key, this) : this[key]
}
set(key, value) {
Object.assign(this, deepAssign(this, key, value))
return this
}
delete(key) {
let obj = this
let propKey = key
if (isStrPath(key)) {
const keys = key.split('.')
propKey = keys.pop()
const parentObjPath = keys.join('.')
obj = objectify(parentObjPath, this)
}
if (!obj) throw new Error(`Prop not found: ${key} in ${prettyPrint(obj)}`)
delete obj[propKey]
return this
}
toObject() {
const object = {}
/* eslint no-return-assign: 0 */
Object.keys(this).forEach((key) => (object[key] = this[key]))
return object
}
merge(config) {
Object.assign(this, deepMerge(this, config))
return this
}
}
module.exports = ConfigObject
webpacker-4.2.2/package/env.js 0000644 0001750 0001750 00000001261 13712041056 015226 0 ustar pravi pravi const { resolve } = require('path')
const { safeLoad } = require('js-yaml')
const { readFileSync } = require('fs')
const NODE_ENVIRONMENTS = ['development', 'production', 'test']
const DEFAULT = 'production'
const configPath = resolve('config', 'webpacker.yml')
const railsEnv = process.env.RAILS_ENV
const nodeEnv = process.env.NODE_ENV
const config = safeLoad(readFileSync(configPath), 'utf8')
const availableEnvironments = Object.keys(config).join('|')
const regex = new RegExp(`^(${availableEnvironments})$`, 'g')
module.exports = {
railsEnv: railsEnv && railsEnv.match(regex) ? railsEnv : DEFAULT,
nodeEnv: nodeEnv && NODE_ENVIRONMENTS.includes(nodeEnv) ? nodeEnv : DEFAULT
}
webpacker-4.2.2/.eslintrc.js 0000644 0001750 0001750 00000000457 13712041056 014752 0 ustar pravi pravi module.exports = {
'extends': 'airbnb',
'rules': {
'comma-dangle': ['error', 'never'],
'import/no-unresolved': 'off',
'import/no-extraneous-dependencies': 'off',
'import/extensions': 'off',
semi: ['error', 'never'],
},
'env': {
'browser': true,
'node': true,
},
};
webpacker-4.2.2/.eslintignore 0000644 0001750 0001750 00000000060 13712041056 015204 0 ustar pravi pravi lib/*
node_modules/*
vendor/*
**/__tests__/**/*
webpacker-4.2.2/README.md 0000644 0001750 0001750 00000054072 13712041056 013774 0 ustar pravi pravi # Webpacker
[](https://travis-ci.org/rails/webpacker)
[](https://nodejs.org/en/)
[](https://github.com/rails/webpacker)
Webpacker makes it easy to use the JavaScript pre-processor and bundler
[webpack 4.x.x+](https://webpack.js.org/)
to manage application-like JavaScript in Rails. It coexists with the asset pipeline,
as the primary purpose for webpack is app-like JavaScript, not images, CSS, or
even JavaScript Sprinkles (that all continues to live in app/assets).
However, it is possible to use Webpacker for CSS, images and fonts assets as well,
in which case you may not even need the asset pipeline. This is mostly relevant when exclusively using component-based JavaScript frameworks.
**NOTE:** The master branch now hosts the code for v4.x.x. Please refer to [3-x-stable](https://github.com/rails/webpacker/tree/3-x-stable) branch for 3.x documentation. See the [v4-upgrade guide](docs/v4-upgrade.md) for an overview of the changes.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Webpack Configuration](#webpack-configuration)
- [Custom Rails environments](#custom-rails-environments)
- [Upgrading](#upgrading)
- [Yarn Integrity](#yarn-integrity)
- [Integrations](#integrations)
- [React](#react)
- [Angular with TypeScript](#angular-with-typescript)
- [Vue](#vue)
- [Elm](#elm)
- [Stimulus](#stimulus)
- [Svelte](#svelte)
- [CoffeeScript](#coffeescript)
- [Erb](#erb)
- [Paths](#paths)
- [Resolved](#resolved)
- [Watched](#watched)
- [Deployment](#deployment)
- [Docs](#docs)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
* Ruby 2.2+
* Rails 4.2+
* Node.js 8.16.0+
* Yarn 1.x+
## Features
* [webpack 4.x.x](https://webpack.js.org/)
* ES6 with [babel](https://babeljs.io/)
* Automatic code splitting using multiple entry points
* Stylesheets - Sass and CSS
* Images and fonts
* PostCSS - Auto-Prefixer
* Asset compression, source-maps, and minification
* CDN support
* React, Angular, Elm and Vue support out-of-the-box
* Rails view helpers
* Extensible and configurable
## Installation
You can either add Webpacker during setup of a new Rails 5.1+ application
using new `--webpack` option:
```bash
# Available Rails 5.1+
rails new myapp --webpack
```
Or add it to your `Gemfile`:
```ruby
# Gemfile
gem 'webpacker', '~> 4.x'
# OR if you prefer to use master
gem 'webpacker', git: 'https://github.com/rails/webpacker.git'
yarn add https://github.com/rails/webpacker.git
yarn add core-js regenerator-runtime
```
Finally, run the following to install Webpacker:
```bash
bundle
bundle exec rails webpacker:install
# OR (on rails version < 5.0)
bundle exec rake webpacker:install
```
Optional: To fix ["unmet peer dependency" warnings](https://github.com/rails/webpacker/issues/1078),
```bash
yarn upgrade
```
### Usage
Once installed, you can start writing modern ES6-flavored JavaScript apps right away:
```yml
app/javascript:
├── packs:
│ # only webpack entry files here
│ └── application.js
└── src:
│ └── application.css
└── images:
└── logo.svg
```
In `/packs/application.js`, include this at the top of the file:
```js
import "core-js/stable";
import "regenerator-runtime/runtime";
```
You can then link the JavaScript pack in Rails views using the `javascript_pack_tag` helper.
If you have styles imported in your pack file, you can link them by using `stylesheet_pack_tag`:
```erb
<%= javascript_pack_tag 'application' %>
<%= stylesheet_pack_tag 'application' %>
```
If you want to link a static asset for `` or `
```
If you are using new webpack 4 split chunks API, then consider using `javascript_packs_with_chunks_tag` helper, which creates html
tags for a pack and all the dependent chunks.
```erb
<%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %>
```
**Important:** Pass all your pack names when using `javascript_packs_with_chunks_tag`
helper otherwise you will get duplicated chunks on the page.
```erb
<%# DO %>
<%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
<%# DON'T %>
<%= javascript_packs_with_chunks_tag 'calendar' %>
<%= javascript_packs_with_chunks_tag 'map' %>
```
**Note:** In order for your styles or static assets files to be available in your view,
you would need to link them in your "pack" or entry file.
### Development
Webpacker ships with two binstubs: `./bin/webpack` and `./bin/webpack-dev-server`.
Both are thin wrappers around the standard `webpack.js` and `webpack-dev-server.js`
executables to ensure that the right configuration files and environmental variables
are loaded based on your environment.
In development, Webpacker compiles on demand rather than upfront by default. This
happens when you refer to any of the pack assets using the Webpacker helper methods.
This means that you don't have to run any separate processes. Compilation errors are logged
to the standard Rails log.
If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run `./bin/webpack-dev-server` or `ruby ./bin/webpack-dev-server`. Windows users will need to run these commands
in a terminal separate from `bundle exec rails s`. This process will watch for changes
in the `app/javascript/packs/*.js` files and automatically reload the browser to match.
```bash
# webpack dev server
./bin/webpack-dev-server
# watcher
./bin/webpack --watch --colors --progress
# standalone build
./bin/webpack
```
Once you start this development server, Webpacker will automatically start proxying all
webpack asset requests to this server. When you stop the server, it'll revert back to
on-demand compilation.
You can use environment variables as options supported by
[webpack-dev-server](https://webpack.js.org/configuration/dev-server/) in the
form `WEBPACKER_DEV_SERVER_