shakapacker 9.0.0.beta.2 → 9.0.0.beta.3

data/lib/shakapacker/configuration.rb

@@ -68,6 +68,13 @@ class Shakapacker::Configuration
     root_path.join(fetch(:public_root_path))
   end
 
+  def private_output_path
+    private_path = fetch(:private_output_path)
+    return nil unless private_path
+    validate_output_paths!
+    root_path.join(private_path)
+  end
+
   def public_output_path
     public_path.join(fetch(:public_output_path))
   end
@@ -149,6 +156,38 @@ class Shakapacker::Configuration
   end
 
   private
+    def validate_output_paths!
+      # Skip validation if already validated to avoid redundant checks
+      return if @validated_output_paths
+      @validated_output_paths = true
+
+      # Only validate when both paths are configured
+      return unless fetch(:private_output_path) && fetch(:public_output_path)
+
+      private_path_str, public_path_str = resolve_paths_for_comparison
+
+      if private_path_str == public_path_str
+        raise "Shakapacker configuration error: private_output_path and public_output_path must be different. " \
+              "Both paths resolve to '#{private_path_str}'. " \
+              "The private_output_path is for server-side bundles (e.g., SSR) that should not be served publicly."
+      end
+    end
+
+    def resolve_paths_for_comparison
+      private_full_path = root_path.join(fetch(:private_output_path))
+      public_full_path = root_path.join(fetch(:public_root_path), fetch(:public_output_path))
+
+      # Create directories if they don't exist (for testing)
+      private_full_path.mkpath unless private_full_path.exist?
+      public_full_path.mkpath unless public_full_path.exist?
+
+      # Use realpath to resolve symbolic links and relative paths
+      [private_full_path.realpath.to_s, public_full_path.realpath.to_s]
+    rescue Errno::ENOENT
+      # If paths don't exist yet, fall back to cleanpath for comparison
+      [private_full_path.cleanpath.to_s, public_full_path.cleanpath.to_s]
+    end
+
     def data
       @data ||= load
     end

data/lib/shakapacker/version.rb

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

data/package/index.d.ts

