shakapacker 8.1.0 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50df828db39af7e84673e9ab8bd4569d644084e428902d02084574b77db9bd8e
-  data.tar.gz: 6aac530ddb579fc7f92888a1e65282bbf69c98bc2773fcd27d77ec19671ec74d
+  metadata.gz: 85c3a527653e307cedc881f7879b245feaca4d79b47f7f7abac358f38a1e8305
+  data.tar.gz: eae6e26f151f0e6d346f9cef659854b91b7e0a4a3f388aa5cef016d6323f2c52
 SHA512:
-  metadata.gz: e6250e22762bd47aaf6dc0d2b93354bea65e3ca2e5d629177bec478495de3e6eaba5a458e3f0feda712bf08bf2b48f2f0a6f003baa6b2ffb354e49fb042e65d3
-  data.tar.gz: 45f445078b0d50f1eebc6d27f8a76ceeb3c8eb38cce4a4881562ab77d3a47f6e86d293f5c46a468a8fc4566bc217b39105cec85a78b5fdc1e77112c22a1d3ff8
+  metadata.gz: b04c921e57bb1fe74f9811d5e7cc9ba137600f9da55b906db3d51cc754533c7ed62f69bf9800172e07a2c4676a61bb13e0b939e12f25322c3065060a8c46d015
+  data.tar.gz: 870d7895ec05e62183f8958bae438b417b490df5c22d30f656a818d3e9c2747b8a16adb2f973bb0a6a36ac497ce4e725a7d2b139ece7ef1e96ac4171285673da

data/CHANGELOG.md

