shakapacker 9.3.0.beta.0 → 9.3.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 673dbe7651111125cf2c4c408e128be24f73475825910473ced26eba32929f6e
-  data.tar.gz: 83af8568e4d40e9859483ee4d71d7164facb0c5c2131880912e0aa42143aa427
+  metadata.gz: c503694d35261163ce77ef2efb38c85b5365c7e0c817f06d0c3a9b7e9cd8ce0e
+  data.tar.gz: 6bea7b663bdb25fc2428bba429ec2f773a4298e91c2fdf2af9b8d0be5f089dd1
 SHA512:
-  metadata.gz: 302f3c9f98e999524573103dbaf5ecdfc048f5c780a293ddcf1bfb0409a3779e83b0176070a2c7563f74be56a3c118e23812ba8065c048d1eb9fb9765d00a272
-  data.tar.gz: ff0f655f57a37baee93a04147b9e2d0e50fd0f2607c2413bac46a420275a0e40c302d41a1a3d4d38e35a0e1d70b525c60ecbc0a742c634c22b202b36d3422fd5
+  metadata.gz: dca52dbb54ea99fd8ad7b3e5cc9de4f0c5446a5c7a2f855032355d5b224fc91e74055784e92733ac6b41548e9676b4ed76c1bf8f4e88d024d6984ddae79f49dd
+  data.tar.gz: 702f88a69f5116ab0bc2bbfbff2d650cc5d542dd71a4716e4083e1ef79785a0a1a3eeb734924f1753ecafbe633a9bc21d29d86c60911caa6fe6e14acc4531d95

data/CHANGELOG.md

@@ -11,9 +11,56 @@
 
 Changes since the last non-beta release.
 