@@ -9,6 +9,7 @@ declare module "shakapacker" {
     css_extract_ignore_order_warnings: boolean
     public_root_path: string
     public_output_path: string
+    private_output_path?: string
     cache_path: string
     webpack_compile_output: boolean
     shakapacker_precompile: boolean
@@ -23,6 +24,14 @@ declare module "shakapacker" {
     publicPath: string
     publicPathWithoutCDN: string
     manifestPath: string
+    manifest_path?: string
+    assets_bundler?: string
+    dev_server?: DevServerConfig
+    integrity?: {
+      enabled: boolean
+      cross_origin: string
+      hash_functions?: string[]
+    }
   }
 
   export interface Env {
@@ -60,6 +69,8 @@ declare module "shakapacker" {
     ipc?: boolean | string
     magic_html?: boolean
     live_reload?: boolean
+    inline_css?: boolean
+    env_prefix?: string
     open?:
       | boolean
       | string
@@ -136,4 +147,4 @@ declare module "shakapacker/package/babel/preset.js" {
   ) => TransformOptions & RequiredTransformOptions
 
   export = defaultConfigFunc
-}
+}

data/package/rules/rspack.js

@@ -12,6 +12,8 @@ debug("Adding JavaScript rule with builtin:swc-loader")
 rules.push({
   test: /\.(js|jsx|mjs)$/,
   exclude: /node_modules/,
+  // The 'type' field is required for Rspack to properly handle JavaScript modules
+  // when using builtin loaders. It ensures correct module parsing and transformation.
   type: "javascript/auto",
   use: [
     {
@@ -38,6 +40,8 @@ debug("Adding TypeScript rule with builtin:swc-loader")
 rules.push({
   test: /\.(ts|tsx)$/,
   exclude: /node_modules/,
+  // The 'type' field is required for Rspack to properly handle TypeScript modules
+  // when using builtin loaders. It ensures correct module parsing and transformation.
   type: "javascript/auto",
   use: [
     {

data/package/utils/getStyleRule.js

@@ -3,6 +3,7 @@ const { canProcess, moduleExists } = require("./helpers")
 const { requireOrError } = require("./requireOrError")
 const config = require("../config")
 const inliningCss = require("./inliningCss")
+const { validateCssModulesConfig } = require("./validateCssModulesConfig")
 
 const getStyleRule = (test, preprocessors = []) => {
   if (moduleExists("css-loader")) {
@@ -19,17 +20,25 @@ const getStyleRule = (test, preprocessors = []) => {
         ? requireOrError("@rspack/core").CssExtractRspackPlugin.loader
         : requireOrError("mini-css-extract-plugin").loader
 
+    const cssLoaderOptions = {
+      sourceMap: true,
+      importLoaders: 2,
+      modules: {
+        auto: true,
+        // v9 defaults: named exports with camelCase conversion
+        namedExport: true,
+        exportLocalsConvention: "camelCase"
+      }
+    }
+
+    // Validate CSS modules configuration
+    validateCssModulesConfig(cssLoaderOptions)
+
     const use = [
       inliningCss ? "style-loader" : extractionPlugin,
       {
         loader: require.resolve("css-loader"),
-        options: {
-          sourceMap: true,
-          importLoaders: 2,
-          modules: {
-            auto: true
-          }
-        }
+        options: cssLoaderOptions
       },
       tryPostcss(),
       ...preprocessors

data/package/utils/validateCssModulesConfig.js

@@ -0,0 +1,91 @@
+/* eslint global-require: 0 */
+const { warn } = require("./debug")
+
+/**
+ * Validates CSS modules configuration and warns about potential issues
+ * with v9 defaults or conflicting settings.
+ */
+const validateCssModulesConfig = (cssLoaderOptions) => {
+  // Skip validation in production by default for performance
+  if (
+    process.env.NODE_ENV === "production" &&
+    process.env.SHAKAPACKER_VALIDATE_CSS_MODULES !== "true"
+  ) {
+    return
+  }
+
+  if (!cssLoaderOptions || !cssLoaderOptions.modules) {
+    return
+  }
+
+  const { modules } = cssLoaderOptions
+
+  // Check for conflicting namedExport and esModule settings
+  if (modules.namedExport === true && modules.esModule === false) {
+    warn(
+      "⚠️  CSS Modules Configuration Warning:\n" +
+        "    namedExport: true with esModule: false may cause issues.\n" +
+        "    Consider setting esModule: true or removing it (defaults to true)."
+    )
+  }
+
+  // Check for v8-style configuration with v9
+  if (modules.namedExport === false) {
+    warn(
+      "ℹ️  CSS Modules Configuration Note:\n" +
+        "    You are using namedExport: false (v8 behavior).\n" +
+        "    Shakapacker v9 defaults to namedExport: true for better tree-shaking.\n" +
+        "    See docs/css-modules-export-mode.md for migration instructions."
+    )
+  }
+
+  // Check for inconsistent exportLocalsConvention with namedExport
+  if (
+    modules.namedExport === true &&
+    modules.exportLocalsConvention === "asIs"
+  ) {
+    warn(
+      "⚠️  CSS Modules Configuration Warning:\n" +
+        "    Using namedExport: true with exportLocalsConvention: 'asIs' may cause issues\n" +
+        "    with kebab-case class names (e.g., 'my-button').\n" +
+        "    Consider using exportLocalsConvention: 'camelCase' (v9 default)."
+    )
+  }
+
+  // Check for deprecated localIdentName pattern
+  if (
+    modules.localIdentName &&
+    modules.localIdentName.includes("[hash:base64]")
+  ) {
+    warn(
+      "⚠️  CSS Modules Configuration Warning:\n" +
+        "    [hash:base64] is deprecated in css-loader v6+.\n" +
+        "    Use [hash] instead for better compatibility."
+    )
+  }
+
+  // Check for potential TypeScript issues
+  if (
+    modules.namedExport === true &&
+    process.env.SHAKAPACKER_ASSET_COMPILER_TYPESCRIPT === "true"
+  ) {
+    warn(
+      "ℹ️  TypeScript CSS Modules Note:\n" +
+        "    With namedExport: true, TypeScript projects should use:\n" +
+        "    import * as styles from './styles.module.css'\n" +
+        "    instead of: import styles from './styles.module.css'\n" +
+        "    See docs/css-modules-export-mode.md for TypeScript setup."
+    )
+  }
+
+  // Check for auto: true with getLocalIdent (potential conflict)
+  if (modules.auto === true && modules.getLocalIdent) {
+    warn(
+      "⚠️  CSS Modules Configuration Warning:\n" +
+        "    Using both 'auto: true' and 'getLocalIdent' may cause conflicts.\n" +
+        "    The 'auto' option determines which files are treated as CSS modules."
+    )
+  }
+}
+
+module.exports = { validateCssModulesConfig }