shakapacker 8.4.0 → 9.7.0

data/Rakefile

@@ -2,6 +2,11 @@
 require "bundler/gem_tasks"
 require "pathname"
 
+# Remove Bundler's default `release` task — it bypasses the custom release flow
+# (CHANGELOG version detection, npm publish, GitHub release sync, etc.).
+# The custom `release` task in rakelib/release.rake replaces it.
+Rake::Task[:release].clear
+
 desc "Run all specs"
 task test: ["run_spec:all_specs"]
 
@@ -14,16 +19,51 @@ namespace :run_spec do
     sh("bundle exec rspec spec/shakapacker/*_spec.rb")
   end
 
-  desc "Run specs in the dummy app"
+  desc "Run specs in the dummy app with webpack"
   task :dummy do
-    puts "Running dummy app specs"
+    puts "Running dummy app specs with webpack"
+    spec_dummy_dir = Pathname.new(File.join("spec", "dummy")).realpath
+    Bundler.with_unbundled_env do
+      sh_in_dir(".", "yalc publish")
+      sh_in_dir(spec_dummy_dir, [
+        "bundle install",
+        "yalc link shakapacker",
+        "npm install",
+        "bin/test-bundler webpack",
+        "NODE_ENV=test RAILS_ENV=test bin/shakapacker",
+        "bundle exec rspec"
+      ])
+    end
+  end
+
+  desc "Run specs in the dummy app with rspack"
+  task :dummy_with_rspack do
+    puts "Running dummy app specs with rspack"
     spec_dummy_dir = Pathname.new(File.join("spec", "dummy")).realpath
     Bundler.with_unbundled_env do
       sh_in_dir(".", "yalc publish")
       sh_in_dir(spec_dummy_dir, [
         "bundle install",
         "yalc link shakapacker",
-        "yarn install",
+        "npm install",
+        "bin/test-bundler rspack",
+        "NODE_ENV=test RAILS_ENV=test bin/shakapacker",
+        "bundle exec rspec"
+      ])
+    end
+  end
+
+  desc "Run specs in the dummy-rspack app"
+  task :dummy_rspack do
+    puts "Running dummy-rspack app specs"
+    spec_dummy_dir = Pathname.new(File.join("spec", "dummy-rspack")).realpath
+    Bundler.with_unbundled_env do
+      sh_in_dir(".", "yalc publish")
+      sh_in_dir(spec_dummy_dir, [
+        "bundle install",
+        "yalc link shakapacker",
+        "npm install",
+        "NODE_ENV=test RAILS_ENV=test npm exec --no -- rspack build --config config/rspack/rspack.config.js",
         "bundle exec rspec"
       ])
     end
@@ -35,7 +75,7 @@ namespace :run_spec do
   end
 
   desc "Run all specs"
-  task all_specs: %i[gem dummy generator] do
+  task all_specs: %i[gem dummy dummy_with_rspack dummy_rspack generator] do
     puts "Completed all RSpec tests"
   end
 end

data/TODO.md

@@ -0,0 +1,58 @@
+# TypeScript Migration Status
+
+## ✅ Completed (PR #602)
+
+- Enhanced `package/index.d.ts` with comprehensive type definitions
+- Added TypeScript type packages for better IDE support
+- Improved Config and DevServerConfig interfaces
+- Added missing properties (private_output_path, inline_css, env_prefix, etc.)
+- All tests passing
+- Zero JavaScript modifications (no whitespace changes)
+- Full backward compatibility maintained
+
+## 📋 Next Steps (Issue #605)
+
+### Phase 2: Core Module Conversion
+
+- [ ] Convert `package/config.js` to TypeScript
+- [ ] Convert `package/env.js` to TypeScript
+- [ ] Convert `package/index.js` to TypeScript
+- [ ] Convert `package/utils/helpers.js` to TypeScript
+
+### Phase 3: Environment & Build System
+
+- [ ] Convert environment files (base, development, production, test)
+- [ ] Convert dev_server.js
+- [ ] Convert webpackDevServerConfig.js
+
+### Phase 4: Rules & Loaders (PR #620) ✅
+
+- [x] Convert all files in `package/rules/`
+- [x] Convert all files in `package/plugins/`
+- [x] Convert all files in `package/optimization/`
+
+### Phase 5: Framework-Specific Modules ✅
+
+- [x] Convert rspack support files
+- [x] Convert swc support files
+- [x] Convert esbuild support files
+- [x] Convert babel preset
+
+### Phase 6: Final Cleanup ✅
+
+- [x] Add TypeScript linting with @typescript-eslint
+- [x] Verify strict mode is enabled (already configured)
+- [x] Update documentation
+
+## Why Gradual Migration?
+
+- **Lower risk**: Each phase can be tested independently
+- **Team learning**: Get familiar with TypeScript incrementally
+- **Immediate value**: Type definitions already provide IDE benefits
+- **No breaking changes**: Users unaffected during migration
+
+## Related Links
+
+- Original issue: #200
+- Initial PR: #602
+- Next steps issue: #605

