shakapacker 6.1.0.beta.0 → 6.2.0

data/package/environments/base.js

@@ -54,7 +54,7 @@ const getPlugins = () => {
     new WebpackAssetsManifest({
       entrypoints: true,
       writeToDisk: true,
-      output: 'manifest.json',
+      output: config.manifestPath,
       entrypointsUseAssets: true,
       publicPath: true
     })

data/package/esbuild/index.js

@@ -0,0 +1,40 @@
+/* eslint global-require: 0 */
+/* eslint import/no-dynamic-require: 0 */
+
+const { resolve } = require('path')
+const { existsSync } = require('fs')
+const { merge } = require('webpack-merge')
+
+const getLoaderExtension = (filename) => {
+  const matchData = filename.match(/\.([jt]sx?)?(\.erb)?$/)
+
+  if (!matchData) {
+    return 'js'
+  }
+
+  return matchData[1]
+}
+
+const getCustomConfig = () => {
+  const path = resolve('config', 'esbuild.config.js')
+  if (existsSync(path)) {
+    return require(path)
+  }
+  return {}
+}
+
+const getEsbuildLoaderConfig = (filenameToProcess) => {
+  const customConfig = getCustomConfig()
+  const defaultConfig = {
+    loader: require.resolve('esbuild-loader'),
+    options: {
+      loader: getLoaderExtension(filenameToProcess)
+    }
+  }
+
+  return merge(defaultConfig, customConfig)
+}
+
+module.exports = {
+  getEsbuildLoaderConfig
+}

data/package/inliningCss.js

@@ -2,6 +2,6 @@ const { runningWebpackDevServer } = require('./env')
 const devServer = require('./dev_server')
 
 // This logic is tied to lib/webpacker/instance.rb
-const inliningCss = runningWebpackDevServer && devServer.hmr
+const inliningCss = runningWebpackDevServer && devServer.hmr && devServer.inline_css !== false
 
 module.exports = inliningCss

data/package/rules/__tests__/file.js

@@ -0,0 +1,35 @@
+const file = require('../file')
+
+describe('file', () => {
+  test('test expected file types', () => {
+    const types = [
+      '.bmp',
+      '.gif',
+      '.jpg',
+      '.jpeg',
+      '.png',
+      '.tiff',
+      '.ico',
+      '.avif',
+      '.webp',
+      '.eot',
+      '.otf',
+      '.ttf',
+      '.woff',
+      '.woff2',
+      '.svg',
+    ]
+    types.forEach(type => expect(file.test.test(type)).toBe(true))
+  })
+
+  test('exclude expected file types', () => {
+    const types = [
+      '.js',
+      '.mjs',
+      '.jsx',
+      '.ts',
+      '.tsx',
+    ]
+    types.forEach(type => expect(file.exclude.test(type)).toBe(true))
+  })
+})

data/package/rules/__tests__/index.js

@@ -0,0 +1,11 @@
+const rules = require('../index')
+
+describe('index', () => {
+  test('rule tests are regexes', () => {
+    rules.forEach(rule => expect(rule.test instanceof RegExp).toBe(true))
+  })
+
+  test('rule excludes are regexes', () => {
+    rules.forEach(rule => expect(rule.exclude instanceof RegExp).toBe(true))
+  })
+})

data/package/rules/__tests__/raw.js

@@ -0,0 +1,18 @@
+const raw = require('../raw')
+
+describe('raw', () => {
+  test('test expected file types', () => {
+    expect(raw.test.test('.html')).toBe(true)
+  })
+
+  test('exclude expected file types', () => {
+    const types = [
+      '.js',
+      '.mjs',
+      '.jsx',
+      '.ts',
+      '.tsx',
+    ]
+    types.forEach(type => expect(raw.exclude.test(type)).toBe(true))
+  })
+})

data/package/rules/esbuild.js

@@ -0,0 +1,23 @@
+const { resolve } = require('path')
+const { realpathSync } = require('fs')
+const { loaderMatches } = require('../utils/helpers')
+const { getEsbuildLoaderConfig } = require('../esbuild')
+
+const {
+  source_path: sourcePath,
+  additional_paths: additionalPaths,
+  webpack_loader: webpackLoader
+} = require('../config')
+
+module.exports = loaderMatches(webpackLoader, 'esbuild', () => ({
+  test: /\.(ts|tsx|js|jsx|mjs|coffee)?(\.erb)?$/,
+  include: [sourcePath, ...additionalPaths].map((p) => {
+    try {
+      return realpathSync(p)
+    } catch (e) {
+      return resolve(p)
+    }
+  }),
+  exclude: /node_modules/,
+  use: ({ resource }) => getEsbuildLoaderConfig(resource)
+}))

data/package/rules/file.js

@@ -1,23 +1,19 @@
+const { dirname, join } = require('path')
+const { source_path: sourcePath } = require('../config')
+
 module.exports = {
-  test: [
-    /\.bmp$/,
-    /\.gif$/,
-    /\.jpe?g$/,
-    /\.png$/,
-    /\.tiff$/,
-    /\.ico$/,
-    /\.avif$/,
-    /\.webp$/,
-    /\.eot$/,
-    /\.otf$/,
-    /\.ttf$/,
-    /\.woff$/,
-    /\.woff2$/,
-    /\.svg$/
-  ],
-  exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+  test: /\.(bmp|gif|jpe?g|png|tiff|ico|avif|webp|eot|otf|ttf|woff|woff2|svg)$/,
+  exclude: /\.(js|mjs|jsx|ts|tsx)$/,
   type: 'asset/resource',
   generator: {
-    filename: 'static/[name]-[hash][ext][query]'
+    filename: (pathData) => {
+      const folders = dirname(pathData.filename)
+        .replace(`${sourcePath}/`, '')
+        .split('/')
+        .slice(1)
+
+      const foldersWithStatic = join('static', ...folders)
+      return `${foldersWithStatic}/[name]-[hash][ext][query]`
+    }
   }
 }

data/package/rules/index.js

@@ -8,6 +8,7 @@ const rules = {
   sass: require('./sass'),
   babel: require('./babel'),
   swc: require('./swc'),
+  esbuild: require('./esbuild'),
   erb: require('./erb'),
   coffee: require('./coffee'),
   less: require('./less'),

data/package/rules/raw.js

@@ -1,5 +1,5 @@
 module.exports = {
-  test: [/\.html$/],
-  exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+  test: /\.html$/,
+  exclude: /\.(js|mjs|jsx|ts|tsx)$/,
   type: 'asset/source'
 }

data/package/swc/index.js

@@ -30,12 +30,12 @@ const getSwcLoaderConfig = (filenameToProcess) => {
             : 'ecmascript',
           [isTypescriptFile(filenameToProcess) ? 'tsx' : 'jsx']:
             isJsxFile(filenameToProcess)
-        }
+        },
+        loose: true
       },
       sourceMaps: true,
       env: {
-        coreJs: '3.8',
-        loose: true,
+        coreJs: 3,
         exclude: ['transform-typeof-symbol'],
         mode: 'entry'
       }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.1.0-beta.0",
