shakapacker 9.3.0.beta.2 → 9.3.0.beta.4

data/package/configExporter/configFile.ts

@@ -11,19 +11,19 @@ import {
 /**
  * Loads and validates bundler configuration files
  * @example
- * const loader = new ConfigFileLoader('.bundler-config.yml')
+ * const loader = new ConfigFileLoader('config/shakapacker-builds.yml')
  * const config = loader.load()
  */
 export class ConfigFileLoader {
   private configFilePath: string
 
   /**
-   * @param configFilePath - Path to config file (defaults to .bundler-config.yml in cwd)
+   * @param configFilePath - Path to config file (defaults to config/shakapacker-builds.yml in cwd)
    * @throws Error if path is outside project directory
    */
   constructor(configFilePath?: string) {
     this.configFilePath =
-      configFilePath || resolve(process.cwd(), ".bundler-config.yml")
+      configFilePath || resolve(process.cwd(), "config/shakapacker-builds.yml")
     this.validateConfigPath()
   }
 
@@ -80,7 +80,7 @@ export class ConfigFileLoader {
     if (!this.exists()) {
       throw new Error(
         `Config file not found: ${this.configFilePath}\n` +
-          `Run 'bin/export-bundler-config --init' to generate a sample config file.`
+          `Run 'bin/shakapacker-config --init' to generate a sample config file.`
       )
     }
 
@@ -124,8 +124,16 @@ export class ConfigFileLoader {
     for (const [name, build] of Object.entries(config.builds)) {
       // Guard: ensure build is a non-null plain object
       if (build == null || typeof build !== "object" || Array.isArray(build)) {
+        let buildType: string
+        if (build === null) {
+          buildType = "null"
+        } else if (Array.isArray(build)) {
+          buildType = "array"
+        } else {
+          buildType = typeof build
+        }
         throw new Error(
-          `Invalid build '${name}': must be an object, got ${build === null ? "null" : Array.isArray(build) ? "array" : typeof build}`
+          `Invalid build '${name}': must be an object, got ${buildType}`
         )
       }
 
@@ -373,66 +381,97 @@ export class ConfigFileLoader {
  * Generates a sample configuration file with examples and documentation
  * @returns YAML content as string ready to be written to file
  */
-export function generateSampleConfigFile(): string {
+export function generateSampleConfigFile(ssr: boolean = false): string {
   // Using ${'$'} to escape template literal substitution in comments
+  if (ssr) {
+    return generateSSRConfigFile()
+  }
+
   return `# Bundler Build Configurations
-# Generated by: bin/export-bundler-config --init
+# Generated by: bin/shakapacker-config --init
 #
-# This file defines build configurations for exporting bundler configs.
-# You can define multiple builds with different environments and settings.
-
-# Use these builds as defaults for --doctor mode (optional)
-# When set to true, --doctor will export ALL builds defined below instead of hardcoded defaults
-# shakapacker_doctor_default_builds_here: true
-
-# Default bundler for all builds (can be overridden per-build or with --webpack/--rspack flags)
-default_bundler: rspack  # Options: webpack | rspack
+# Run builds with: bin/shakapacker --build <name>
+# List builds: bin/shakapacker --list-builds
 
 builds:
-  # ============================================================================
+  # ===========================================================================
   # DEVELOPMENT WITH HMR (Hot Module Replacement)
-  # ============================================================================
-  # For Procfile.dev: WEBPACK_SERVE=true bin/shakapacker-dev-server
-  # Creates client bundle with React Fast Refresh enabled
-
+  # ===========================================================================
   dev-hmr:
     description: Client bundle with HMR (React Fast Refresh)
+    dev_server: true  # Auto-delegates to bin/shakapacker-dev-server
     environment:
       NODE_ENV: development
       RAILS_ENV: development
-      WEBPACK_SERVE: "true"
+      WEBPACK_SERVE: true
     outputs:
       - client
 
-  # ============================================================================
-  # DEVELOPMENT (Standard)
-  # ============================================================================
-  # For Procfile.dev-static-assets: bin/shakapacker --watch
-  # Creates both client and server bundles without HMR
-
+  # ===========================================================================
+  # DEVELOPMENT (Standard - no HMR)
+  # ===========================================================================
   dev:
-    description: Development client and server bundles (no HMR)
+    description: Development client bundle
     environment:
       NODE_ENV: development
       RAILS_ENV: development
     outputs:
       - client
-      - server
 
-  # ============================================================================
+  # ===========================================================================
   # PRODUCTION
-  # ============================================================================
-  # For asset precompilation: RAILS_ENV=production bin/shakapacker
-  # Creates optimized production bundles
-
+  # ===========================================================================
   prod:
-    description: Production client and server bundles
+    description: Production client bundle
     environment:
       NODE_ENV: production
       RAILS_ENV: production
     outputs:
       - client
-      - server
+
+  # ===========================================================================
+  # REACT ON RAILS WITH SSR (Uncomment to enable)
+  # ===========================================================================
+  # Run separate client and server bundles for server-side rendering
+  # For more info: https://github.com/shakacode/react_on_rails
+
+  # dev-client-hmr:
+  #   description: Development client bundle with HMR for SSR
+  #   dev_server: true
+  #   environment:
+  #     NODE_ENV: development
+  #     RAILS_ENV: development
+  #     WEBPACK_SERVE: "true"
+  #     CLIENT_BUNDLE_ONLY: "yes"
+  #   outputs:
+  #     - client
+
+  # dev-server:
+  #   description: Development server bundle for SSR
+  #   environment:
+  #     NODE_ENV: development
+  #     RAILS_ENV: development
+  #     SERVER_BUNDLE_ONLY: "yes"
+  #   outputs:
+  #     - server
+
+  # prod-client:
+  #   description: Production client bundle for SSR
+  #   environment:
+  #     NODE_ENV: production
+  #     RAILS_ENV: production
+  #     CLIENT_BUNDLE_ONLY: "yes"
+  #   outputs:
+  #     - client
+
+  # prod-server:
+  #   description: Production server bundle for SSR
+  #   environment:
+  #     NODE_ENV: production
+  #     RAILS_ENV: production
+  #     SERVER_BUNDLE_ONLY: "yes"
+  #   outputs:
+  #     - server
 
   # ============================================================================
   # ADDITIONAL EXAMPLES
@@ -486,35 +525,132 @@ builds:
 # ============================================================================
 #
 # Initialize this config file:
-#   bin/export-bundler-config --init
+#   bin/shakapacker-config --init
 #
 # List all available builds:
-#   bin/export-bundler-config --list-builds
+#   bin/shakapacker-config --list-builds
 #
 # Export development build configs:
-#   bin/export-bundler-config --build=dev-hmr --save
+#   bin/shakapacker-config --build=dev-hmr
 #   Creates: rspack-dev-hmr-client.yml
 #
-#   bin/export-bundler-config --build=dev --save
+#   bin/shakapacker-config --build=dev
 #   Creates: rspack-dev-client.yml, rspack-dev-server.yml
 #
 # Export production build:
-#   bin/export-bundler-config --build=prod --save
+#   bin/shakapacker-config --build=prod
 #   Creates: rspack-prod-client.yml, rspack-prod-server.yml
 #
 # Use webpack instead of default rspack:
-#   bin/export-bundler-config --build=prod --save --webpack
+#   bin/shakapacker-config --build=prod --webpack
 #   Creates: webpack-prod-client.yml, webpack-prod-server.yml
 #
 # Export to stdout for inspection (no files created):
-#   bin/export-bundler-config --build=dev
+#   bin/shakapacker-config --build=dev --stdout
 #
 # Export to custom directory:
-#   bin/export-bundler-config --build=prod --save-dir=./debug
+#   bin/shakapacker-config --build=prod --save-dir=./debug
 #
 # Doctor mode (comprehensive troubleshooting):
-#   bin/export-bundler-config --doctor
+#   bin/shakapacker-config --doctor
 #   Creates files in: shakapacker-config-exports/
 #
 `
 }
+
+/**
+ * Generates SSR-specific configuration file for React on Rails
+ * Includes separate client and server builds for development and production
+ * @returns YAML content as string ready to be written to file
+ */
+function generateSSRConfigFile(): string {
+  return `# Bundler Build Configurations for React on Rails with SSR
+# Generated by: bin/shakapacker-config --init ssr
+#
+# Run builds with: bin/shakapacker --build <name>
+# List builds: bin/shakapacker --list-builds
+
+builds:
+  # ===========================================================================
+  # DEVELOPMENT - CLIENT WITH HMR
+  # ===========================================================================
+  dev-client-hmr:
+    description: Development client bundle with HMR for SSR
+    dev_server: true  # Auto-delegates to bin/shakapacker-dev-server
+    environment:
+      NODE_ENV: development
+      RAILS_ENV: development
+      WEBPACK_SERVE: true
+      CLIENT_BUNDLE_ONLY: "yes"
+    outputs:
+      - client
+
+  # ===========================================================================
+  # DEVELOPMENT - CLIENT (Standard - no HMR)
+  # ===========================================================================
+  dev-client:
+    description: Development client bundle for SSR (no HMR)
+    environment:
+      NODE_ENV: development
+      RAILS_ENV: development
+      CLIENT_BUNDLE_ONLY: "yes"
+    outputs:
+      - client
+
+  # ===========================================================================
+  # DEVELOPMENT - SERVER
+  # ===========================================================================
+  dev-server:
+    description: Development server bundle for SSR
+    environment:
+      NODE_ENV: development
+      RAILS_ENV: development
+      SERVER_BUNDLE_ONLY: "yes"
+    outputs:
+      - server
+
+  # ===========================================================================
+  # PRODUCTION - CLIENT
+  # ===========================================================================
+  prod-client:
+    description: Production client bundle for SSR
+    environment:
+      NODE_ENV: production
+      RAILS_ENV: production
+      CLIENT_BUNDLE_ONLY: "yes"
+    outputs:
+      - client
+
+  # ===========================================================================
+  # PRODUCTION - SERVER
+  # ===========================================================================
+  prod-server:
+    description: Production server bundle for SSR
+    environment:
+      NODE_ENV: production
+      RAILS_ENV: production
+      SERVER_BUNDLE_ONLY: "yes"
+    outputs:
+      - server
+
+# ==============================================================================
+# USAGE EXAMPLES
+# ==============================================================================
+#
+# Development with HMR:
+#   bin/shakapacker --build dev-client-hmr  # Client with HMR
+#   bin/shakapacker --build dev-server      # Server bundle
+#
+# Development without HMR:
+#   bin/shakapacker --build dev-client      # Client bundle
+#   bin/shakapacker --build dev-server      # Server bundle
+#
+# Production:
+#   bin/shakapacker --build prod-client     # Client bundle
+#   bin/shakapacker --build prod-server     # Server bundle
+#
+# For more info on React on Rails with SSR:
+#   https://github.com/shakacode/react_on_rails
+#
+`
+}

data/package/configExporter/fileWriter.ts

@@ -61,7 +61,14 @@ export class FileWriter {
     format: "yaml" | "json" | "inspect",
     buildName?: string
   ): string {
-    const ext = format === "yaml" ? "yaml" : format === "json" ? "json" : "txt"
+    let ext: string
+    if (format === "yaml") {
+      ext = "yaml"
+    } else if (format === "json") {
+      ext = "json"
+    } else {
+      ext = "txt"
+    }
     const name = buildName || env
     return `${bundler}-${name}-${configType}.${ext}`
   }

data/package/configExporter/types.ts

@@ -14,6 +14,7 @@ export interface ExportOptions {
   help?: boolean
   // New config file options
   init?: boolean
+  ssr?: boolean
   configFile?: string
   build?: string
   listBuilds?: boolean
@@ -57,6 +58,7 @@ export interface BundlerConfigFile {
 export interface BuildConfig {
   description?: string
   bundler?: "webpack" | "rspack"
+  dev_server?: boolean
   environment?: Record<string, string>
   bundler_env?: Record<string, string | boolean>
   outputs?: string[]

data/package/utils/pathValidation.ts

@@ -14,11 +14,11 @@ export function isPathTraversalSafe(inputPath: string): boolean {
   if (inputPath.includes("\0")) return false
 
   const dangerousPatterns = [
-    /\.\.[\/\\]/, // ../ or ..\
+    /\.\.[/\\]/, // ../ or ..\
     /^\//, // POSIX absolute
-    /^[A-Za-z]:[\/\\]/, // Windows absolute (C:\ or C:/)
+    /^[A-Za-z]:[/\\]/, // Windows absolute (C:\ or C:/)
     /^\\\\/, // Windows UNC (\\server\share)
-    /~[\/\\]/, // Home directory expansion
+    /~[/\\]/, // Home directory expansion
     /%2e%2e/i // URL encoded traversal
   ]
 

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "shakapacker",
-  "version": "9.3.0-beta.2",
+  "version": "9.3.0-beta.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "shakapacker",
-      "version": "9.3.0-beta.2",
+      "version": "9.3.0-beta.4",
       "license": "MIT",
       "dependencies": {
         "js-yaml": "^4.1.0",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "9.3.0-beta.2",
+  "version": "9.3.0-beta.4",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {

data/test/configExporter/configFile.test.js

@@ -22,7 +22,8 @@ describe("ConfigFileLoader", () => {
     if (!existsSync(testDir)) {
       mkdirSync(testDir, { recursive: true })
     }
-    configPath = join(testDir, ".bundler-config.yml")
+    mkdirSync(join(testDir, "config"), { recursive: true })
+    configPath = join(testDir, "config/shakapacker-builds.yml")
   })
 
   afterEach(() => {
@@ -369,9 +370,9 @@ builds:
 describe("generateSampleConfigFile", () => {
   it("should generate valid YAML string", () => {
     const content = generateSampleConfigFile()
-    expect(content).toContain("default_bundler:")
     expect(content).toContain("builds:")
     expect(content).toContain("dev-hmr:")
+    expect(content).toContain("dev_server: true")
     expect(content).toContain("dev:")
     expect(content).toContain("prod:")
   })

data/test/configExporter/integration.test.js

@@ -10,9 +10,9 @@ const { execSync } = require("child_process")
 
 describe("Config Exporter Integration Tests", () => {
   const testDir = resolve(__dirname, "../tmp/integration-test")
-  const configPath = join(testDir, ".bundler-config.yml")
+  const configPath = join(testDir, "config/shakapacker-builds.yml")
   const outputDir = join(testDir, "output")
-  const binPath = resolve(__dirname, "../../bin/export-bundler-config")
+  const binPath = resolve(__dirname, "../../bin/shakapacker-config")
 
   beforeEach(() => {
     // Create test directory
@@ -20,6 +20,7 @@ describe("Config Exporter Integration Tests", () => {
       rmSync(testDir, { recursive: true, force: true })
     }
     mkdirSync(testDir, { recursive: true })
+    mkdirSync(join(testDir, "config"), { recursive: true })
 
     // Create minimal package.json
     writeFileSync(
@@ -155,13 +156,10 @@ builds:
     })
   })
 
-  describe("--doctor mode with shakapacker_doctor_default_builds_here", () => {
-    it("should use config file builds when flag is set", () => {
-      // Create config with custom builds and the flag
+  describe("--doctor mode with config file", () => {
+    it("should always use config file builds when config exists", () => {
+      // Create config with custom builds
       const configContent = `
-shakapacker_doctor_default_builds_here: true
-default_bundler: webpack
-
 builds:
   custom-dev:
     description: Custom development
@@ -187,9 +185,9 @@ builds:
         { encoding: "utf8" }
       )
 
-      // Verify it used config builds, not hardcoded ones
+      // Verify it used config builds
       expect(result).toContain(
-        "Using builds from config file (shakapacker_doctor_default_builds_here: true)"
+        "Using builds from config/shakapacker-builds.yml"
       )
       expect(result).toContain("custom-dev")
       expect(result).toContain("custom-prod")
@@ -201,20 +199,8 @@ builds:
       expect(files).toContain("webpack-custom-prod-client.yaml")
     })
 
-    it("should use hardcoded builds when flag is not set", () => {
-      // Create config WITHOUT the flag
-      const configContent = `
-default_bundler: webpack
-
-builds:
-  custom-dev:
-    description: Custom development
-    environment:
-      NODE_ENV: development
-    outputs:
-      - client
-`
-      writeFileSync(configPath, configContent)
+    it("should use fallback builds when no config file exists", () => {
+      // Don't create config file
 
       // Run --doctor command
       const result = execSync(
@@ -222,11 +208,12 @@ builds:
         { encoding: "utf8" }
       )
 
-      // Verify it used hardcoded builds (development-hmr, development, production)
-      expect(result).toContain("development-hmr")
+      // Verify it warns and uses hardcoded fallback builds
+      expect(result).toContain("No build config file found")
+      expect(result).toContain("bin/shakapacker-config --init")
+      expect(result).toContain("development (HMR)")
       expect(result).toContain("development")
       expect(result).toContain("production")
-      expect(result).not.toContain("custom-dev")
     })
   })
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 9.3.0.beta.2
+  version: 9.3.0.beta.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -168,7 +168,7 @@ files:
 - TODO_v9.md
 - __mocks__/nonexistent/package.json
 - __mocks__/sass-loader/package.json
-- bin/export-bundler-config
+- bin/shakapacker-config
 - conductor-setup.sh
 - conductor.json
 - config/README.md
@@ -183,6 +183,7 @@ files:
 - docs/optional-peer-dependencies.md
 - docs/peer-dependencies.md
 - docs/precompile_hook.md
+- docs/preventing_fouc.md
 - docs/react.md
 - docs/releasing.md
 - docs/rspack.md
@@ -213,8 +214,8 @@ files:
 - jest.config.js
 - knip.ts
 - lib/install/application.js
-- lib/install/bin/export-bundler-config
 - lib/install/bin/shakapacker
+- lib/install/bin/shakapacker-config
 - lib/install/bin/shakapacker-dev-server
 - lib/install/binstubs.rb
 - lib/install/config/rspack/rspack.config.js
@@ -226,6 +227,7 @@ files:
 - lib/install/template.rb
 - lib/shakapacker.rb
 - lib/shakapacker/base_strategy.rb
+- lib/shakapacker/build_config_loader.rb
 - lib/shakapacker/bundler_switcher.rb
 - lib/shakapacker/commands.rb
 - lib/shakapacker/compiler.rb
@@ -380,7 +382,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.0.beta.2
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.0.beta.4
 rdoc_options: []
 require_paths:
 - lib