data/TODO_v9.md

@@ -0,0 +1,97 @@
+# Shakapacker v9 TODO List
+
+## 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',
+  options: {
+    modules: {
+      namedExport: true,
+      exportLocalsConvention: 'camelCaseOnly'  // Must be 'camelCaseOnly' or 'dashesOnly' with namedExport: true
+    }
+  }
+}
+```
+
+**Note:** Using `exportLocalsConvention: 'camelCase'` with `namedExport: true` will cause a build error.
+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"
+  styles.className
+  ```
+  to:
+  ```javascript
+  import * as styles from "./styles.module.css"
+  // or
+  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
+
+---
+
+## 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!"
+  - Input field not rendered, making interactive test fail
+  - Only the static H1 "Hello, World!" was visible
+- **Resolution**:
+  - Fixed CSS module import syntax from `import style from` to `import * as style from`
+  - This matched webpack's named exports configuration for CSS modules
+  - Tests now pass with both React 18.3.1 and webpack/rspack configurations
+- **Root Cause**: CSS module import/export mismatch
+  - Webpack was configured to use named exports for CSS modules
+  - TypeScript code was using default import syntax
+  - This caused `style` to be undefined, breaking SSR and client rendering
+- **Status**: FIXED
+  - All tests re-enabled and passing
+  - Both SSR and client-side rendering working
+  - 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/conductor-exec

@@ -0,0 +1,24 @@
+#!/bin/zsh
+# Wrapper script to run commands in Conductor with proper tool versions
+# Usage: bin/conductor-exec <command> [args...]
+#
+# This is needed because Conductor (and other non-interactive shells) don't
+# source .zshrc, so version manager PATH configuration isn't active by default.
+#
+# - If mise is available: uses `mise exec` for correct tool versions
+# - Otherwise: falls back to direct execution (for asdf/rbenv/nvm users)
+#
+# Examples:
+#   bin/conductor-exec ruby --version       # Uses correct Ruby version
+#   bin/conductor-exec bundle exec rubocop  # Correct Ruby for linting
+#   bin/conductor-exec git commit -m "msg"  # Pre-commit hooks work correctly
+#   bin/conductor-exec yarn install         # Uses correct Node version
+#
+# See: https://github.com/shakacode/react_on_rails-demos/issues/105
+
+if command -v mise &> /dev/null; then
+  exec mise exec -- "$@"
+else
+  # Fall back to direct execution for non-mise users
+  exec "$@"
+fi

data/bin/shakapacker-config

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

data/conductor-setup.sh

@@ -0,0 +1,147 @@
+#!/bin/zsh
+set -euo pipefail
+
+echo "🔧 Setting up Shakapacker workspace..."
+
+# Detect and initialize version manager
+# Supports: mise, asdf, or direct PATH (rbenv/nvm/nodenv already in PATH)
+VERSION_MANAGER="none"
+
+echo "📋 Detecting version manager..."
+
+if command -v mise &> /dev/null; then
+    VERSION_MANAGER="mise"
+    echo "✅ Found mise"
+    # Trust mise config for current directory only
+    mise trust 2>/dev/null || true
+elif [[ -f ~/.asdf/asdf.sh ]]; then
+    VERSION_MANAGER="asdf"
+    source ~/.asdf/asdf.sh
+    echo "✅ Found asdf (from ~/.asdf/asdf.sh)"
+elif command -v asdf &> /dev/null; then
+    VERSION_MANAGER="asdf"
+    # For homebrew-installed asdf
+    if [[ -f /opt/homebrew/opt/asdf/libexec/asdf.sh ]]; then
+        source /opt/homebrew/opt/asdf/libexec/asdf.sh
+    fi
+    echo "✅ Found asdf"
+else
+    echo "ℹ️  No version manager detected, using system PATH"
+    echo "   (Assuming rbenv/nvm/nodenv or system tools are already configured)"
+fi
+
+# Ensure version config exists for asdf/mise users
+if [[ "$VERSION_MANAGER" != "none" ]] && [[ ! -f .tool-versions ]] && [[ ! -f .mise.toml ]]; then
+    echo "📝 Creating .tool-versions from project version files..."
+
+    # Read Ruby version from .ruby-version or use default
+    if [[ -f .ruby-version ]]; then
+        RUBY_VER=$(cat .ruby-version | tr -d '[:space:]')
+    else
+        RUBY_VER="3.3.4"  # Default: recent stable Ruby
+    fi
+
+    # Read Node version from .node-version or use default
+    if [[ -f .node-version ]]; then
+        NODE_VER=$(cat .node-version | tr -d '[:space:]')
+    else
+        NODE_VER="20.18.0"  # Default: LTS Node
+    fi
+
+    cat > .tool-versions << EOF
+ruby $RUBY_VER
+nodejs $NODE_VER
+EOF
+    echo "   Using Ruby $RUBY_VER, Node $NODE_VER"
+fi
+
+# Install tools via mise (after .tool-versions exists)
+if [[ "$VERSION_MANAGER" == "mise" ]]; then
+    echo "📦 Installing tools via mise..."
+    mise install
+fi
+
+# Helper function to run commands with the detected version manager
+run_cmd() {
+    if [[ "$VERSION_MANAGER" == "mise" ]] && [[ -x "bin/conductor-exec" ]]; then
+        bin/conductor-exec "$@"
+    else
+        "$@"
+    fi
+}
+
+# Check required tools
+echo "📋 Checking required tools..."
+run_cmd ruby --version >/dev/null 2>&1 || { echo "❌ Error: Ruby is not installed or not in PATH."; exit 1; }
+run_cmd node --version >/dev/null 2>&1 || { echo "❌ Error: Node.js is not installed or not in PATH."; exit 1; }
+
+# Check Ruby version
+RUBY_VERSION=$(run_cmd ruby -v | awk '{print $2}')
+MIN_RUBY_VERSION="2.7.0"
+if [[ $(echo -e "$MIN_RUBY_VERSION\n$RUBY_VERSION" | sort -V | head -n1) != "$MIN_RUBY_VERSION" ]]; then
+    echo "❌ Error: Ruby version $RUBY_VERSION is too old. Shakapacker requires Ruby >= 2.7.0"
+    echo "   Please upgrade Ruby using your version manager or system package manager."
+    exit 1
+fi
+echo "✅ Ruby version: $RUBY_VERSION"
+
+# Check Node version
+NODE_VERSION=$(run_cmd node -v | cut -d'v' -f2)
+MIN_NODE_VERSION="14.0.0"
+if [[ $(echo -e "$MIN_NODE_VERSION\n$NODE_VERSION" | sort -V | head -n1) != "$MIN_NODE_VERSION" ]]; then
+    echo "❌ Error: Node.js version v$NODE_VERSION is too old. Shakapacker requires Node.js >= 14.0.0"
+    echo "   Please upgrade Node.js using your version manager or system package manager."
+    exit 1
+fi
+echo "✅ Node.js version: v$NODE_VERSION"
+
+# Copy any environment files from root if they exist
+if [ -n "${CONDUCTOR_ROOT_PATH:-}" ]; then
+    if [ -f "$CONDUCTOR_ROOT_PATH/.env" ]; then
+        echo "📝 Copying .env file..."
+        cp "$CONDUCTOR_ROOT_PATH/.env" .env
+    fi
+
+    if [ -f "$CONDUCTOR_ROOT_PATH/.env.local" ]; then
+        echo "📝 Copying .env.local file..."
+        cp "$CONDUCTOR_ROOT_PATH/.env.local" .env.local
+    fi
+fi
+
+# Install Ruby dependencies
+echo "💎 Installing Ruby dependencies..."
+run_cmd bundle install
+
+# Install JavaScript dependencies
+echo "📦 Installing JavaScript dependencies..."
+run_cmd yarn install --frozen-lockfile
+
+# Set up Husky git hooks
+echo "🪝 Setting up Husky git hooks..."
+run_cmd npx husky
+if [ ! -f .husky/pre-commit ]; then
+    echo "Creating pre-commit hook..."
+    cat > .husky/pre-commit << 'EOF'
+#!/usr/bin/env sh
+npx lint-staged
+EOF
+    chmod +x .husky/pre-commit
+fi
+
+# Verify linting tools are available
+echo "✅ Verifying linting tools..."
+run_cmd bundle exec rubocop --version
+
+echo "✨ Workspace setup complete!"
+echo ""
+echo "📚 Key commands:"
+echo "  • bundle exec rspec - Run Ruby tests"
+echo "  • bundle exec rake run_spec:gem - Run gem-specific tests"
+echo "  • yarn test - Run JavaScript tests"
+echo "  • yarn lint - Run JavaScript linting"
+echo "  • bundle exec rubocop - Run Ruby linting (required before commits)"
+echo ""
+if [[ "$VERSION_MANAGER" == "mise" ]]; then
+    echo "💡 Tip: Use 'bin/conductor-exec <command>' if tool versions aren't detected correctly."
+fi
+echo "⚠️ Remember: Always run 'bundle exec rubocop' before committing!"

data/conductor.json

@@ -0,0 +1,9 @@
+{
+  "scripts": {
+    "setup": "./conductor-setup.sh",
+    "run": "bin/conductor-exec bundle exec rspec",
+    "test": "bin/conductor-exec bundle exec rspec",
+    "lint": "bin/conductor-exec bundle exec rubocop && bin/conductor-exec yarn lint",
+    "archive": ""
+  }
+}