@@ -4,12 +4,30 @@
 * Please see the [v6 Upgrade Guide](./docs/v6_upgrade.md) to go from versions prior to v6.
 * [ShakaCode](https://www.shakacode.com) offers support for upgrading from Webpacker or using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com).
 
-_next_ branch is for v8 changes
-
-## Versions
+# Versions
 ## [Unreleased]
 Changes since the last non-beta release.
 
+## [v8.3.0] - April 25, 2025
+### Added
+
+- Allow `webpack-assets-manifest` v6. [PR 562](https://github.com/shakacode/shakapacker/pull/562) by [tagliala](https://github.com/tagliala), [shoeyn](https://github.com/shoeyn).
+
+### Changed
+
+- Instead of a fixed `core-js` version, take the current one from `node_modules` if available. [PR 556](https://github.com/shakacode/shakapacker/pull/556) by [alexeyr-ci2](https://github.com/alexeyr-ci2).
+- Require webpack >= 5.76.0 to reduce exposure to CVE-2023-28154. [PR 568](https://github.com/shakacode/shakapacker/pull/568) by [granowski](https://github.com/granowski).
+
+### Fixed
+
+- More precise types for `devServer` and `rules` in the configuration. [PR 555](https://github.com/shakacode/shakapacker/pull/555) by [alexeyr-ci2](https://github.com/alexeyr-ci2).
+
+## [v8.2.0] - March 12, 2025
+### Added
+
+- Support for `async` attribute in `javascript_pack_tag`, `append_javascript_pack_tag`, and `prepend_javascript_pack_tag`. [PR 554](https://github.com/shakacode/shakapacker/pull/554) by [AbanoubGhadban](https://github.com/abanoubghadban).
+- Allow `babel-loader` v10. [PR 552](https://github.com/shakacode/shakapacker/pull/552) by [shoeyn](https://github.com/shoeyn).
+
 ## [v8.1.0] - January 20, 2025
 
 ### Added
@@ -401,7 +419,9 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 ## v5.4.3 and prior changes from rails/webpacker
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md)
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v8.1.0...main
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v8.3.0...main
+[v8.3.0]: https://github.com/shakacode/shakapacker/compare/v8.2.0...v8.3.0
+[v8.2.0]: https://github.com/shakacode/shakapacker/compare/v8.1.0...v8.2.0
 [v8.1.0]: https://github.com/shakacode/shakapacker/compare/v8.0.2...v8.1.0
 [v8.0.2]: https://github.com/shakacode/shakapacker/compare/v8.0.1...v8.0.2
 [v8.0.1]: https://github.com/shakacode/shakapacker/compare/v8.0.0...v8.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (8.1.0)
+    shakapacker (8.3.0)
       activesupport (>= 5.2)
       package_json
       rack-proxy (>= 0.6.1)

data/README.md

@@ -275,7 +275,7 @@ You can provide multiple packs and other attributes. Note, `defer` defaults to s
 ```
 
 The resulting HTML would look like this:
-```
+```html
 <script src="/packs/vendor-16838bab065ae1e314.js" data-turbo-track="reload" defer></script>
 <script src="/packs/calendar~runtime-16838bab065ae1e314.js" data-turbo-track="reload" defer></script>
 <script src="/packs/calendar-1016838bab065ae1e314.js" data-turbo-track="reload" defer"></script>
@@ -287,6 +287,26 @@ In this output, both the calendar and map codes might refer to other common libr
 
 Note, the default of "defer" for the `javascript_pack_tag`. You can override that to `false`. If you expose jquery globally with `expose-loader,` by using `import $ from "expose-loader?exposes=$,jQuery!jquery"` in your `app/javascript/application.js`, pass the option `defer: false` to your `javascript_pack_tag`.
 
+The `javascript_pack_tag` also supports the `async` attribute, which you can enable by passing `async: true`:
+
+```erb
+<%= javascript_pack_tag 'application', async: true %>
+```
+
+This will generate script tags with the `async` attribute, which allows the browser to download and execute the script asynchronously without blocking HTML parsing:
+
+```html
+<script src="/packs/vendor-16838bab065ae1e314.js" async></script>
+<script src="/packs/application~runtime-16838bab065ae1e314.js" async></script>
+<script src="/packs/application-1016838bab065ae1e314.js" async></script>
+```
+
+Note that when using `async: true`, scripts may execute in any order as soon as they're downloaded, which could cause issues if your code has dependencies between files. In most cases, `defer` (the default) is preferred as it maintains execution order.
+
+> [!NOTE]
+>
+> When both `async` and `defer` attributes are specified, `async` takes precedence according to HTML5 specifications. So if you pass both `async: true` and `defer: true`, the script tag will use `async`.
+
 **Important:** Pass all your pack names as multiple arguments, not multiple calls, when using `javascript_pack_tag` and the `stylesheet_pack_tag`. Otherwise, you will get duplicated chunks on the page. 
 
 ```erb

data/gemfiles/Gemfile-rails.6.0.x

@@ -7,3 +7,4 @@ gem "rake", ">= 11.1"
 gem "rack-proxy", require: false
 gem "rspec-rails", "~> 5.0.0"
 gem "byebug"
+gem "concurrent-ruby", "1.3.4"

data/gemfiles/Gemfile-rails.6.1.x

@@ -9,3 +9,4 @@ gem "rake", ">= 11.1"
 gem "rack-proxy", require: false
 gem "rspec-rails", "~> 6.0.0"
 gem "byebug"
+gem "concurrent-ruby", "1.3.4"

data/gemfiles/Gemfile-rails.7.0.x

@@ -9,3 +9,4 @@ gem "rake", ">= 11.1"
 gem "rack-proxy", require: false
 gem "rspec-rails", "~> 7.0"
 gem "byebug"
+gem "concurrent-ruby", "1.3.4"

data/lib/shakapacker/helper.rb

@@ -95,22 +95,25 @@ module Shakapacker::Helper
   #
   #   <%= javascript_pack_tag 'calendar' %>
   #   <%= javascript_pack_tag 'map' %>
-  def javascript_pack_tag(*names, defer: true, **options)
+  def javascript_pack_tag(*names, defer: true, async: false, **options)
     if @javascript_pack_tag_loaded
       raise "To prevent duplicated chunks on the page, you should call javascript_pack_tag only once on the page. " \
       "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
     end
 
-    append_javascript_pack_tag(*names, defer: defer)
-    non_deferred = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:non_deferred], type: :javascript)
-    deferred = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:deferred], type: :javascript) - non_deferred
+    append_javascript_pack_tag(*names, defer: defer, async: async)
+    sync = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:sync], type: :javascript)
+    async = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:async], type: :javascript) - sync
+    deferred = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:deferred], type: :javascript) - sync - async
 
     @javascript_pack_tag_loaded = true
 
     capture do