+## [v9.3.0-beta.0] - October 13, 2025
+
+### Added
+
+- **New `precompile_hook` configuration option** to run custom commands during asset precompilation. [PR #678](https://github.com/shakacode/shakapacker/pull/678) by [justin808](https://github.com/justin808).
+  - Allows executing custom scripts or tasks during the precompile process
+  - Configure in `shakapacker.yml` with `precompile_hook: "command to run"`
+- **New `assets_bundler_config_path` configuration option** for custom bundler config locations. [PR #710](https://github.com/shakacode/shakapacker/pull/710) by [justin808](https://github.com/justin808).
+  - Allows specifying a custom path for webpack/rspack configuration files
+  - Useful for complex project structures or shared configurations
+- **YAML output format support for `bin/export-bundler-config`**. [PR #704](https://github.com/shakacode/shakapacker/pull/704) by [justin808](https://github.com/justin808).
+  - New `--format yaml` option exports bundler configuration as YAML
+  - Easier to read than JSON for debugging and documentation
+- **Custom help messages for `bin/shakapacker` commands**. [PR #702](https://github.com/shakacode/shakapacker/pull/702) by [justin808](https://github.com/justin808).
+  - Improved help output for better command discoverability
+  - Clear usage examples and option descriptions
+- **HMR client config export in doctor mode**. [PR #701](https://github.com/shakacode/shakapacker/pull/701) by [justin808](https://github.com/justin808).
+  - `bin/export-bundler-config --doctor` now includes HMR client configuration
+  - Helps debug Hot Module Replacement issues
+- **Build timing logs** for webpack and rspack. [PR #706](https://github.com/shakacode/shakapacker/pull/706) by [justin808](https://github.com/justin808).
+  - Shows duration of build operations
+  - Helps identify performance bottlenecks
+- Added Knip for detecting dead code to CI. [PR #675](https://github.com/shakacode/shakapacker/pull/675) by [justin808](https://github.com/justin808).
+
 ### Changed
 
-- Allow ESLint v9 and migrated to flat config format. [PR #677](https://github.com/shakacode/shakapacker/pull/677) by [justin808](https://github.com/justin808).
+- **Migrated to ESLint v9 with flat config format**. [PR #677](https://github.com/shakacode/shakapacker/pull/677) by [justin808](https://github.com/justin808).
+  - Updated all ESLint plugins to latest versions
+  - Uses new flat config format for better maintainability
+- **Replaced custom argument parser with yargs**. [PR #692](https://github.com/shakacode/shakapacker/pull/692) by [justin808](https://github.com/justin808).
+  - More robust command-line argument parsing
+  - Better error messages and help output
+- Replaced `require` with `import` in package/index.ts. [PR #674](https://github.com/shakacode/shakapacker/pull/674) by [justin808](https://github.com/justin808).
+- Updated @rspack dependencies to 1.5.8. [PR #700](https://github.com/shakacode/shakapacker/pull/700) by [justin808](https://github.com/justin808).
+
+### Improved
+
+- **Enhanced rspack migration documentation** with real-world lessons. [PR #713](https://github.com/shakacode/shakapacker/pull/713) by [justin808](https://github.com/justin808).
+  - Added practical migration guidance based on actual project experiences
+  - Common pitfalls and solutions documented
+- **Consolidated duplicate configuration documentation**. [PR #714](https://github.com/shakacode/shakapacker/pull/714) by [justin808](https://github.com/justin808).
+  - Removed redundant documentation
+  - Single source of truth for configuration options
+- **Improved error messages** to suggest `assets_bundler_config_path`. [PR #712](https://github.com/shakacode/shakapacker/pull/712) by [justin808](https://github.com/justin808).
+  - More helpful error messages when bundler config is not found
+  - Suggests using `assets_bundler_config_path` for custom locations
+- **Improved doctor command output** clarity and accuracy. [PR #682](https://github.com/shakacode/shakapacker/pull/682) by [justin808](https://github.com/justin808).
+  - Better formatting and organization of diagnostic information
+  - More actionable recommendations
+- Formatted all markdown files with prettier. [PR #673](https://github.com/shakacode/shakapacker/pull/673) by [justin808](https://github.com/justin808).
 
 ### Fixed
 
@@ -26,6 +73,12 @@ Changes since the last non-beta release.
 - Fixed TypeScript type definitions to export proper types instead of `any`. [PR #684](https://github.com/shakacode/shakapacker/pull/684) by [justin808](https://github.com/justin808).
   - Previously `package/index.d.ts` was exporting all types as `any`, breaking IDE autocomplete
   - Now properly exports typed interfaces for `WebpackConfig`, `RspackConfig`, etc.
+- Fixed integrity config handling and sass-loader version check. [PR #688](https://github.com/shakacode/shakapacker/pull/688) by [justin808](https://github.com/justin808).
+  - Properly handles subresource integrity configuration
+  - Correctly detects sass-loader version for conditional logic
+- Prevented index.d.ts confusion in build process. [PR #698](https://github.com/shakacode/shakapacker/pull/698) by [justin808](https://github.com/justin808).
+  - TypeScript declaration files no longer interfere with build output
+- Fixed yarn.lock formatting changes in Conductor setup. [PR #683](https://github.com/shakacode/shakapacker/pull/683) by [justin808](https://github.com/justin808).
 
 ## [v9.2.0] - October 9, 2025
 
@@ -679,7 +732,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 
 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/v9.0.0...main
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v9.3.0-beta.0...main
+[v9.3.0-beta.0]: https://github.com/shakacode/shakapacker/compare/v9.2.0...v9.3.0-beta.0
 [v9.2.0]: https://github.com/shakacode/shakapacker/compare/v9.1.0...v9.2.0
 [v9.1.0]: https://github.com/shakacode/shakapacker/compare/v9.0.0...v9.1.0
 [v9.0.0]: https://github.com/shakacode/shakapacker/compare/v8.4.0...v9.0.0

data/Gemfile.lock

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

data/docs/troubleshooting.md

@@ -71,7 +71,147 @@
 
    See `bin/export-bundler-config --help` for all available options.
 
-6. Generate webpack stats for build analysis (useful for bundle size optimization):
+6. **Validate your webpack/rspack builds**: Use `bin/export-bundler-config --validate` to test that all your build configurations compile successfully. This is especially useful for:
+   - **CI/CD pipelines**: Catch configuration errors before deployment
+   - **Migration testing**: Verify builds work after upgrading webpack, rspack, or Shakapacker
+   - **Multi-environment testing**: Ensure all build configurations (dev, prod, HMR) compile correctly
+
+   **Quick validation:**
+
+   ```bash
+   # Validate all builds defined in .bundler-config.yml
+   bin/export-bundler-config --validate
+
+   # Validate with full output logs (shows all webpack/rspack compilation output)
+   bin/export-bundler-config --validate --verbose
+
+   # Validate a specific build
+   bin/export-bundler-config --validate-build=dev-hmr
+   ```
+
+   **Verbose Mode:**
+
+   When using `--verbose`, you'll see:
+   - A clear header indicating verbose mode is enabled
+   - Full real-time compilation output from webpack/rspack
+   - All warnings and progress messages
+   - Detailed error traces
+   - Separators between builds for clarity
+
+   This is useful for debugging compilation issues or understanding build performance.
+
+   **Setting up build configurations:**
+
+   ```bash
+   # Create a .bundler-config.yml file with example builds
+   bin/export-bundler-config --init
+
+   # List all available builds
+   bin/export-bundler-config --list-builds
+
+   # Validate all builds
+   bin/export-bundler-config --validate
+   ```
+
+   **Advanced options:**
+
+   The validator uses a default timeout of 2 minutes per build. For large projects or slow CI environments, you can customize this behavior by modifying the `ValidatorOptions` in your code, or by adjusting your build configuration to be more efficient.
+
+   If validation times out, try:
+   - Using `--verbose` to see where the build is hanging
+   - Optimizing your webpack/rspack configuration for faster builds
+   - Running validation on a single build with `--validate-build=build-name`
+
+   **How it works:**
+
+   The validator will:
+   - For HMR builds (with `WEBPACK_SERVE=true`): Start webpack-dev-server, wait for successful compilation, then shut down
+   - For static builds: Run webpack/rspack and check for compilation errors
+   - Report all errors and warnings with clear output
+   - Exit with code 1 if any build fails (perfect for CI)
+
+   **Example output:**
+
+   ```text
+   🔍 Validating Builds
+   ================================================================================
+
+   📦 Validating build: dev-hmr
+      ✅ Build passed
+
+   📦 Validating build: dev
+      ✅ Build passed
+
+   📦 Validating build: prod
+      ❌ Build failed with 2 error(s)
+
+   ================================================================================
+   🔍 Build Validation Results
+   ================================================================================
+
+   ✅ Build: dev-hmr (2.34s)
+      📦 Outputs: client
+      ⚙️  Config: config/webpack/webpack.config.js
+
+   ✅ Build: dev (3.12s)
+      📦 Outputs: client, server
+      ⚙️  Config: config/webpack/webpack.config.js
+      📁 Output: /app/public/packs
+
+   ❌ Build: prod (4.56s)
+      📦 Outputs: client, server
+      ⚙️  Config: config/webpack/webpack.config.js
+      📁 Output: /app/public/packs
+      ❌ 2 error(s)
+         Module not found: Error: Can't resolve './missing'
+         SyntaxError: Unexpected token
+
+   ================================================================================
+   Summary: 2/3 builds passed, 1 failed (Total: 10.02s)
+   ================================================================================
+
+   💡 Debugging Tips:
+      To get more details, run individual builds with --verbose:
+
+      bin/export-bundler-config --validate-build prod --verbose
+
+      Or validate all builds with full output: bin/export-bundler-config --validate --verbose
+   ================================================================================
+   ```
+
+   **Debugging Failed Builds:**
+
+   When builds fail, the validator automatically provides debugging commands. You can:
+   1. **Run a specific build with verbose output** to see full webpack/rspack logs:
+
+      ```bash
+      bin/export-bundler-config --validate-build prod --verbose
+      ```
+
+   2. **Validate all builds with verbose output** to see everything:
+
+      ```bash
+      bin/export-bundler-config --validate --verbose
+      ```
+
+   3. **Test individual builds manually** using the same configuration:
+
+      ```bash
+      # For static builds
+      NODE_ENV=production RAILS_ENV=production bundle exec webpack --config config/webpack/webpack.config.js
+
+      # For HMR/dev-server builds
+      NODE_ENV=development WEBPACK_SERVE=true bundle exec webpack serve --config config/webpack/webpack.config.js
+      ```
+
+   The verbose mode shows:
+   - Full real-time compilation output
+   - All webpack/rspack warnings and progress messages
+   - Detailed stack traces for errors
+   - Timing information for each build phase
+   - Clear separators between different builds
+
+7. Generate webpack stats for build analysis (useful for bundle size optimization):
 
    ```bash
    NODE_ENV=development bin/shakapacker --profile --json > /tmp/webpack-stats.json

data/jest.config.js

@@ -1,5 +1,12 @@
 module.exports = {
   roots: ["<rootDir>/test"],
   testPathIgnorePatterns: ["/__fixtures__/", "/__utils__/"],
-  resolver: "<rootDir>/test/resolver"
+  resolver: "<rootDir>/test/resolver",
+  preset: "ts-jest",
+  testEnvironment: "node",
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  transform: {
+    "^.+\\.tsx?$": "ts-jest"
+  },
+  transformIgnorePatterns: ["node_modules/(?!(.*\\.mjs$))"]
 }

data/lib/shakapacker/version.rb

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