shakapacker 6.1.0.beta.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4167db4aea00b8ed494df2151cb5fd7ad414dc6617e8c1b0ee5537d461c7c968
-  data.tar.gz: 7cc1c3c5f9c5a39801ac1801b252ee609e01a6c06508541b64d30fadcf7464ed
+  metadata.gz: c6e31a49e348719f7663178aee3ec877d3a53f6bd9e264fd8e82278ac17070e7
+  data.tar.gz: c2d9294063be7bab761baf8f10eeb82c350dfcc0bfc322cac52fa06fdb4cbef5
 SHA512:
-  metadata.gz: 56ce966357cbf20bcf9fb92839e94988a9f91768118aca2960ec53b0b0ed377df04b0bbb6801e885a9011eafa63655537dc36c63a50eda6cca4d46cba319beee
-  data.tar.gz: 163807c57c4e543967a58a3dc96630d92d50fd798bac7d78536c39eaf055281c150922e98e66ad5af5e41daf3b2739b48a0cc5d1285f3251f875fda3581389f4
+  metadata.gz: 6cb3b71113fd1c7aad90098a4b0927830347feafe9cb9ef245aa6551950d67b9488be5d9aa411fcb6f775260856189d9cbfc5899732113fffbd7549aee84b7ef
+  data.tar.gz: 1729dccb33de9f34a2c3ca26268c79255e813a71fae548acd5066d7faaef30e4a58123955a32e7b48c19bb988cd078f407cbdcebae6bcf817522451914fbac7e

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-A bug is a crash or incorrect behavior. If you have a debugging or troubleshooting question, please open a discussion on the [Rails forum, category webpacker](https://discuss.rubyonrails.org/c/webpacker/10)
+A bug is a crash or incorrect behavior. If you have a debugging or troubleshooting question, please open a discussion on [Discussions Tab](https://github.com/shakacode/shakapacker/discussions).
 
 Ruby version:
 Rails version:

data/.github/ISSUE_TEMPLATE/feature-request.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-A feature request is describes a suggested improvement. If you have a debugging or troubleshooting question, please open a discussion on the [Rails forum, category webpacker](https://discuss.rubyonrails.org/c/webpacker/10)
+A feature request describes a suggested improvement. If you have a debugging or troubleshooting question, please open a discussion on the [Discussions tab](https://github.com/shakacode/shakapacker/discussions).
 
 Ruby version:
 Rails version:

data/.github/workflows/jest.yml

@@ -20,11 +20,8 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: yarn
 
-      - name: Install yarn maybe
-        run: which yarn || npm install -g yarn
-
       - name: Install dependencies
-        run: yarn --frozen-lockfile
+        run: yarn --frozen-lockfile --non-interactive --prefer-offline
 
       - name: Jest Specs
         run: yarn test

data/.github/workflows/js-lint.yml

@@ -3,13 +3,12 @@ name: JS lint
 on: [push, pull_request]
 
 jobs:
-  js-lint:
+  lint:
     name: JS Lint
-
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [14]
+        node: [12.x, 14.x, 16.x]
 
     runs-on: ${{ matrix.os }}
 
@@ -21,11 +20,8 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: yarn
 
-      - name: Install yarn maybe
-        run: which yarn || npm install -g yarn
-
       - name: Install dependencies
-        run: yarn --frozen-lockfile
+        run: yarn --frozen-lockfile --non-interactive --prefer-offline
 
       - name: Lint
         run: yarn lint

data/.github/workflows/rubocop.yml

@@ -6,34 +6,17 @@ jobs:
   rubocop:
     name: Rubocop
     runs-on: ${{ matrix.os }}
-    env:
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ruby: [
-          2.7
-        ]
+        ruby: ['2.7', '3.0']
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/cache@v2
-        with:
-          path: /home/runner/bundle
-          key: bundle-use-ruby-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            bundle-use-ruby-gems-
-
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
-      - name: Bundle install
-        run: |
-          gem install bundler -v 2.1.4
-          bundle config path /home/runner/bundle
-          bundle install
-
-      - name: Ruby linter
+      - name: Ruby rubocop
         run: bundle exec rubocop

data/.github/workflows/ruby.yml

@@ -6,43 +6,36 @@ jobs:
   test:
     name: Ruby specs
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' || matrix.experimental }}
     strategy:
-      fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby:
-          - 2.7
-          - "3.0"
+        ruby: ['2.6', '2.7', '3.0']
         gemfile:
           - gemfiles/Gemfile-rails.5.2.x
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
+          - gemfiles/Gemfile-rails.7.0.x
+          - gemfiles/Gemfile-rails-edge
         exclude:
-          - ruby: 2.5
-            gemfile: gemfiles/Gemfile-rails.6.1.x
-          - ruby: "3.0"
-            gemfile: gemfiles/Gemfile-rails.5.2.x
-        experimental: [false]
-        include:
-          - ruby: 2.7
+          - ruby: 2.6
             os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails-edge
-            experimental: true
-          - ruby: "3.0"
+            gemfile: gemfiles/Gemfile-rails.7.0.x
+          - ruby: 2.6
             os: ubuntu-latest
             gemfile: gemfiles/Gemfile-rails-edge
-            experimental: true
+          - ruby: 3.0
+            os: ubuntu-latest
+            gemfile: gemfiles/Gemfile-rails.5.2.x
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
     steps:
       - uses: actions/checkout@v2
-
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true # Run "bundle install", and cache the result automatically.
+          bundler-cache: true
 
       - name: Ruby specs
-        run: bundle exec rake
+        run: bundle exec rake test

data/.node-version

@@ -1 +1 @@
-16.7.0
+16.14.0

data/.rubocop.yml

@@ -1,6 +1,5 @@
 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,11 +1,37 @@
 * For versions prior to v6, see the [5.x stable branch of rails/webpacker](https://github.com/rails/webpacker/tree/5-x-stable).
-* Please see [UPGRADE GUIDE](./docs/v6_upgrade.md).
+* Please see [v6 Upgrade Guide](./docs/v6_upgrade.md) to go from version prior to v6.
 
 ## Versions
-### [Unreleased]
+## [Unreleased]
 Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
+
+## [v6.2.0] - March 22, 2022
+
+### Added
+- Make manifest_path configurable, to keep manifest.json private if desired. [PR 78](https://github.com/shakacode/shakapacker/pull/78) by [jdelStrother](https://github.com/jdelStrother).
+- Rewrite webpack module rules as regular expressions. Allows for easy iteration during config customization. [PR 60](https://github.com/shakacode/shakapacker/pull/60) by [blnoonan](https://github.com/blnoonan).
+- Initialization check to ensure shakapacker gem and NPM package version are consistent. Opt-in behaviour enabled by setting `ensure_consistent_versioning` configuration variable. [PR 51](https://github.com/shakacode/shakapacker/pull/51) by [tomdracz](https://github.com/tomdracz).
+- Add `dev_server.inline_css: bool` config option to allow for opting out of style-loader and into mini-extract-css-plugin for CSS HMR in development. [PR 69](https://github.com/shakacode/shakapacker/pull/69) by [cheald](https://github.com/cheald).
+
+### Improved
+- Increase default connect timeout for dev server connections, establishing connections more reliably for busy machines. [PR 74](https://github.com/shakacode/shakapacker/pull/74) by [stevecrozz](https://github.com/stevecrozz).
+- Allow multiple invocations of stylesheet_pack_tag (eg for a regular stylesheet & a print stylesheet). [PR 82](https://github.com/shakacode/shakapacker/pull/82) by [jdelStrother](https://github.com/jdelStrother).
+- Tweak swc config for parity with Babel. [PR 79](https://github.com/shakacode/shakapacker/pull/79) by [dleavitt](https://github.com/dleavitt).
+
+## [v6.1.1] - February 6, 2022
+
+### Added
+- Support for esbuild-loader. [PR 53](https://github.com/shakacode/shakapacker/pull/53) by [tomdracz](https://github.com/tomdracz).
+
+## [v6.1.0] - February 4, 2022
+### Added
+- Support for SWC loader. [PR 29](https://github.com/shakacode/shakapacker/pull/29) by [tomdracz](https://github.com/tomdracz).
+
+### Fixed
+- Static asset subdirectories are retained after compilation, matching Webpacker v5 behaviour. [PR 47](https://github.com/shakacode/shakapacker/pull/47) by [tomdracz](https://github.com/tomdracz). Fixes issues [rails/webpacker#2956](https://github.com/rails/webpacker/issues/2956) which broke in [rails/webpacker#2802](https://github.com/rails/webpacker/pull/2802).
+
 ## [v6.0.2] - January 25, 2022
 ### Improved
 - Fix incorrect command name in warning. [PR 33](https://github.com/shakacode/shakapacker/pull/33) by [tricknotes](https://github.com/tricknotes).
@@ -58,8 +84,13 @@ Changes since last non-beta release.
 - Splitchunks enabled by default
 - CSS extraction enabled by default, except when devServer is configured and running
 
+## 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/6.0.2...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.2.0...master
+[v6.2.0]: https://github.com/shakacode/shakapacker/compare/v6.1.1...v6.2.0
+[v6.1.1]: https://github.com/shakacode/shakapacker/compare/v6.1.0...v6.1.1
+[v6.1.0]: https://github.com/shakacode/shakapacker/compare/v6.0.2...v6.1.0
 [v6.0.2]: https://github.com/shakacode/shakapacker/compare/v6.0.1...v6.0.2
 [v6.0.1]: https://github.com/shakacode/shakapacker/compare/v6.0.0...v6.0.1
 [v6.0.0 changes from v6.0.0.rc.6]: https://github.com/shakacode/shakapacker/compare/aba79635e6ff6562ec04d3c446d57ef19a5fef7d...v6.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (6.0.0)
+    shakapacker (6.1.1)
       activesupport (>= 5.2)
       rack-proxy (>= 0.6.1)
       railties (>= 5.2)

data/README.md

@@ -1,7 +1,8 @@
 # Shakapacker
 
-_Official, actively maintained fork of [rails/webpacker](https://github.com/rails/webpacker). Internal naming for `shakapacker` will continue to use `webpacker` where possible. Notably, the NPM package name is `shakapacker`._
-* See [V6 Upgrade](./docs/v6_upgrade.md) for upgrading from v5 or prior v6 releases. 
+_Official, actively maintained successor to [rails/webpacker](https://github.com/rails/webpacker). Internal naming for `shakapacker` will continue to use `webpacker` where possible for v6. ShakaCode stands behind long-term maintainence and development of this project for the Rails community._
+
+* See [V6 Upgrade](./docs/v6_upgrade.md) for upgrading from v5 or prior v6 releases.
 
 [![Ruby specs](https://github.com/shakacode/shakapacker/workflows/Ruby%20specs/badge.svg)](https://github.com/shakacode/shakapacker/actions)
 [![Jest specs](https://github.com/shakacode/shakapacker/workflows/Jest%20specs/badge.svg)](https://github.com/shakacode/shakapacker/actions)
@@ -12,16 +13,17 @@ _Official, actively maintained fork of [rails/webpacker](https://github.com/rail
 [![Gem](https://img.shields.io/gem/v/shakapacker.svg)](https://rubygems.org/gems/shakapacker)
 [![npm version](https://badge.fury.io/js/shakapacker.svg)](https://badge.fury.io/js/shakapacker)
 
-Webpacker makes it easy to use the JavaScript pre-processor and bundler
-[Webpack v5](https://webpack.js.org/)
+Webpacker makes it easy to use the JavaScript pre-processor and bundler [Webpack v5+](https://webpack.js.org/)
 to manage application-like JavaScript in Rails. It can coexist with the asset pipeline,
 leaving Webpack responsible solely for app-like JavaScript, or it can be used exclusively, making it also responsible for images, fonts, and CSS.
 
+Check out 6.1.1 for [SWC](https://swc.rs/) and [esbuild-loader](https://github.com/privatenumber/esbuild-loader) support! They are faster than Babel!
+
 See a comparison of [webpacker with jsbundling-rails](https://github.com/rails/jsbundling-rails/blob/main/docs/comparison_with_webpacker.md).
 
-Discussion forums to discuss debugging and troubleshooting tips. Please open issues for bugs and feature requests:
-1. [rails/webpacker discussion forum](https://discuss.rubyonrails.org/c/webpacker/10)
-2. [Discussions tab](https://github.com/shakacode/shakapacker/discussions)
+Discussion forum and Slack to discuss debugging and troubleshooting tips. Please open issues for bugs and feature requests:
+1. [Discussions tab](https://github.com/shakacode/shakapacker/discussions)
+2. [Slack discussion channel](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE)
 
 ---
 
@@ -34,6 +36,7 @@ Discussion forums to discuss debugging and troubleshooting tips. Please open iss
 - [Installation](#installation)
   - [Rails v6+](#rails-v6)
   - [Note for Sprockets usage](#note-for-sprockets-usage)
+  - [Note for Yarn v2 usage](#note-for-yarn-v2-usage)
 - [Usage](#usage)
   - [View Helpers](#view-helpers)
   - [Defer for `javascript_pack_tag`](#defer-for-javascript_pack_tag)
@@ -42,6 +45,7 @@ Discussion forums to discuss debugging and troubleshooting tips. Please open iss
   - [Webpack Configuration](#webpack-configuration)
   - [Babel configuration](#babel-configuration)
   - [SWC configuration](#swc-configuration)
+  - [esbuild loader configuration](#esbuild-loader-configuration)
   - [Integrations](#integrations)
     - [React](#react)
     - [Typescript](#typescript)
@@ -67,18 +71,18 @@ Discussion forums to discuss debugging and troubleshooting tips. Please open iss
 
 ## Prerequisites
 
-- Ruby 2.7+
+- Ruby 2.6+
 - Rails 5.2+
 - Node.js 12.13.0+ || 14+
 - Yarn
 
 ## Features
-- Rails view helpers that fully support webpack output
+- 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 create a manifest.
 - HMR with the webpack-dev-server, such as for hot-reloading for React!
 - Automatic code splitting using multiple entry points to optimize JavaScript downloads
-- [Webpack v5](https://webpack.js.org/)
-- ES6 with [babel](https://babeljs.io/)
+- [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
 - CDN support
 - Extensible and configurable. For example, all major dependencies are specified as peers, so you can upgrade easily.
@@ -102,11 +106,10 @@ rails new myapp --skip-javascript
 
 _Note, Rails 6 installs the older v5 version of webpacker unless you specify `--skip-javascript`._
 
-Update your `Gemfile`:
+Add `shakapacker` gem to your `Gemfile`:
 
-```ruby
-# Gemfile
-gem 'shakapacker', '~> 6.0'
+```bash
+bundle add shakapacker --strict
 ```
 
 Then running the following to install Webpacker:
@@ -142,6 +145,12 @@ In order to enable this, make sure you add `node_modules` to the asset load path
 Rails.application.config.assets.paths << Rails.root.join('node_modules')
 ```
 
+### Note for Yarn v2 usage
+
+If you are using Yarn v2 (berry), please note that PnP modules are not supported.
+
+In order 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 behaviour.
+
 ## Usage
 
 ### View Helpers
@@ -197,9 +206,18 @@ The result looks like this:
 <%= stylesheet_pack_tag 'map' %>
 ```
 
+However, you may use multiple calls to stylesheet_pack_tag if, say, you require multiple <style> tags for different output media:
+
+``` erb
+<%= stylesheet_pack_tag 'application', media: 'screen' %>
+<%= stylesheet_pack_tag 'print', media: 'print' %>
+```
+
+If you need to setup the pack name args in partials, [see this discussion](https://github.com/shakacode/shakapacker/issues/39).
+
 If you want to link a static asset for `<img />` tag, you can use the `asset_pack_path` helper:
 ```erb
-<img src="<%= asset_pack_path 'images/logo.svg' %>" />
+<img src="<%= asset_pack_path 'static/logo.svg' %>" />
 ```
 
 Or use the dedicated helper:
@@ -358,6 +376,13 @@ console.log(webpackConfig.source_path)
 console.log(JSON.stringify(webpackConfig, undefined, 2))
 ```
 
+You may want to modify 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'))
+```
+
 ### Babel configuration
 
 By default, you will find the Webpacker preset in your `package.json`. Note, you need to use the new NPM package name, `shakapacker`.
@@ -378,6 +403,12 @@ You can try out experimental integration with the SWC loader. You can read more
 
 Please note that if you want opt-in to use SWC, you can skip [React](#react) integration instructions as it is supported out of the box.
 
+### esbuild loader configuration
+
+You can try out experimental integration with the esbuild-loader. You can read more at [esbuild-loader usage docs](./docs/using_esbuild_loader.md).
+
+Please note that if you want opt-in to use esbuild-loader, you can skip [React](#react) integration instructions as it is supported out of the box.
+
 ### Integrations
 
 Webpacker out of the box supports JS and static assets (fonts, images etc.) compilation. To enable support for CoffeeScript or TypeScript install relevant packages:
@@ -648,7 +679,9 @@ development:
     port: 3035
 ```
 
-If you have `hmr` turned to true, then the `stylesheet_pack_tag` generates no output, as you will want to configure your styles to be inlined in your JavaScript for hot reloading. During production and testing, the `stylesheet_pack_tag` will create the appropriate HTML tags.
+If you have `hmr` turned to true and `inline_css` is not false, then the `stylesheet_pack_tag` generates no output, as you will want to configure your styles to be inlined in your JavaScript for hot reloading. During production and testing, the `stylesheet_pack_tag` will create the appropriate HTML tags.
+
+If you want to have HMR and separate link tags, set `hmr: true` and `inline_css: false`. This will cause styles to be extracted and reloaded with the `mini-css-extract-plugin` loader. Note that in this scenario, you do not need to include style-loader in your project dependencies.
 
 ### Additional paths
 

data/docs/customizing_babel_config.md

@@ -29,7 +29,9 @@ yarn add --dev @pmmmwh/react-refresh-webpack-plugin react-refresh
 module.exports = function (api) {
   const defaultConfigFunc = require('shakapacker/package/babel/preset.js')
   const resultConfig = defaultConfigFunc(api)
+  const isDevelopmentEnv = api.env('development')
   const isProductionEnv = api.env('production')
+  const isTestEnv = api.env('test')
 
   const changesOnDefault = {
     presets: [

data/docs/style_loader_vs_mini_css.md

@@ -0,0 +1,48 @@
+# CSS Delivery In Development
+
+You have two options for serving CSS in development:
+
+1. You can opt to serve CSS via style-loader (as was traditionally done in a Webpack setup), where CSS is written by Javascript served by Webpacker into a `<style>` tag, or
+2. You can opt to serve CSS as a full CSS file via mini-css-extract-plugin, which uses a standard `<link>` tag to load a fully separate CSS file.
+
+Both options support HMR. The default is style-loader. If you want to use mini-css-extract-plugin in development, set `inline_css: false` in the development dev_server section of your webpacker.yml:
+
+```yml
+development:
+  <<: *default
+  dev_server:
+    hmr: true
+    inline_css: false # Use mini-css-extract-plugin for CSS delivery
+```
+
+## Why would I pick style-loader?
+
+style-loader is how you are probably are used to serving CSS in development with HMR in Webpack.
+
+### benefits
+
+* No [Flash Of Unstyled Content (FOUC)](https://en.wikipedia.org/wiki/Flash_of_unstyled_content) on HMR refreshes
+* Smaller/faster incremental updates.
+
+### drawbacks
+
+* Inflated JS deliverable size; requires JS execution before CSS is available
+* FOUC on initial page load
+* Adds an extra dependency
+* Divergence in delivery mechanism from production
+
+## Why would I pick mini-extract-css-plugin?
+
+mini-css-extract-plugin's behavior is much more true to a production deployment's behavior, in that CSS is loaded via `link rel=stylsheet` tags, rather than injected by Javascript into `style` tags.
+
+### benefits
+
+* Required for production, so it's going to be in play anyhow. Using only it simplifies the config and eliminates the style-loader dependency.
+* No FOUC on initial page loads
+* CSS delivered via `<link>` tags matches the mechanism used in production (I have been guilty of omitting my `stylesheet_pack_tag` for my first deploy because CSS worked fine with just the `javascript_pack_tag` in development.)
+
+### drawbacks
+
+* Invokes a separate HTTP request, compared to style-loader
+* Potential for FOUC on HMR refreshes
+* More data transferred per refresh (full stylesheet reload, rather than just an incremental patch). Not likely to be noticed for local development, but still a technical difference. This may only be the case [when you're using local CSS modules](https://github.com/webpack-contrib/mini-css-extract-plugin/blob/master/src/hmr/hotModuleReplacement.js#L267-L273).

data/docs/using_esbuild_loader.md

@@ -0,0 +1,128 @@
+# Using esbuild-loader
+
+:warning: This feature is currently experimental. The configuration and API are subject to change during the beta release cycle.
+
+If you face any issues, please report them at https://github.com/shakacode/shakapacker/issues.
+
+## About esbuild
+
+[esbuild](https://esbuild.github.io/) is a Go-based bundler tool that can offer [significant improvement](https://esbuild.github.io/faq/#benchmark-details) over other similar tools.
+
+While esbuild is a complete bundler, through the usage of [esbuild-loader](https://github.com/privatenumber/esbuild-loader), you can still leverage esbuild's speedy transpilation and minifcation in your Webpack-based configs.
+
+Please note, that unlike Babel or SWC loader, esbuild-loader has got no support for things like:
+- React Hot Module reload
+- ES5 as a compilation target
+- Automatic polyfills for missing browser features
+
+Those are limitations of esbuild itself and might make use of esbuild-loader in your project unfeasible. If you don't care about HMR and don't need to support older browsers, esbuild-loader might be a suitable option for you.
+
+## Switching your Shakapacker project to esbuild-loader
+
+To use esbuild as your transpiler today. You need to do two things:
+
+1. Make sure you've installed `esbuild` and `esbuild-loader` packages.
+
+```
+yarn add esbuild esbuild-loader
+```
+
+2. Add or change `webpacker_loader` value in your default `webpacker.yml` config to `esbuild`
+The default configuration of babel is done by using `package.json` to use the file within the `shakapacker` package.
+
+```yml
+default: &default
+  source_path: app/javascript
+  source_entry_path: /
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  webpack_compile_output: true
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Select loader to use, available options are 'babel' (default), 'swc' or 'esbuild'
+  webpack_loader: 'esbuild'
+```
+
+### (Optional) Replace minification with esbuild
+
+You can gain an additional performance boost if you replace the default Terser minification with esbuild plugin.
+
+o do so, you need to modify your webpack configuration and use `ESBuildMinifyPlugin` provided by `esbuild-loader`.
+
+Example:
+
+```js
+const { webpackConfig: baseWebpackConfig, merge } = require('shakapacker')
+const { ESBuildMinifyPlugin } = require('esbuild-loader')
+
+const options = {
+  optimization: {
+    minimizer: [
+      new ESBuildMinifyPlugin({
+        target: 'es2015' 
+      })
+    ]
+  }
+}
+
+module.exports = merge({}, baseWebpackConfig, options)
+```
+
+For more details, see instructions at https://github.com/shakacode/shakapacker#webpack-configuration and https://github.com/privatenumber/esbuild-loader#js-minification-eg-terser.
+
+## Usage
+
+### React
+
+React is supported out of the box, provided you use `.jsx` or `.tsx` file extension. Shakapacker config will correctly recognize those and tell esbuild to parse the JSX syntax correctly. If you wish to customize the likes of JSX fragment function, you can do that through customizing loader options as described below. You can see available options at https://github.com/privatenumber/esbuild-loader#%EF%B8%8F-options.
+
+### Typescript
+
+Typescript is supported out of the box and `.tsconfig.json` root file is automatically detected. Only a subset of `.tsconfig.json` options is supported. Please refer to the [loader docs](https://github.com/privatenumber/esbuild-loader#configuration) for additional information.
+
+## Customizing loader options
+
+You can see the default loader options at [esbuild/index.js](../package/esbuild/index.js).
+
+If you wish to customize the loader defaults further, you need to create a `esbuild.config.js` file in your app config folder.
+
+This file should have a single default export which is an object with an `options` key. Your customizations will be merged with default loader options. You can use this to override or add additional configurations.
+
+Inside the `options` key, you can use any options available to the esbuild-loader. For the options reference, please refer to [esbuild-loader docs](https://github.com/privatenumber/esbuild-loader#%EF%B8%8F-options).
+
+See some examples below of potential `config/babel.config.js`.
+
+### Example: Specifying esnext target environment
+
+
+```js
+const customConfig = {
+  options: {
+    target: 'esnext'
+  }
+}
+
+module.exports = customConfig
+```
+
+### Example: Using custom jsxFragment and jsxFactory
+
+```js
+const { env } = require('shakapacker')
+
+const customConfig = {
+  options: {
+    jsxFragment: 'Fragment',
+    jsxFactory: 'h' 
+  }
+}
+
+module.exports = customConfig
+```

data/docs/using_swc_loader.md

@@ -1,6 +1,8 @@
 # Using SWC Loader
 
-:warning: This feature is currently experimental. If you face any issues, please report at https://github.com/shakacode/shakapacker/issues.
+:warning: This feature is currently experimental. The configuration and API are subject to change during the beta release cycle.
+
+If you face any issues, please report at https://github.com/shakacode/shakapacker/issues.
 
 ## About SWC
 
@@ -17,13 +19,13 @@ In order to use SWC as your compiler today. You need to do two things:
 1. Make sure you've installed `@swc/core` and `swc-loader` packages.
 
 ```
-yarn add -D @swc/core swc-loader
+yarn add @swc/core swc-loader
 ```
 
-2. Add or change `webpacker_loader` value in your default `webpacker.yml` config to `swc`
+2. Add or change `webpack_loader` value in your default `webpacker.yml` config to `swc`
 The default configuration of babel is done by using `package.json` to use the file within the `shakapacker` package.
 
-```json
+```yml
 default: &default
   source_path: app/javascript
   source_entry_path: /