shakapacker 9.2.0 → 9.3.0.beta.0

data/TODO_v9.md

@@ -3,17 +3,21 @@
 ## CSS Modules Configuration Alignment
 
 ### Problem
+
 Current CSS modules configuration causes TypeScript/webpack warnings because of default vs named export mismatch.
 
 ### Current Behavior (v8)
+
 - CSS modules use default export: `import styles from './styles.module.css'`
 - This causes warnings but works at runtime
 - Warning example: `export 'default' (imported as 'style') was not found in './HelloWorld.module.css'`
 
 ### Proposed v9 Change
+
 Align with Next.js and modern tooling by using named exports:
 
 1. **Update css-loader configuration:**
+
 ```javascript
 {
   loader: 'css-loader',
@@ -30,30 +34,34 @@ Align with Next.js and modern tooling by using named exports:
 css-loader only allows `'camelCaseOnly'` or `'dashesOnly'` when named exports are enabled.
 
 2. **Update TypeScript types:**
+
 - Ensure proper typing for CSS modules with named exports
 - May need to update or generate `.d.ts` files for CSS modules
 
 3. **Migration guide for users:**
+
 - Document the breaking change
 - Provide codemod or migration script to update imports from:
   ```javascript
-  import styles from './styles.module.css'
+  import styles from "./styles.module.css"
   styles.className
   ```
   to:
   ```javascript
-  import * as styles from './styles.module.css'
+  import * as styles from "./styles.module.css"
   // or
-  import { className } from './styles.module.css'
+  import { className } from "./styles.module.css"
   ```
 
 ### Benefits
+
 - Eliminates webpack/TypeScript warnings
 - Better tree-shaking potential
 - More explicit about what CSS classes are being used
 - Easier interoperability with frameworks that support named exports
 
 ### Implementation Notes
+
 - This is a BREAKING CHANGE and appropriate for major version bump
 - Need to test with both webpack and rspack
 - Consider providing a compatibility mode via configuration option
@@ -63,6 +71,7 @@ css-loader only allows `'camelCaseOnly'` or `'dashesOnly'` when named exports ar
 ## Related Issues from PR #597
 
 ### React Component Not Rendering (spec/dummy) - RESOLVED ✅
+
 - **Issue**: React component was not rendering due to CSS module import mismatch
 - **Symptoms**:
   - Component wasn't rendering "Hello, Stranger!"
@@ -82,6 +91,7 @@ css-loader only allows `'camelCaseOnly'` or `'dashesOnly'` when named exports ar
   - Interactive functionality restored
 
 ### Test Infrastructure
+
 - Successfully implemented dual bundler support (webpack/rspack)
 - test-bundler script working well with status command
 - Consider adding more comprehensive tests for both bundlers

data/bin/export-bundler-config

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // Minimal shim - all logic is in the TypeScript module
-const { run } = require('shakapacker/configExporter')
+const { run } = require("shakapacker/configExporter")
 
 run(process.argv.slice(2))
   .then((exitCode) => process.exit(exitCode))

data/conductor-setup.sh

@@ -33,7 +33,7 @@ $BUNDLE_CMD install
 
 # Install JavaScript dependencies
 echo "📦 Installing JavaScript dependencies..."
-yarn install
+yarn install --frozen-lockfile
 
 # Set up Husky git hooks
 echo "🪝 Setting up Husky git hooks..."

data/conductor.json

@@ -4,4 +4,4 @@
     "run": "bundle exec rspec",
     "archive": ""
   }
-}
+}

data/docs/cdn_setup.md

@@ -64,7 +64,7 @@ Add the `asset_host` setting to your `config/shakapacker.yml`:
 production:
   # ... other settings ...
   asset_host: https://cdn.example.com
-  
+
   # You can also set different CDN hosts per environment
 staging:
   asset_host: https://staging-cdn.example.com
@@ -77,8 +77,8 @@ Configure in your Rails environment file (e.g., `config/environments/production.
 ```ruby
 Rails.application.configure do
   # ... other settings ...
-  
-  # This will be used by Shakapacker if SHAKAPACKER_ASSET_HOST 
+
+  # This will be used by Shakapacker if SHAKAPACKER_ASSET_HOST
   # and asset_host in shakapacker.yml are not set
   config.action_controller.asset_host = 'https://cdn.example.com'
 end
@@ -95,6 +95,7 @@ RAILS_ENV=production bundle exec rails assets:precompile
 ```
 
 This ensures that:
+
 - Webpack's `publicPath` is set to your CDN URL
 - Dynamic imports and code-split chunks load from the CDN
 - Asset manifest references use CDN URLs
@@ -189,9 +190,9 @@ If using code splitting, verify dynamic chunks load from CDN:
 
 ```javascript
 // This dynamic import should load from CDN
-import('./components/HeavyComponent').then(module => {
+import("./components/HeavyComponent").then((module) => {
   // Check Network tab - chunk should load from CDN
-});
+})
 ```
 
 ## Troubleshooting
@@ -201,6 +202,7 @@ import('./components/HeavyComponent').then(module => {
 **Problem**: Assets are still loading from your application domain.
 
 **Solutions**:
+
 1. Ensure you set `SHAKAPACKER_ASSET_HOST` **before** running `assets:precompile`
 2. Clear Rails cache: `rails tmp:cache:clear`
 3. Check the manifest.json file includes CDN URLs:
@@ -213,6 +215,7 @@ import('./components/HeavyComponent').then(module => {
 **Problem**: Browser shows CORS errors when loading assets from CDN.
 
 **Solutions**:
+
 1. Configure your CDN to add CORS headers:
    ```
    Access-Control-Allow-Origin: *
@@ -227,6 +230,7 @@ import('./components/HeavyComponent').then(module => {
 **Problem**: Web fonts fail to load from CDN due to CORS.
 
 **Solutions**:
+
 1. Ensure CDN sends proper CORS headers for font files
 2. In CloudFlare, create a page rule for `*.woff2`, `*.woff`, `*.ttf` files with CORS headers
 3. Consider hosting fonts separately or using base64 encoding
@@ -277,6 +281,7 @@ production:
 ```
 
 Ensure your CDN serves files with CORS headers:
+
 ```
 Access-Control-Allow-Origin: *
 ```
@@ -339,7 +344,7 @@ production:
   compile: false
   cache_manifest: true
   asset_host: <%= ENV.fetch('SHAKAPACKER_ASSET_HOST', 'https://cdn.example.com') %>
-  
+
   # Enable integrity checking
   integrity:
     enabled: true
@@ -352,7 +357,7 @@ production:
 Rails.application.configure do
   # Fallback if SHAKAPACKER_ASSET_HOST is not set
   config.action_controller.asset_host = 'https://cdn.example.com'
-  
+
   # Ensure proper headers for CDN
   config.public_file_server.headers = {
     'Cache-Control' => 'public, max-age=31536000',
@@ -376,4 +381,4 @@ Setting up a CDN with Shakapacker involves:
 3. Compiling assets with the CDN URL
 4. Deploying and verifying the setup
 
-The key is ensuring `SHAKAPACKER_ASSET_HOST` is set during asset compilation so webpack's `publicPath` is configured correctly for dynamic imports and code-split chunks.
+The key is ensuring `SHAKAPACKER_ASSET_HOST` is set during asset compilation so webpack's `publicPath` is configured correctly for dynamic imports and code-split chunks.

data/docs/common-upgrades.md

@@ -2,6 +2,8 @@
 
 This document provides step-by-step instructions for the most common upgrade scenarios in Shakapacker projects.
 
+**📖 For configuration options, see the [Configuration Guide](./configuration.md)**
+
 ## Table of Contents
 
 - [Migrating Package Managers](#migrating-package-managers)
@@ -580,7 +582,6 @@ For maximum performance improvements, you can combine multiple migrations:
 This combination provides the best performance improvement (up to 50-70x faster builds):
 
 1. **First, migrate to SWC** (while still on webpack)
-
    - Follow [Migrating from Babel to SWC](#migrating-from-babel-to-swc)
    - Test thoroughly
    - This is a smaller change to validate first