-      concat javascript_include_tag(*deferred, **options.tap { |o| o[:defer] = true })
-      concat "\n" if non_deferred.any? && deferred.any?
-      concat javascript_include_tag(*non_deferred, **options.tap { |o| o[:defer] = false })
+      concat javascript_include_tag(*async, **options.dup.tap { |o| o[:async] = true })
+      concat "\n" if async.any? && deferred.any?
+      concat javascript_include_tag(*deferred, **options.dup.tap { |o| o[:defer] = true })
+      concat "\n" if sync.any? && deferred.any?
+      concat javascript_include_tag(*sync, **options)
     end
   end
 
@@ -179,27 +182,35 @@ module Shakapacker::Helper
     nil
   end
 
-  def append_javascript_pack_tag(*names, defer: true)
-    update_javascript_pack_tag_queue(defer: defer) do |hash_key|
+  def append_javascript_pack_tag(*names, defer: true, async: false)
+    update_javascript_pack_tag_queue(defer: defer, async: async) do |hash_key|
       javascript_pack_tag_queue[hash_key] |= names
     end
   end
 
-  def prepend_javascript_pack_tag(*names, defer: true)
-    update_javascript_pack_tag_queue(defer: defer) do |hash_key|
+  def prepend_javascript_pack_tag(*names, defer: true, async: false)
+    update_javascript_pack_tag_queue(defer: defer, async: async) do |hash_key|
       javascript_pack_tag_queue[hash_key].unshift(*names)
     end
   end
 
   private
 
-    def update_javascript_pack_tag_queue(defer:)
+    def update_javascript_pack_tag_queue(defer:, async:)
       if @javascript_pack_tag_loaded
         raise "You can only call #{caller_locations(1..1).first.base_label} before javascript_pack_tag helper. " \
         "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
       end
 
-      yield(defer ? :deferred : :non_deferred)
+      # When both async and defer are specified, async takes precedence per HTML5 spec
+      hash_key = if async
+        :async
+      elsif defer
+        :deferred
+      else
+        :sync
+      end
+      yield(hash_key)
 
       # prevent rendering Array#to_s representation when used with <%= … %> syntax
       nil
@@ -207,8 +218,9 @@ module Shakapacker::Helper
 
     def javascript_pack_tag_queue
       @javascript_pack_tag_queue ||= {
+        async: [],
         deferred: [],
-        non_deferred: []
+        sync: []
       }
     end
 

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "8.1.0".freeze
+  VERSION = "8.3.0".freeze
 end

data/package/babel/preset.js

@@ -1,5 +1,18 @@
-const { moduleExists } = require("shakapacker")
+const { moduleExists, packageFullVersion } = require("../utils/helpers")
 
+const coreJsVersion = () => {
+  try {
+    return packageFullVersion("core-js").match(/^\d+\.\d+/)[0]
+  } catch (e) {
+    if (e.code !== "MODULE_NOT_FOUND") {
+      throw e
+    }
+
+    return "3.8"
+  }
+}
+
+/** @param api {import("@babel/core").ConfigAPI} */
 module.exports = function config(api) {
   const validEnv = ["development", "test", "production"]
   const currentEnv = api.env()
@@ -9,9 +22,7 @@ module.exports = function config(api) {
 
   if (!validEnv.includes(currentEnv)) {
     throw new Error(
-      `Please specify a valid NODE_ENV or BABEL_ENV environment variable. Valid values are "development", "test", and "production". Instead, received: "${JSON.stringify(
-        currentEnv
-      )}".`
+      `Please specify a valid NODE_ENV or BABEL_ENV environment variable. Valid values are "development", "test", and "production". Instead, received: "${currentEnv}".`
     )
   }
 
@@ -22,7 +33,7 @@ module.exports = function config(api) {
         "@babel/preset-env",
         {
           useBuiltIns: "entry",
-          corejs: "3.8",
+          corejs: coreJsVersion(),
           modules: "auto",
           bugfixes: true,
           exclude: ["transform-typeof-symbol"]

data/package/environments/base.js

@@ -4,6 +4,7 @@
 const { existsSync, readdirSync } = require("fs")
 const { basename, dirname, join, relative, resolve } = require("path")
 const extname = require("path-complete-extname")
+// TODO: Change to `const { WebpackAssetsManifest }` when dropping 'webpack-assets-manifest < 6.0.0' (Node >=20.10.0) support
 const WebpackAssetsManifest = require("webpack-assets-manifest")
 const webpack = require("webpack")
 const rules = require("../rules")
@@ -72,10 +73,15 @@ const getModulePaths = () => {
   return result
 }
 
+// TODO: Remove WebpackAssetsManifestConstructor workaround when dropping 'webpack-assets-manifest < 6.0.0' (Node >=20.10.0) support
+const WebpackAssetsManifestConstructor =
+  "WebpackAssetsManifest" in WebpackAssetsManifest
+    ? WebpackAssetsManifest.WebpackAssetsManifest
+    : WebpackAssetsManifest
 const getPlugins = () => {
   const plugins = [
     new webpack.EnvironmentPlugin(process.env),
-    new WebpackAssetsManifest({
+    new WebpackAssetsManifestConstructor({
       entrypoints: true,
       writeToDisk: true,
       output: config.manifestPath,

data/package/index.d.ts

@@ -1,5 +1,6 @@
 declare module 'shakapacker' {
-  import { Configuration } from 'webpack'
+  import { Configuration, RuleSetRule } from 'webpack'
+  import * as https from 'node:https';
 
   export interface Config {
     source_path: string
@@ -32,12 +33,48 @@ declare module 'shakapacker' {
     runningWebpackDevServer: boolean
   }
 
+  type Header = Array<{ key: string; value: string }> | Record<string, string | string[]>
+  type ServerType = 'http' | 'https' | 'spdy'
+  type WebSocketType = 'sockjs' | 'ws'
+
+  /**
+   * This has the same keys and behavior as https://webpack.js.org/configuration/dev-server/ except:
+   * 1. `hot` is replaced by `hmr`;
+   * 2. Camel-cased properties are replaced by snake-cased ones.
+   * @see {import('webpack-dev-server').Configuration}
+   */
+  interface DevServerConfig {
+    allowed_hosts?: 'all' | 'auto' | string | string[]
+    bonjour?: boolean | Record<string, unknown> // bonjour.BonjourOptions
+    client?: Record<string, unknown> // Client
+    compress?: boolean
+    dev_middleware?: Record<string, unknown> // webpackDevMiddleware.Options
+    headers?: Header | (() => Header)
+    history_api_fallback?: boolean | Record<string, unknown> // HistoryApiFallbackOptions
+    hmr?: 'only' | boolean
+    host?: 'local-ip' | 'local-ipv4' | 'local-ipv6' | string
+    http2?: boolean
+    https?: boolean | https.ServerOptions
+    ipc?: boolean | string
+    magic_html?: boolean
+    live_reload?: boolean
+    open?: boolean | string | string[] | Record<string, unknown> | Record<string, unknown>[]
+    port?: 'auto' | string | number
+    proxy?: unknown // ProxyConfigMap | ProxyConfigArray
+    setup_exit_signals?: boolean
+    static?: boolean | string | unknown // Static | Array<string | Static>
+    watch_files?: string | string[] | unknown // WatchFiles | Array<WatchFiles | string>
+    web_socket_server?: string | boolean | WebSocketType | { type?: string | boolean | WebSocketType, options?: Record<string, unknown> }
+    server?: string | boolean | ServerType | { type?: string | boolean | ServerType, options?: https.ServerOptions }
+    [otherWebpackDevServerConfigKey: string]: unknown
+  }
+
   export const config: Config
-  export const devServer: Record<string, unknown>
+  export const devServer: DevServerConfig
   export function generateWebpackConfig(extraConfig?: Configuration): Configuration
   export const baseConfig: Configuration
   export const env: Env
-  export const rules: Record<string, unknown>
+  export const rules: RuleSetRule[]
   export function moduleExists(packageName: string): boolean
   export function canProcess<T = unknown>(rule: string, fn: (modulePath: string) => T): T | null
   export const inliningCss: boolean

data/package/rules/index.js

@@ -1,20 +1,16 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const rules = {
-  raw: require("./raw"),
-  file: require("./file"),
-  css: require("./css"),
-  sass: require("./sass"),
-  babel: require("./babel"),
-  swc: require("./swc"),
-  esbuild: require("./esbuild"),
-  erb: require("./erb"),
-  coffee: require("./coffee"),
-  less: require("./less"),
-  stylus: require("./stylus")
-}
-
-module.exports = Object.keys(rules)
-  .filter((key) => !!rules[key])
-  .map((key) => rules[key])
+module.exports = [
+  require("./raw"),
+  require("./file"),
+  require("./css"),
+  require("./sass"),
+  require("./babel"),
+  require("./swc"),
+  require("./esbuild"),
+  require("./erb"),
+  require("./coffee"),
+  require("./less"),
+  require("./stylus")
+].filter(Boolean)

data/package/utils/helpers.js

@@ -41,18 +41,22 @@ const loaderMatches = (configLoader, loaderToCheck, fn) => {
   return fn()
 }
 
-const packageMajorVersion = (packageName) => {
+const packageFullVersion = (packageName) => {
   // eslint-disable-next-line import/no-dynamic-require
   const packageJsonPath = require.resolve(`${packageName}/package.json`)
   // eslint-disable-next-line import/no-dynamic-require, global-require
-  return require(packageJsonPath).version.match(/^\d+/)[0]
+  return require(packageJsonPath).version
 }
 
+const packageMajorVersion = (packageName) =>
+  packageFullVersion(packageName).match(/^\d+/)[0]
+
 module.exports = {
   isBoolean,
   ensureTrailingSlash,
   canProcess,
   moduleExists,
   loaderMatches,
+  packageFullVersion,
   packageMajorVersion
 }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "8.1.0",
+  "version": "8.3.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {
@@ -33,18 +33,18 @@
     "eslint": "^8.0.0",
     "eslint-config-airbnb": "^19.0.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-react": "^7.26.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.2.6",
+    "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "jest": "^28.1.3",
+    "jest": "^29.7.0",
     "memory-fs": "^0.5.0",
     "prettier": "^3.2.5",
     "swc-loader": "^0.1.15",
     "thenify": "^3.3.1",
-    "webpack": "^5.72.0",
+    "webpack": "5.93.0",
     "webpack-assets-manifest": "^5.0.6",
     "webpack-merge": "^5.8.0"
   },
@@ -55,11 +55,11 @@
     "@babel/runtime": "^7.17.9",
     "@types/babel__core": "^7.0.0",
     "@types/webpack": "^5.0.0",
-    "babel-loader": "^8.2.4 || ^9.0.0",
+    "babel-loader": "^8.2.4 || ^9.0.0 || ^10.0.0",
     "compression-webpack-plugin": "^9.0.0 || ^10.0.0|| ^11.0.0",
     "terser-webpack-plugin": "^5.3.1",
-    "webpack": "^5.72.0",
-    "webpack-assets-manifest": "^5.0.6",
+    "webpack": "^5.76.0",
+    "webpack-assets-manifest": "^5.0.6 || ^6.0.0",
     "webpack-cli": "^4.9.2 || ^5.0.0 || ^6.0.0",
     "webpack-dev-server": "^4.9.0 || ^5.0.0",
     "webpack-merge": "^5.8.0 || ^6.0.0"

data/test/helpers.js

@@ -9,7 +9,7 @@ const createTrackLoader = () => {
     filesTracked,
     (source) => {
       filesTracked[source.resource] = true
-      return source
+      return "" // Fix #567
     }
   ]
 }