+  "version": "6.2.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -32,6 +32,7 @@
   "devDependencies": {
     "babel-loader": "^8.2.2",
     "compression-webpack-plugin": "^9.0.0",
+    "esbuild-loader": "^2.18.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-config-prettier": "^8.3.0",

data/test/configuration_test.rb

@@ -38,9 +38,18 @@ class ConfigurationTest < Webpacker::Test
     assert_equal @config.public_output_path.to_s, public_output_path
   end
 
-  def test_public_manifest_path
-    public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
-    assert_equal @config.public_manifest_path.to_s, public_manifest_path
+  def test_manifest_path
+    manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+    assert_equal @config.manifest_path.to_s, manifest_path
+
+    @config = Webpacker::Configuration.new(
+      root_path: @config.root_path,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_manifest_path.yml", __dir__)),
+      env: "production"
+    )
+
+    manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "manifest.json").to_s
+    assert_equal @config.manifest_path.to_s, manifest_path
   end
 
   def test_cache_path
@@ -75,4 +84,16 @@ class ConfigurationTest < Webpacker::Test
       assert Webpacker.config.compile?
     end
   end
+
+  def test_ensure_consistent_versioning?
+    refute @config.ensure_consistent_versioning?
+
+    with_rails_env("development") do
+      assert Webpacker.config.ensure_consistent_versioning?
+    end
+
+    with_rails_env("test") do
+      refute Webpacker.config.ensure_consistent_versioning?
+    end
+  end
 end

data/test/fixtures/beta_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "6.0.0-beta.1"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/git_url_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "git://github.com/shakapacker/shakapacker.git"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/github_url_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "shakapacker/shakapacker#feature\/branch"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/normal_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "6.0.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/relative_path_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "../shakapacker"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/semver_caret_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "^6.0.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/semver_tilde_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "~6.0.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/without_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "left-pad": "1.0.2"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/helper_test.rb

@@ -14,7 +14,6 @@ class HelperTest < ActionView::TestCase
     end.new
 
     @javascript_pack_tag_loaded = nil
-    @stylesheet_pack_tag_loaded = nil
   end
 
   def test_asset_pack_path
@@ -149,19 +148,19 @@ class HelperTest < ActionView::TestCase
   end
 
   def hello_stimulus_stylesheet_chunks
-    %w[/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css]
+    %w[/packs/1-c20632e7baf2c81200d3.chunk.css /packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css]
   end
 
   def test_stylesheet_pack_tag
     assert_equal \
-      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks)
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq
         .map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stylesheet_pack_tag("application", "hello_stimulus")
   end
 
   def test_stylesheet_pack_tag_symbol
     assert_equal \
-      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks)
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq
         .map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stylesheet_pack_tag(:application, :hello_stimulus)
   end
@@ -172,15 +171,16 @@ class HelperTest < ActionView::TestCase
       stylesheet_pack_tag("application", media: "all")
   end
 
-  def test_stylesheet_pack_tag_multiple_invocations
-    error = assert_raises do
-      stylesheet_pack_tag(:application)
-      stylesheet_pack_tag(:hello_stimulus)
-    end
+  def test_stylesheet_pack_tag_multiple_invocations_are_allowed
+    app_style = stylesheet_pack_tag(:application)
+    stimulus_style = stylesheet_pack_tag(:hello_stimulus)
 
     assert_equal \
-      "To prevent duplicated chunks on the page, you should call stylesheet_pack_tag only once on the page. " +
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide",
-      error.message
+      application_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      app_style
+
+    assert_equal \
+      hello_stimulus_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      stimulus_style
   end
 end

data/test/test_app/config/webpacker.yml

@@ -9,6 +9,9 @@ default: &default
   webpack_compile_output: false
   webpack_loader: babel
 
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
   # Additional paths webpack should look up modules
   # ['app/assets', 'engine/foo/app/assets']
   additional_paths:
@@ -36,6 +39,7 @@ default: &default
 development:
   <<: *default
   compile: true
+  ensure_consistent_versioning: true
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:

data/test/test_app/config/webpacker_manifest_path.yml

@@ -0,0 +1,80 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/packs
+  source_entry_path: entrypoints
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  webpack_compile_output: false
+
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  manifest_path: app/packs/manifest.json
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+    - some.config.js
+    - app/elm
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging