shakapacker 9.3.0.beta.0 → 9.3.0.beta.2

data/docs/v9_upgrade.md

@@ -4,6 +4,15 @@ This guide outlines new features, breaking changes, and migration steps for upgr
 
 **📖 For detailed configuration options, see the [Configuration Guide](./configuration.md)**
 
+> **⚠️ Important:** Shakapacker is both a Ruby gem AND an npm package. **You must update BOTH**:
+>
+> - Update the version in `Gemfile`
+> - Update the version in `package.json`
+> - Run `bundle update shakapacker`
+> - Run your package manager install command (`yarn install`, `npm install`, or `pnpm install`)
+>
+> See [Migration Steps](#migration-steps) below for detailed instructions including version format differences and testing.
+
 > **⚠️ Important for v9.1.0 Users:** If you're upgrading to v9.1.0 or later, please note the [SWC Configuration Breaking Change](#swc-loose-mode-breaking-change-v910) below. This affects users who previously configured SWC in v9.0.0.
 
 ## New Features
@@ -264,15 +273,49 @@ You won't get warnings about missing Babel, Rspack, or esbuild packages.
 
 ## Migration Steps
 
-### Step 1: Update Dependencies
+> **💡 Tip:** For general upgrade instructions applicable to all Shakapacker versions, see [Upgrading Shakapacker](./common-upgrades.md#upgrading-shakapacker) in the Common Upgrades guide.
+
+### Step 1: Update Gemfile
+
+Update the shakapacker version in your `Gemfile`:
+
+```ruby
+# Gemfile
+gem "shakapacker", "9.3.0"  # or latest version
+```
+
+**Note:** Ruby gems use dot notation for pre-release versions (e.g., `9.3.0.beta.1`), while npm uses hyphen notation (e.g., `9.3.0-beta.1`). See [Version Format Differences](#version-format-differences) below.
+
+### Step 2: Update package.json
+
+Update the shakapacker version in your `package.json`:
+
+```json
+{
+  "dependencies": {
+    "shakapacker": "9.3.0"
+  }
+}
+```
+
+**Note:** For pre-release versions, npm uses hyphen notation (e.g., `"shakapacker": "9.3.0-beta.1"`).
+
+### Step 3: Install Updates
+
+Run both bundler and your package manager:
 
 ```bash
-npm update shakapacker@^9.0.0
-# or
-yarn upgrade shakapacker@^9.0.0
+# Update Ruby gem
+bundle update shakapacker
+
+# Update npm package (choose one based on your package manager)
+yarn install      # if using Yarn
+npm install       # if using npm
+pnpm install      # if using pnpm
+bun install       # if using Bun
 ```
 
-### Step 2: Update CSS Module Imports
+### Step 4: Update CSS Module Imports
 
 #### For each CSS module import:
 
@@ -299,7 +342,7 @@ declare module "*.module.css" {
 }
 ```
 
-### Step 3: Handle Kebab-Case Class Names
+### Step 5: Handle Kebab-Case Class Names
 
 v9 automatically converts kebab-case to camelCase with `exportLocalsConvention: 'camelCaseOnly'`:
 
@@ -340,7 +383,7 @@ const buttonClass = styles['my-button'];
 
 **Note:** With `'camelCaseOnly'` (default) or `'dashesOnly'`, only one version is exported. If you need both the original and camelCase versions, you would need to use `'camelCase'` instead, but this requires `namedExport: false` (v8 behavior). See the [CSS Modules Export Mode documentation](./css-modules-export-mode.md) for details on reverting to v8 behavior.
 
-### Step 4: Update Configuration Files
+### Step 6: Update Configuration Files
 
 If you have `webpack_loader` in your configuration:
 
@@ -353,7 +396,7 @@ If you have `webpack_loader` in your configuration:
 javascript_transpiler: "babel"
 ```
 
-### Step 5: Run Tests
+### Step 7: Run Tests
 
 ```bash
 # Run your test suite
@@ -366,6 +409,45 @@ bin/shakapacker
 bin/shakapacker-dev-server
 ```
 
+## Version Format Differences
+
+Shakapacker version numbers differ between the Ruby gem and npm package for pre-release versions:
+
+| Version Type | Ruby Gem (Gemfile) | npm Package (package.json) |
+| ------------ | ------------------ | -------------------------- |
+| Stable       | `"9.3.0"`          | `"9.3.0"`                  |
+| Pre-release  | `"9.3.0.beta.1"`   | `"9.3.0-beta.1"`           |
+
+**Examples:**
+
+```ruby
+# Gemfile - uses dots for pre-release versions
+gem "shakapacker", "9.3.0"         # stable
+gem "shakapacker", "9.3.0.beta.1"  # pre-release
+```
+
+Stable version in package.json:
+
+```json
+{
+  "dependencies": {
+    "shakapacker": "9.3.0"
+  }
+}
+```
+
+Pre-release version in package.json:
+
+```json
+{
+  "dependencies": {
+    "shakapacker": "9.3.0-beta.1"
+  }
+}
+```
+
+This is due to different versioning conventions between RubyGems (which uses dots) and npm (which follows semantic versioning with hyphens for pre-release identifiers).
+
 ## Troubleshooting
 
 ### CSS Classes Not Applying

data/eslint.config.js

@@ -14,11 +14,16 @@ module.exports = [
   // Global ignores (replaces .eslintignore)
   {
     ignores: [
-      "lib/**",
-      "**/node_modules/**",
-      "vendor/**",
-      "spec/**",
-      "package/**" // TODO: Remove after issue #644 is resolved (lints package/ TS source files)
+      "lib/**", // Ruby files, not JavaScript
+      "**/node_modules/**", // Third-party dependencies
+      "vendor/**", // Vendored dependencies
+      "spec/**", // Ruby specs, not JavaScript
+      "package/**/*.js", // Generated/compiled JavaScript from TypeScript
+      "package/**/*.d.ts", // Generated TypeScript declaration files
+      // Temporarily ignore TypeScript files until technical debt is resolved
+      // See ESLINT_TECHNICAL_DEBT.md for tracking
+      // TODO: Remove this once ESLint issues are fixed (tracked in #723)
+      "package/**/*.ts"
     ]
   },
 
@@ -52,7 +57,11 @@ module.exports = [
       "import/no-extraneous-dependencies": "off",
       // TypeScript handles extensions, not needed for JS imports
       "import/extensions": "off",
-      indent: ["error", 2]
+      indent: ["error", 2],
+      // Allow for...of loops - modern JS syntax, won't pollute client code
+      "no-restricted-syntax": "off",
+      // Allow console statements - used for debugging/logging throughout
+      "no-console": "off"
     },
     settings: {
       react: {
@@ -131,7 +140,114 @@ module.exports = [
       // Strict: no 'any' types allowed - use 'unknown' or specific types instead
       "@typescript-eslint/no-explicit-any": "error",
       // Allow implicit return types - TypeScript can infer them
-      "@typescript-eslint/explicit-module-boundary-types": "off"
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      // Disable no-undef for TypeScript - TypeScript compiler handles this
+      // This prevents false positives for ambient types like NodeJS.ProcessEnv
+      "no-undef": "off"
+    }
+  },
+
+  // Temporary overrides for files with remaining errors
+  // See ESLINT_TECHNICAL_DEBT.md for detailed documentation
+  //
+  // These overrides suppress ~172 errors that require either:
+  // 1. Major type refactoring (any/unsafe-* rules)
+  // 2. Potential breaking changes (module system)
+  // 3. Significant code restructuring
+  //
+  // GitHub Issues tracking this technical debt:
+  // - #707: TypeScript: Refactor configExporter module for type safety
+  // - #708: Module System: Modernize to ES6 modules with codemod
+  // - #709: Code Style: Fix remaining ESLint style issues
+  {
+    // Consolidated override for package/config.ts and package/babel/preset.ts
+    // Combines rules from both previous override blocks to avoid duplication
+    files: ["package/babel/preset.ts", "package/config.ts"],
+    rules: {
+      // From first override block
+      "@typescript-eslint/no-require-imports": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "import/order": "off",
+      "import/newline-after-import": "off",
+      "import/first": "off",
+      // Additional rules that were in the second override for config.ts
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "no-useless-escape": "off",
+      "no-continue": "off",
+      "no-nested-ternary": "off"
+    }
+  },
+  {
+    files: ["package/configExporter/**/*.ts"],
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-unsafe-function-type": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/require-await": "off",
+      "no-param-reassign": "off",
+      "no-await-in-loop": "off",
+      "no-nested-ternary": "off",
+      "import/prefer-default-export": "off",
+      "global-require": "off",
+      "no-underscore-dangle": "off"
+    }
+  },
+  {
+    // Remaining utils files (removed package/config.ts from this block)
+    files: [
+      "package/utils/inliningCss.ts",
+      "package/utils/errorCodes.ts",
+      "package/utils/errorHelpers.ts",
+      "package/utils/pathValidation.ts"
+    ],
+    rules: {
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "no-useless-escape": "off",
+      "no-continue": "off",
+      "no-nested-ternary": "off"
+    }
+  },
+  {
+    files: ["package/plugins/**/*.ts", "package/optimization/**/*.ts"],
+    rules: {
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-redundant-type-constituents": "off",
+      "import/prefer-default-export": "off"
+    }
+  },
+  {
+    files: [
+      "package/environments/**/*.ts",
+      "package/index.ts",
+      "package/rspack/index.ts",
+      "package/rules/**/*.ts",
+      "package/swc/index.ts",
+      "package/esbuild/index.ts",
+      "package/dev_server.ts",
+      "package/env.ts"
+    ],
+    rules: {
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/no-redundant-type-constituents": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/no-unsafe-function-type": "off",
+      "import/prefer-default-export": "off",
+      "no-underscore-dangle": "off"
     }
   },
 

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/runner.rb

@@ -379,7 +379,7 @@ module Shakapacker
           return rspack_path
         end
 
-        # Fallback to webpack config with deprecation warning
+        # Fallback to webpack config in the configured directory
         webpack_paths = %w[ts js].map do |ext|
           File.join(@app_path, config_dir, "webpack.config.#{ext}")
         end
@@ -393,6 +393,29 @@ module Shakapacker
           return webpack_path
         end
 
+        # Backward compatibility: Check config/webpack/ if we were looking in config/rspack/
+        # This supports upgrades from versions where rspack used config/webpack/
+        if config_dir == "config/rspack"
+          webpack_dir_paths = %w[ts js].map do |ext|
+            File.join(@app_path, "config/webpack", "webpack.config.#{ext}")
+          end
+
+          puts "[Shakapacker] Checking config/webpack/ for backward compatibility..."
+          webpack_dir_path = webpack_dir_paths.find { |f| File.exist?(f) }
+          if webpack_dir_path
+            $stderr.puts "⚠️  DEPRECATION WARNING: Found webpack config in config/webpack/ but assets_bundler is set to 'rspack'."
+            $stderr.puts "   For rspack, configs should be in config/rspack/ directory."
+            $stderr.puts "   "
+            $stderr.puts "   To fix this, either:"
+            $stderr.puts "   1. Move your config: mv config/webpack config/rspack"
+            $stderr.puts "   2. Set assets_bundler_config_path in config/shakapacker.yml:"
+            $stderr.puts "      assets_bundler_config_path: config/webpack"
+            $stderr.puts "   "
+            $stderr.puts "   Using: #{webpack_dir_path}"
+            return webpack_dir_path
+          end
+        end
+
         # No config found
         print_config_not_found_error("rspack", rspack_paths.last, config_dir)
         exit(1)

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.2".freeze
 end