shakapacker 7.2.3 → 8.0.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5968b3bebbc2447a2aa26ecdef02b4bd96e593d9f04b30fdcf33415b2e674e64
-  data.tar.gz: fe48b75ef65f90b2df1a78c76530ffe265228d048da91f5cbbdd038aac10ca11
+  metadata.gz: ec98bf8d86496333c62b85cc9abbb31f44bdfb4844d64c65d7faf1bec76c8003
+  data.tar.gz: 3b05acd544a8cb23d74c641ee746385260eb5c0708b9af230dc1c813c7c9977c
 SHA512:
-  metadata.gz: eb4c1b9f91d5c60d03bb71deeff4d42a6746261f0ea8d5013f60f0b8a343a9d3758db097a863abce1027496634e0677355f56ac1726a270e5b3a9ac88ec5dc9c
-  data.tar.gz: 96d1279afa3d03a145ab537e1e1f4357e14567fd3c9855dba36d37fff88efc6e20b261063e7c075455cf038ad504981da51b5446e5004485ebf66c134735aeeb
+  metadata.gz: f9174d503f9e8dc6447c124dd236c3b65a66f23b780cea48e46e8921c5c4bcbcc0f5b75165175cd19f8177edce67e6c49128de58631272edcbecf5eb0431a13f
+  data.tar.gz: 2f8c44e24add0bc1930f2d6dbb58d20f6f5f82efbd0ffdf245b8ce85da4c4fa7c7d9dab07fc6d60f6709265b4e2ed23e0194040d8cba6c60cd62ef92e4e16d8e

data/.eslintignore

@@ -1,4 +1,4 @@
 lib/*
 node_modules/*
 vendor/*
-**/__tests__/**/*
+spec/*

data/.eslintrc.js

@@ -1,15 +1,36 @@
 module.exports = {
-  extends: ['airbnb', 'prettier'],
+  extends: ["airbnb", "plugin:prettier/recommended"],
   rules: {
-    'comma-dangle': ['error', 'never'],
-    'import/no-unresolved': 'off',
-    'import/no-extraneous-dependencies': 'off',
-    'import/extensions': 'off',
-    "indent": ["error", 2],
-    semi: ['error', 'never']
+    "import/no-unresolved": "off",
+    "import/no-extraneous-dependencies": "off",
+    "import/extensions": "off",
+    indent: ["error", 2]
   },
   env: {
     browser: true,
     node: true
-  }
+  },
+  overrides: [
+    {
+      files: ["test/**"],
+      extends: ["plugin:jest/recommended", "plugin:jest/style"],
+      rules: {
+        "global-require": "off",
+        "jest/prefer-called-with": "error",
+        "jest/no-conditional-in-test": "error",
+        "jest/no-test-return-statement": "error",
+        "jest/prefer-expect-resolves": "error",
+        "jest/require-to-throw-message": "error",
+        "jest/require-top-level-describe": "error",
+        "jest/prefer-hooks-on-top": "error",
+        "jest/prefer-lowercase-title": [
+          "error",
+          { ignoreTopLevelDescribe: true }
+        ],
+        "jest/prefer-spy-on": "error",
+        "jest/prefer-strict-equal": "error",
+        "jest/prefer-todo": "error"
+      }
+    }
+  ]
 }

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,13 @@
 ### Summary
 
-_Remove this paragraph and describe the code changes in your pull request... were there any bugs you had fixed? If so, mention them. If these bugs have open GitHub issues, tag them here as well to keep the conversation linked._
+<!--
+  Describe the code changes in your pull request here - were there any bugs you had fixed, features you added, tradeoffs you made?
+  If so, mention them. If these changes have open GitHub issues, tag them here as well to keep the conversation linked.
+-->
 
 ### Pull Request checklist
-_Remove this line after checking all the items here. If the item does not apply to the PR, both check it out and wrap it by `~`._
+
+<!-- If any of the items on this checklist do not apply to the PR, both check it out and wrap it by `~`. -->
 
 - [ ] Add/update test to cover these changes
 - [ ] Update documentation
@@ -11,4 +15,7 @@ _Remove this line after checking all the items here. If the item does not apply
 
 ### Other Information
 
-_Remove this paragraph and mention other important and relevant information, such as benchmarks._
+<!--
+  Mention any other important information that might relate to this PR but that don't belong in the summary,
+  like detailed benchmarks or possible follow-up changes.
+-->

data/.github/workflows/dummy.yml

@@ -4,9 +4,13 @@ on:
   push:
     branches:
       - 'main'
-      - 'next'
   pull_request:
 
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest

data/.github/workflows/generator.yml

@@ -4,9 +4,13 @@ on:
   push:
     branches:
       - 'main'
-      - 'next'
   pull_request:
 
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     name: Generator specs
@@ -14,22 +18,21 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ruby: ['2.6', '2.7', '3.0']
-        use_package_json_gem: ['true', 'false']
+        ruby: ['2.7', '3.0', '3.1', '3.2']
         gemfile:
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
           - gemfiles/Gemfile-rails.7.0.x
+          - gemfiles/Gemfile-rails.7.1.x
           # Uncomment the following line only to ensure compatibility with the
           # upcomming Rails versions, maybe before a release.
           #- gemfiles/Gemfile-rails-edge
         exclude:
-          - ruby: 2.6
-            os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails.7.0.x
-          - ruby: 2.6
-            os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails-edge
+          - ruby: '3.1'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
+          - ruby: '3.2'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
+
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
@@ -40,13 +43,5 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      # Bundler 2.5.0 dropped support for Ruby 2.6 and 2.7
-      - name: Use Bundler 2.4.22
-        run: |
-          gem install bundler -v '2.4.22'
-          bundle config --local path vendor/bundle
-      - name: Install dependencies
-        run: bundle install
+          bundler-cache: true
       - run: bundle exec rake run_spec:generator
-        env:
-          SHAKAPACKER_USE_PACKAGE_JSON_GEM: ${{ matrix.use_package_json_gem }}

data/.github/workflows/node.yml

@@ -0,0 +1,56 @@
+name: Node based checks
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --non-interactive --prefer-offline
+
+      - name: Node eslint
+        run: yarn lint
+  test:
+    name: Testing
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [14.x, 16.x, 18.x, 20.x]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --non-interactive --prefer-offline
+
+      - name: Jest Specs
+        run: yarn test

data/.github/workflows/ruby.yml

@@ -1,34 +1,52 @@
-name: Ruby specs
+name: Ruby based checks
 
 on:
   push:
     branches:
       - 'main'
-      - 'next'
   pull_request:
 
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Ruby rubocop
+        run: bundle exec rubocop
+
   test:
-    name: Ruby specs
+    name: Testing
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ruby: ['2.6', '2.7', '3.0']
+        ruby: ['2.7', '3.0', '3.1', '3.2']
         gemfile:
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
           - gemfiles/Gemfile-rails.7.0.x
+          - gemfiles/Gemfile-rails.7.1.x
           # Uncomment the following line only to ensure compatibility with the
           # upcomming Rails versions, maybe before a release.
           #- gemfiles/Gemfile-rails-edge
         exclude:
-          - ruby: 2.6
-            os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails.7.0.x
-          - ruby: 2.6
-            os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails-edge
+          - ruby: '3.1'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
+          - ruby: '3.2'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
@@ -44,10 +62,3 @@ jobs:
 
       - name: Ruby specs
         run: bundle exec rake run_spec:gem
-        env:
-          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "false"
-
-      - name: Ruby specs
-        run: bundle exec rake run_spec:gem
-        env:
-          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "true"

data/.rubocop.yml

@@ -1,5 +1,6 @@
 require: rubocop-performance
 AllCops:
+  TargetRubyVersion: 2.7
   # 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

data/CHANGELOG.md

@@ -1,15 +1,65 @@
 * For the changelog of versions prior to v6, see the [5.x stable branch of rails/webpacker](https://github.com/rails/webpacker/tree/5-x-stable).
+* Please see the [v8 Upgrade Guide](./docs/v8_upgrade.md) for upgrading to version 8 and accounting for breaking changes.
 * Please see the [v7 Upgrade Guide](./docs/v7_upgrade.md) for upgrading to new spelling in version 7.
 * 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
 ## [Unreleased]
 Changes since the last non-beta release.
 
+### Breaking changes
+- Remove `relative_url_root` [PR 413](https://github.com/shakacode/shakapacker/pull/413) by [G-Rath](https://github.com/g-rath).
+
+- Removes deprecated support of `Webpacker` spelling, config variables and constants. [PR 429](https://github.com/shakacode/shakapacker/pull/429) by [tomdracz](https://github.com/tomdracz).
+
+  The usage of those has been deprecated in Shakapacker v7 and now fully removed in v8. See the [v7 Upgrade Guide](./docs/v7_upgrade.md) for more information if you are still yet to address this deprecation.
+
+- Remove `globalMutableWebpackConfig` global [PR 439](https://github.com/shakacode/shakapacker/pull/439) by [G-Rath](https://github.com/g-rath).
+
+  Use `generateWebpackConfig` instead.
+
+- Use `package_json` gem to manage Node dependencies and commands, and use `npm` by default [PR 430](https://github.com/shakacode/shakapacker/pull/430) by [G-Rath](https://github.com/g-rath)
+
+  This enables support for package managers other than `yarn`, with `npm` being the default; to continue using Yarn,
+  specify it in `package.json` using the [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property.
+
+- Remove `yarn_install` rake task, and stop installing js packages automatically as part of `assets:precompile` [PR 412](https://github.com/shakacode/shakapacker/pull/412) by [G-Rath](https://github.com/g-rath).
+
+- Remove `check_yarn` rake task [PR 443](https://github.com/shakacode/shakapacker/pull/443) by [G-Rath](https://github.com/g-rath).
+
+- Remove `https` option for `webpack-dev-server` [PR 414](https://github.com/shakacode/shakapacker/pull/414) by [G-Rath](https://github.com/g-rath).
+
+- Remove `verify_file_existance` method [PR 446](https://github.com/shakacode/shakapacker/pull/446) by [G-Rath](https://github.com/g-rath).
+
+- Drop support for Ruby 2.6 [PR 415](https://github.com/shakacode/shakapacker/pull/415) by [G-Rath](https://github.com/g-rath).
+
+- Drop support for Node v12 [PR 431](https://github.com/shakacode/shakapacker/pull/431) by [G-Rath](https://github.com/g-rath).
+
+- Enable `ensure_consistent_versioning` by default [PR 447](https://github.com/shakacode/shakapacker/pull/447) by [G-Rath](https://github.com/g-rath).
+
+- Asset files put in `additional_paths` will have their path stripped just like with the `source_path`. [PR 403](https://github.com/shakacode/shakapacker/pull/403) by [paypro-leon](https://github.com/paypro-leon).
+
+- Remove `isArray` utility (just use `Array.isArray` directly) and renamed a few files [PR 454](https://github.com/shakacode/shakapacker/pull/454) by [G-Rath](https://github.com/g-rath).
+
+- Make JavaScript test helper utilities internal (`chdirTestApp`, `chdirCwd`, `resetEnv`)  [PR 458](https://github.com/shakacode/shakapacker/pull/458) by [G-Rath](https://github.com/g-rath).
+
+## [v7.2.3] - March 23, 2024
+
+### Added
 - Emit warnings instead of errors when compilation is success but stderr is not empty. [PR 416](https://github.com/shakacode/shakapacker/pull/416) by [n-rodriguez](https://github.com/n-rodriguez).
 - Allow `webpack-dev-server` v5. [PR 418](https://github.com/shakacode/shakapacker/pull/418) by [G-Rath](https://github.com/g-rath)
 
+### Removed
+- Removes dependency on `glob` library. [PR 435](https://github.com/shakacode/shakapacker/pull/435) by [tomdracz](https://github.com/tomdracz).
+
+### Fixed
+- Uses config file passed in `SHAKAPACKER_CONFIG` consistently.[PR 448](https://github.com/shakacode/shakapacker/pull/448) by [tomdracz](https://github.com/tomdracz).
+
+   Previously this could have been ignored in few code branches, especially when checking for available environments.
+
 ## [v7.2.2] - January 19, 2024
 
 ### Added
@@ -303,7 +353,8 @@ 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/v7.2.2...main
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v7.2.3...main
+[v7.2.3]: https://github.com/shakacode/shakapacker/compare/v7.2.2...v7.2.3
 [v7.2.2]: https://github.com/shakacode/shakapacker/compare/v7.2.1...v7.2.2
 [v7.2.1]: https://github.com/shakacode/shakapacker/compare/v7.2.0...v7.2.1
 [v7.2.0]: https://github.com/shakacode/shakapacker/compare/v7.1.0...v7.2.0

data/README.md

@@ -1,8 +1,9 @@
-# Shakapacker (v7)
+# Shakapacker (v8)
 
 _Official, actively maintained successor to [rails/webpacker](https://github.com/rails/webpacker).ShakaCode stands behind the long-term maintenance and development of this project for the Rails community._
 
 * ⚠️ See the [6-stable](https://github.com/shakacode/shakapacker/tree/6-stable) branch for Shakapacker v6.x code and documentation. :warning:
+* See [V8 Upgrade](./docs/v8_upgrade.md) for upgrading from the v7 release.
 * See [V7 Upgrade](./docs/v7_upgrade.md) for upgrading from the v6 release.
 * See [V6 Upgrade](./docs/v6_upgrade.md) for upgrading from v5 or prior v6 releases.
 
@@ -51,8 +52,6 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
     - [Optional support](#optional-support)
   - [Installation](#installation)
     - [Rails v6+](#rails-v6)
-    - [Using alternative package managers](#using-alternative-package-managers)
-    - [Note for Yarn v2 usage](#note-for-yarn-v2-usage)
   - [Concepts](#concepts)
   - [Usage](#usage)
     - [Configuration and Code](#configuration-and-code)
@@ -98,16 +97,16 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
 
 ## Prerequisites
 
-- Ruby 2.6+
+- Ruby 2.7+
 - Rails 5.2+
-- Node.js 12.13.0+ || 14+
-- Yarn
+- Node.js 14+
 
 ## Features
 - Rails view helpers that fully support Webpack output, including HMR and code splitting.
 - Convenient but not required webpack configuration. The only requirement is that your webpack configuration creates a manifest.
 - HMR with the `shakapacker-dev-server`, such as for hot-reloading React!
 - Automatic code splitting using multiple entry points to optimize JavaScript downloads.
+- Support for [NPM](https://www.npmjs.com/package/npm), Yarn ([classic](https://classic.yarnpkg.com/lang/en/) and [berry](https://yarnpkg.com/getting-started)), [PNPM](https://pnpm.io/), and [Bun](https://bun.sh/)
 - [Webpack v5+](https://webpack.js.org/)
 - ES6 with [babel](https://babeljs.io/), [SWC](https://swc.rs/), or [Esbuild](https://github.com/privatenumber/esbuild-loader)
 - Asset compression, source-maps, and minification
@@ -147,40 +146,45 @@ Then run the following to install Shakapacker:
 
 Before initiating the installation process, ensure you have committed all the changes. While installing Shakapacker, there might be some conflict between the existing file content and what Shakapacker tries to copy. You can either approve all the prompts for overriding these files or use the `FORCE=true` environment variable before the installation command to force the override without any prompt.
 
-When `package.json` and/or `yarn.lock` changes, such as when pulling down changes to your local environment in team settings, be sure to keep your NPM packages up-to-date:
+Shakapacker uses the [`package_json`](https://github.com/shakacode/package_json) gem to handle updating the `package.json` and interacting with the underlying package manager of choice for managing dependencies and running commands; the package manager is managed using the [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property in the `package.json`, otherwise falling back to the value of `PACKAGE_JSON_FALLBACK_MANAGER` if set or otherwise `npm`.
 
-```bash
-yarn
-```
-
-Note, in v6+, most JS packages are peer dependencies. Thus, the installer will add the packages:
-
-```bash
-yarn add @babel/core @babel/plugin-transform-runtime @babel/preset-env @babel/runtime babel-loader \
-  compression-webpack-plugin terser-webpack-plugin \
-  webpack webpack-assets-manifest webpack-cli webpack-merge webpack-sources webpack-dev-server
-```
-
-Previously, these "webpack" and "babel" packages were direct dependencies for `shakapacker`. By
-making these peer dependencies, you have control over the versions used in your webpack and babel configs.
-
-### Using alternative package managers
-
-There is experimental support for using package managers besides Yarn classic for managing JavaScript dependencies using the [`package_json`](https://github.com/G-Rath/package_json) gem.
+If `packageManager` is not set when running `shakapacker:install`, Shakapacker will set it based on the lockfile and the result of calling `--version` on the inferred manager; if no lockfile is present, then `npm` be used unless you choose to explicitly set the `PACKAGE_JSON_FALLBACK_MANAGER` to your preferred package manager.
 
-This can be enabled by setting the environment variable `SHAKAPACKER_USE_PACKAGE_JSON_GEM` to `true`; Shakapacker will then use the `package_json` gem which in turn will look for the [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property in the `package.json` or otherwise the `PACKAGE_JSON_FALLBACK_MANAGER` environment variable to determine which manager to use, defaulting to `npm` if neither are found.
+> **Note**
+>
+> The `packageManager` property is only used to determine the package manager to use, based primarily on its name.
+> The version (if present) is only used to determine if Yarn Classic or Yarn Berry should be used, but is otherwise
+> _not_ checked, nor is [`corepack`](https://nodejs.org/api/corepack.html) used to ensure that the package manager is installed.
+>
+> It is up to the developer to ensure that the desired package manager is actually install at the right version, which can be done
+> using `corepack` or by other means.
 
 See [here](https://github.com/G-Rath/package_json#specifying-a-package-manager) for a list of the supported package managers and more information; note that `package_json` does not handle ensuring the manager is installed.
 
-> **Note**
-> 
-> The rest of the documentation assumes that `package_json` is not being used, and so always references `yarn` - you should instead use the package manager of your choice for these commands.  
+> [NOTE]
+>
+> The rest of the documentation will only reference `npm` when providing commands such as to install optional packages except in cases where
+> a particular package manager requires a very different command; otherwise it should be safe to just replace `npm` with the name of your 
+> preferred package manager when running the command
 
-### Note for Yarn v2 usage
+Note, in v6+, most JS packages are peer dependencies. Thus, the installer will add the packages:
 
-If you are using Yarn v2 (berry), please note that PnP modules are not supported unless you're using `SHAKAPACKER_USE_PACKAGE_JSON_GEM`.
+- `@babel/core`
+- `@babel/plugin-transform-runtime`
+- `@babel/preset-env`
+- `@babel/runtime`
+- `babel-loader`
+- `compression-webpack-plugin`
+- `terser-webpack-plugin`
+- `webpack`
+- `webpack-assets-manifest`
+- `webpack-cli`
+- `webpack-merge`
+- `webpack-sources`
+- `webpack-dev-server`
 
-To use Shakapacker with Yarn v2, make sure you set `nodeLinker: node-modules` in your `.yarnrc.yml` file as per the [Yarn docs](https://yarnpkg.com/getting-started/migration#step-by-step) to opt out of Plug'n'Play behavior.
+Previously, these "webpack" and "babel" packages were direct dependencies for `shakapacker`. By
+making these peer dependencies, you have control over the versions used in your webpack and babel configs.
 
 ## Concepts
 
@@ -578,8 +582,11 @@ console.log(JSON.stringify(webpackConfig, undefined, 2))
 You may want to modify the rules in the default configuration. For instance, if you are using a custom svg loader, you may want to remove `.svg` from the default file loader rules. You can search and filter the default rules like so:
 
 ```js
-const svgRule = config.module.rules.find(rule => rule.test.test('.svg'));
-svgRule.test = svgRule.test.filter(t => !t.test('.svg'))
+const fileRule = config.module.rules.find(rule => rule.test.test('.svg'));
+// removing svg from asset file rule's test RegExp
+fileRule.test = /\.(bmp|gif|jpe?g|png|tiff|ico|avif|webp|eot|otf|ttf|woff|woff2)$/
+// changing the rule type from 'asset/resource' to 'asset'. See https://webpack.js.org/guides/asset-modules/
+fileRule.type = 'asset'
 ```
 
 ### Babel configuration
@@ -621,13 +628,13 @@ See also [Customizing Babel Config](./docs/customizing_babel_config.md) for an e
 #### TypeScript
 
 ```bash
-yarn add typescript @babel/preset-typescript
+npm install typescript @babel/preset-typescript
 ```
 
 Babel won’t perform any type-checking on TypeScript code. To optionally use type-checking run:
 
 ```bash
-yarn add fork-ts-checker-webpack-plugin
+npm install fork-ts-checker-webpack-plugin
 ```
 
 Add tsconfig.json
@@ -668,7 +675,7 @@ module.exports = generateWebpackConfig({
 To enable CSS support in your application, add the following packages:
 
 ```bash
-yarn add css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
+npm install css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
 ```
 
 Optionally, add the `CSS` extension to webpack config for easy resolution.
@@ -692,18 +699,18 @@ then add the relevant pre-processors:
 #### Postcss
 
 ```bash
-yarn add postcss postcss-loader
+npm install postcss postcss-loader
 ```
 
 Optionally add these two plugins if they are required in your `postcss.config.js`:
 ```bash
-yarn add postcss-preset-env postcss-flexbugs-fixes
+npm install postcss-preset-env postcss-flexbugs-fixes
 ```
 
 #### Sass
 
 ```bash
-yarn add sass-loader
+npm install sass-loader
 ```
 
 You will also need to install [Dart Sass](https://github.com/sass/dart-sass), [Node Sass](https://github.com/sass/node-sass) or [Sass Embedded](https://github.com/sass/embedded-host-node) to pick the implementation to use. sass-loader will automatically pick an implementation based on installed packages.
@@ -712,35 +719,35 @@ Please refer to [sass-loader documentation](https://www.npmjs.com/package/sass-l
 
 ##### Dart Sass
 ```bash
-yarn add sass
+npm install sass
 ```
 
 ##### Node Sass
 ```bash
-yarn add node-sass
+npm install node-sass
 ```
 
 ##### Sass Embedded
 ```bash
-yarn add sass-embedded
+npm install sass-embedded
 ```
 
 #### Less
 
 ```bash
-yarn add less less-loader
+npm install less less-loader
 ```
 
 #### Stylus
 
 ```bash
-yarn add stylus stylus-loader
+npm install stylus stylus-loader
 ```
 
 #### CoffeeScript
 
 ```bash
-yarn add coffeescript coffee-loader
+npm install coffeescript coffee-loader
 ```
 
 #### Other frameworks
@@ -840,16 +847,24 @@ bundle update shakapacker
 # overwrite your changes to the default install files and revert any unwanted changes from the install
 rails shakapacker:install
 
-# yarn 1 instructions
+# using npm
+npm install shakapacker@latest
+npm install webpack-dev-server@latest
+
+# using yarn classic
 yarn upgrade shakapacker --latest
 yarn upgrade webpack-dev-server --latest
 
-# yarn 2 instructions
+# using yarn berry
 yarn up shakapacker@latest
 yarn up webpack-dev-server@latest
 
+# using pnpm
+pnpm up shakapacker@latest
+pnpm up webpack-dev-server@latest
+
 # Or to install the latest release (including pre-releases)
-yarn add shakapacker@next
+npm install shakapacker@next
 ```
 
 Also, consult the [CHANGELOG](./CHANGELOG.md) for additional upgrade links.
@@ -899,6 +914,12 @@ import 'stylesheets/main'
 import 'images/rails.png'
 ```
 
+Assets put in these folders will also have their path stripped just like with the `source_path`.
+
+Example:
+
+A file in `app/assets/images/image.svg` with `additional_paths: ['app/assets']` will result in `static/images/image.svg`
+
 **Note:** Please be careful when adding paths here otherwise it will make the compilation slow, consider adding specific paths instead of the whole parent directory if you just need to reference one or two modules
 
 **Also note:** While importing assets living outside your `source_path` defined in shakapacker.yml (like, for instance, assets under `app/assets`) from within your packs using _relative_ paths like `import '../../assets/javascripts/file.js'` will work in development, Shakapacker won't recompile the bundle in production unless a file that lives in one of it's watched paths has changed (check out `Shakapacker::MtimeStrategy#latest_modified_timestamp` or `Shakapacker::DigestStrategy#watched_files_digest` depending on strategy configured by `compiler_strategy` option in `shakapacker.yml`). That's why you'd need to add `app/assets` to the additional_paths as stated above and use `import 'javascripts/file.js'` instead.
@@ -910,7 +931,24 @@ Shakapacker hooks up a new `shakapacker:compile` task to `assets:precompile`, wh
 
 This behavior is optional & can be disabled by either setting a `SHAKAPACKER_PRECOMPILE` environment variable to `false`, `no`, `n`, or `f`, or by setting a `shakapacker_precompile` key in your `shakapacker.yml` to `false`. ([source code](./lib/shakapacker/configuration.rb#L34))
 
-When compiling assets for production on a remote server, such as a continuous integration environment, it's recommended to use `yarn install --frozen-lockfile` to install NPM packages on the remote host to ensure that the installed packages match the `yarn.lock` file.
+When compiling assets for production on a remote server, such as a continuous integration environment, it's recommended to ensure the exact versions specified in your lockfile are installed:
+
+```
+# using npm
+npm ci
+
+# using yarn classic
+yarn install --frozen-lockfile
+
+# using yarn berry
+yarn install --immutable
+
+# using pnpm
+pnpm install --frozen-lockfile
+
+# using bun
+bun install --frozen-lockfile
+```
 
 If you are using a CDN setup, Shakapacker does NOT use the `ASSET_HOST` environment variable to prefix URLs for assets during bundle compilation. You must use the `SHAKAPACKER_ASSET_HOST` environment variable instead (`WEBPACKER_ASSET_HOST` if you're using any version of Webpacker or Shakapacker before Shakapacker v7).