shakapacker 9.3.0.beta.6 → 9.3.0.beta.7

data/package/configExporter/cli.ts

@@ -351,7 +351,7 @@ QUICK START (for troubleshooting):
 
   # Advanced output options
   bin/shakapacker-config --build=dev --stdout             # View in terminal
-  bin/shakapacker-config --build=dev --output=config.yaml # Save to specific file`
+  bin/shakapacker-config --build=dev --output=config.yml # Save to specific file`
     )
     .strict()
     .parseSync()
@@ -566,7 +566,7 @@ async function runValidateCommand(options: ExportOptions): Promise<number> {
       }
     }
 
-    console.log("\n" + "=".repeat(80))
+    console.log(`\n${"=".repeat(80)}`)
     console.log("🔍 Validating Builds")
     console.log("=".repeat(80))
     console.log(`\nValidating ${buildsToValidate.length} build(s)...\n`)
@@ -577,7 +577,7 @@ async function runValidateCommand(options: ExportOptions): Promise<number> {
         "   This includes all webpack/rspack compilation logs, warnings, and progress messages"
       )
       console.log("   Use without --verbose to see only errors and summaries\n")
-      console.log("=".repeat(80) + "\n")
+      console.log(`${"=".repeat(80)}\n`)
     }
 
     const results = []
@@ -585,7 +585,7 @@ async function runValidateCommand(options: ExportOptions): Promise<number> {
     // Validate each build
     for (const buildName of buildsToValidate) {
       if (options.verbose) {
-        console.log("\n" + "=".repeat(80))
+        console.log(`\n${"=".repeat(80)}`)
         console.log(`📦 VALIDATING BUILD: ${buildName}`)
         console.log("=".repeat(80))
       } else {
@@ -611,7 +611,11 @@ async function runValidateCommand(options: ExportOptions): Promise<number> {
         "development"
 
       // Auto-detect bundler using the build's environment
-      const defaultBundler = await autoDetectBundler(buildEnv, appRoot)
+      const defaultBundler = await autoDetectBundler(
+        buildEnv,
+        appRoot,
+        options.verbose
+      )
 
       // Resolve build config with the correct default bundler
       const resolvedBuild = loader.resolveBuild(
@@ -719,7 +723,7 @@ async function runAllBuildsCommand(options: ExportOptions): Promise<number> {
     }
 
     // Print summary
-    console.log("\n" + "=".repeat(80))
+    console.log(`\n${"=".repeat(80)}`)
     console.log("✅ All Builds Exported!")
     console.log("=".repeat(80))
     console.log(`\nCreated ${createdFiles.length} configuration file(s) in:`)
@@ -728,7 +732,7 @@ async function runAllBuildsCommand(options: ExportOptions): Promise<number> {
     createdFiles.forEach((file) => {
       console.log(`  ✓ ${basename(file)}`)
     })
-    console.log("\n" + "=".repeat(80) + "\n")
+    console.log(`\n${"=".repeat(80)}\n`)
 
     return 0
   } catch (error: unknown) {
@@ -749,7 +753,7 @@ async function runDoctorMode(
   const savedEnv = saveBuildEnvironmentVariables()
 
   try {
-    console.log("\n" + "=".repeat(80))
+    console.log(`\n${"=".repeat(80)}`)
     console.log("🔍 Config Exporter - Doctor Mode")
     console.log("=".repeat(80))
 
@@ -899,7 +903,7 @@ async function runDoctorMode(
 
 function printDoctorSummary(createdFiles: string[], targetDir: string): void {
   // Print summary
-  console.log("\n" + "=".repeat(80))
+  console.log(`\n${"=".repeat(80)}`)
   console.log("✅ Export Complete!")
   console.log("=".repeat(80))
   console.log(`\nCreated ${createdFiles.length} configuration file(s) in:`)
@@ -922,14 +926,14 @@ function printDoctorSummary(createdFiles: string[], targetDir: string): void {
   }
 
   if (shouldSuggestGitignore) {
-    console.log("\n" + "─".repeat(80))
+    console.log(`\n${"─".repeat(80)}`)
     console.log(
       "💡 Tip: Add the export directory to .gitignore to avoid committing config files:"
     )
     console.log(`\n  echo "${dirName}/" >> .gitignore\n`)
   }
 
-  console.log("\n" + "=".repeat(80) + "\n")
+  console.log(`\n${"=".repeat(80)}\n`)
 }
 
 async function runSaveMode(
@@ -946,7 +950,7 @@ async function runSaveMode(
   if (options.output) {
     // Single file output
     const combined = configs.map((c) => c.config)
-    const metadata = configs[0].metadata
+    const { metadata } = configs[0]
     metadata.configCount = combined.length
 
     const output = formatConfig(
@@ -986,15 +990,15 @@ async function runStdoutMode(
   options: ExportOptions,
   appRoot: string
 ): Promise<void> {
-  const configs = await loadConfigsForEnv(options.env!, options, appRoot)
+  const configs = await loadConfigsForEnv(options.env, options, appRoot)
   const combined = configs.map((c) => c.config)
-  const metadata = configs[0].metadata
+  const { metadata } = configs[0]
   metadata.configCount = combined.length
 
   const config = combined.length === 1 ? combined[0] : combined
   const output = formatConfig(config, metadata, options, appRoot)
 
-  console.log("\n" + "=".repeat(80) + "\n")
+  console.log(`\n${"=".repeat(80)}\n`)
   console.log(output)
 }
 
@@ -1002,9 +1006,9 @@ async function runSingleFileMode(
   options: ExportOptions,
   appRoot: string
 ): Promise<void> {
-  const configs = await loadConfigsForEnv(options.env!, options, appRoot)
+  const configs = await loadConfigsForEnv(options.env, options, appRoot)
   const combined = configs.map((c) => c.config)
-  const metadata = configs[0].metadata
+  const { metadata } = configs[0]
   metadata.configCount = combined.length
 
   const config = combined.length === 1 ? combined[0] : combined
@@ -1031,7 +1035,11 @@ async function loadConfigsForEnv(
     // Use a temporary env for auto-detection, will be overridden by build config
     const tempEnv = env || "development"
     const loader = new ConfigFileLoader(options.configFile)
-    const defaultBundler = await autoDetectBundler(tempEnv, appRoot)
+    const defaultBundler = await autoDetectBundler(
+      tempEnv,
+      appRoot,
+      options.verbose
+    )
     const resolvedBuild = loader.resolveBuild(
       options.build,
       options,
@@ -1055,7 +1063,7 @@ async function loadConfigsForEnv(
       "DYLD_INSERT_LIBRARIES"
     ]
 
-    if (process.env.VERBOSE) {
+    if (options.verbose) {
       console.log(
         `[Config Exporter] Setting environment variables from build config...`
       )
@@ -1075,7 +1083,7 @@ async function loadConfigsForEnv(
         )
         continue
       }
-      if (process.env.VERBOSE) {
+      if (options.verbose) {
         console.log(`[Config Exporter]   ${key}=${value}`)
       }
       process.env[key] = value
@@ -1125,7 +1133,9 @@ async function loadConfigsForEnv(
     finalEnv = env || "development"
 
     // Auto-detect bundler if not specified
-    bundler = options.bundler || (await autoDetectBundler(finalEnv, appRoot))
+    bundler =
+      options.bundler ||
+      (await autoDetectBundler(finalEnv, appRoot, options.verbose))
 
     // Set environment variables
     process.env.NODE_ENV = finalEnv
@@ -1141,9 +1151,10 @@ async function loadConfigsForEnv(
 
   // Find and load config file
   const configFile =
-    customConfigFile || findConfigFile(bundler, appRoot, finalEnv)
+    customConfigFile ||
+    findConfigFile(bundler, appRoot, finalEnv, options.verbose)
   // Quiet mode for cleaner output - only show if verbose or errors
-  if (process.env.VERBOSE) {
+  if (options.verbose) {
     console.log(`[Config Exporter] Loading config: ${configFile}`)
     console.log(`[Config Exporter] Environment: ${finalEnv}`)
     console.log(`[Config Exporter] Bundler: ${bundler}`)
@@ -1156,7 +1167,6 @@ async function loadConfigsForEnv(
   // Register ts-node for TypeScript config files
   if (configFile.endsWith(".ts")) {
     try {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
       require("ts-node/register/transpile-only")
     } catch (error) {
       throw new Error(
@@ -1205,7 +1215,6 @@ async function loadConfigsForEnv(
     }
   })
 
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
   let loadedConfig: any
   try {
     loadedConfig = require(configFile)
@@ -1283,9 +1292,9 @@ async function loadConfigsForEnv(
       }
 
       throw new Error(
-        `Failed to execute config function: ${errorMessage}\n` +
-          envDetails.join("\n") +
-          `\nTip: ${suggestion}`
+        `Failed to execute config function: ${errorMessage}\n${envDetails.join(
+          "\n"
+        )}\nTip: ${suggestion}`
       )
     }
   }
@@ -1338,7 +1347,7 @@ async function loadConfigsForEnv(
   }
 
   // Debug logging
-  if (process.env.VERBOSE || buildOutputs.length > 0) {
+  if (options.verbose || buildOutputs.length > 0) {
     console.log(
       `[Config Exporter] Webpack returned ${configs.length} config(s), buildOutputs: [${buildOutputs.join(", ")}]`
     )
@@ -1442,39 +1451,37 @@ function formatConfig(
       return value
     }
     return JSON.stringify({ metadata, config }, jsonReplacer, 2)
-  } else {
-    // inspect format
-    const inspectOptions = {
-      depth: options.depth,
-      colors: false,
-      maxArrayLength: null,
-      maxStringLength: null,
-      breakLength: 120,
-      compact: false
-    }
-
-    let output =
-      "=== METADATA ===\n\n" + inspect(metadata, inspectOptions) + "\n\n"
-    output += "=== CONFIG ===\n\n"
+  }
+  // inspect format
+  const inspectOptions = {
+    depth: options.depth,
+    colors: false,
+    maxArrayLength: null,
+    maxStringLength: null,
+    breakLength: 120,
+    compact: false
+  }
 
-    if (Array.isArray(config)) {
-      output += `Total configs: ${config.length}\n\n`
-      config.forEach((cfg, index) => {
-        output += `--- Config [${index}] ---\n\n`
-        output += inspect(cfg, inspectOptions) + "\n\n"
-      })
-    } else {
-      output += inspect(config, inspectOptions) + "\n"
-    }
+  let output = `=== METADATA ===\n\n${inspect(metadata, inspectOptions)}\n\n`
+  output += "=== CONFIG ===\n\n"
 
-    return output
+  if (Array.isArray(config)) {
+    output += `Total configs: ${config.length}\n\n`
+    config.forEach((cfg, index) => {
+      output += `--- Config [${index}] ---\n\n`
+      output += `${inspect(cfg, inspectOptions)}\n\n`
+    })
+  } else {
+    output += `${inspect(config, inspectOptions)}\n`
   }
+
+  return output
 }
 
 function cleanConfig(obj: any, rootPath: string): any {
   const makePathRelative = (str: string): string => {
     if (typeof str === "string" && str.startsWith(rootPath)) {
-      return "./" + str.substring(rootPath.length + 1)
+      return `./${str.substring(rootPath.length + 1)}`
     }
     return str
   }
@@ -1542,11 +1549,12 @@ let shakapackerConfigCache: {
 
 function loadShakapackerConfig(
   env: string,
-  appRoot: string
+  appRoot: string,
+  verbose = false
 ): { bundler: "webpack" | "rspack"; configPath: string } {
   // Return cached result if same environment
   if (shakapackerConfigCache && shakapackerConfigCache.env === env) {
-    if (process.env.VERBOSE) {
+    if (verbose) {
       console.log(
         `[Config Exporter] Using cached bundler config for env: ${env}`
       )
@@ -1554,7 +1562,7 @@ function loadShakapackerConfig(
     return shakapackerConfigCache.result
   }
 
-  if (process.env.VERBOSE) {
+  if (verbose) {
     console.log(`[Config Exporter] Loading shakapacker config for env: ${env}`)
   }
 
@@ -1623,18 +1631,20 @@ function loadShakapackerConfig(
  */
 async function autoDetectBundler(
   env: string,
-  appRoot: string
+  appRoot: string,
+  verbose = false
 ): Promise<"webpack" | "rspack"> {
-  const { bundler } = loadShakapackerConfig(env, appRoot)
+  const { bundler } = loadShakapackerConfig(env, appRoot, verbose)
   return bundler
 }
 
 function findConfigFile(
   bundler: "webpack" | "rspack",
   appRoot: string,
-  env: string
+  env: string,
+  verbose = false
 ): string {
-  const { configPath } = loadShakapackerConfig(env, appRoot)
+  const { configPath } = loadShakapackerConfig(env, appRoot, verbose)
   const extensions = ["ts", "js"]
 
   if (bundler === "rspack") {
@@ -1692,7 +1702,6 @@ function setupNodePath(appRoot: string): void {
       ? `${nodePaths.join(delimiter)}${delimiter}${existingNodePath}`
       : nodePaths.join(delimiter)
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     require("module").Module._initPaths()
   }
 }

data/package/configExporter/fileWriter.ts

@@ -56,12 +56,12 @@ export class FileWriter {
    * @example
    * // Built-in types
    * generateFilename("webpack", "development", "client", "yaml")
-   * // => "webpack-development-client.yaml"
+   * // => "webpack-development-client.yml"
    *
    * @example
    * // Custom output names
    * generateFilename("webpack", "development", "client-modern", "yaml", "dev-hmr")
-   * // => "webpack-dev-hmr-client-modern.yaml"
+   * // => "webpack-dev-hmr-client-modern.yml"
    */
   static generateFilename(
     bundler: string,
@@ -72,7 +72,7 @@ export class FileWriter {
   ): string {
     let ext: string
     if (format === "yaml") {
-      ext = "yaml"
+      ext = "yml"
     } else if (format === "json") {
       ext = "json"
     } else {

data/package/configExporter/yamlSerializer.ts

@@ -147,6 +147,22 @@ export class YamlSerializer {
 
     arr.forEach((item, index) => {
       const itemPath = `${keyPath}[${index}]`
+
+      // Check if this is a plugin object and add its name as a comment
+      const pluginName = this.getConstructorName(item)
+      const isPlugin = pluginName && /(^|\.)plugins\[\d+\]/.test(itemPath)
+      const isEmpty =
+        typeof item === "object" &&
+        item !== null &&
+        !Array.isArray(item) &&
+        Object.keys(item).length === 0
+
+      // For non-empty plugins, add comment before the plugin
+      // For empty plugins, the name will be shown inline
+      if (isPlugin && !isEmpty) {
+        lines.push(`${itemIndent}# ${pluginName}`)
+      }
+
       const serialized = this.serializeValue(item, indent + 4, itemPath)
 
       // Add documentation for array items if available
@@ -200,7 +216,13 @@ export class YamlSerializer {
 
   private serializeObject(obj: any, indent: number, keyPath: string): string {
     const keys = Object.keys(obj)
+    const constructorName = this.getConstructorName(obj)
+
+    // For empty objects, show constructor name if available
     if (keys.length === 0) {
+      if (constructorName) {
+        return `{} # ${constructorName}`
+      }
       return "{}"
     }
 
@@ -277,4 +299,18 @@ export class YamlSerializer {
 
     return "./" + rel
   }
+
+  /**
+   * Extracts the constructor name from an object
+   * Returns null for plain objects (Object constructor)
+   */
+  private getConstructorName(obj: any): string | null {
+    if (!obj || typeof obj !== "object") return null
+    if (Array.isArray(obj)) return null
+
+    const constructorName = obj.constructor?.name
+    if (!constructorName || constructorName === "Object") return null
+
+    return constructorName
+  }
 }

data/package/plugins/webpack.ts

@@ -3,7 +3,7 @@ const { requireOrError } = require("../utils/requireOrError")
 const WebpackAssetsManifest = requireOrError("webpack-assets-manifest")
 const webpack = requireOrError("webpack")
 const config = require("../config")
-const { isProduction } = require("../env")
+const { isProduction, isDevelopment } = require("../env")
 const { moduleExists } = require("../utils/helpers")
 
 const getPlugins = (): unknown[] => {
@@ -15,6 +15,7 @@ const getPlugins = (): unknown[] => {
   const plugins = [
     new webpack.EnvironmentPlugin(process.env),
     new WebpackAssetsManifestConstructor({
+      merge: isDevelopment,
       entrypoints: true,
       writeToDisk: true,
       output: config.manifestPath,

data/package.json

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

data/test/configExporter/integration.test.js

@@ -127,21 +127,21 @@ builds:
 
       // Should have 3 files (one per build)
       expect(files).toHaveLength(3)
-      expect(files).toContain("webpack-dev-hmr-client.yaml")
-      expect(files).toContain("webpack-dev-client.yaml")
-      expect(files).toContain("webpack-prod-client.yaml")
+      expect(files).toContain("webpack-dev-hmr-client.yml")
+      expect(files).toContain("webpack-dev-client.yml")
+      expect(files).toContain("webpack-prod-client.yml")
 
       // Verify files have different content (proving environment isolation)
       const devHmrContent = require("fs").readFileSync(
-        join(outputDir, "webpack-dev-hmr-client.yaml"),
+        join(outputDir, "webpack-dev-hmr-client.yml"),
         "utf8"
       )
       const devContent = require("fs").readFileSync(
-        join(outputDir, "webpack-dev-client.yaml"),
+        join(outputDir, "webpack-dev-client.yml"),
         "utf8"
       )
       const prodContent = require("fs").readFileSync(
-        join(outputDir, "webpack-prod-client.yaml"),
+        join(outputDir, "webpack-prod-client.yml"),
         "utf8"
       )
 
@@ -195,8 +195,8 @@ builds:
       // Verify files
       expect(existsSync(outputDir)).toBe(true)
       const files = readdirSync(outputDir)
-      expect(files).toContain("webpack-custom-dev-client.yaml")
-      expect(files).toContain("webpack-custom-prod-client.yaml")
+      expect(files).toContain("webpack-custom-dev-client.yml")
+      expect(files).toContain("webpack-custom-prod-client.yml")
     })
 
     it("should use fallback builds when no config file exists", () => {

data/test/package/configExporter.test.js

@@ -23,7 +23,7 @@ describe("configExporter", () => {
         "client",
         "yaml"
       )
-      expect(filename).toBe("webpack-development-client.yaml")
+      expect(filename).toBe("webpack-development-client.yml")
     })
 
     test("generates correct filename for server config", () => {
@@ -34,7 +34,7 @@ describe("configExporter", () => {
         "server",
         "yaml"
       )
-      expect(filename).toBe("webpack-production-server.yaml")
+      expect(filename).toBe("webpack-production-server.yml")
     })
 
     test("generates correct filename for client-hmr config", () => {
@@ -45,7 +45,7 @@ describe("configExporter", () => {
         "client-hmr",
         "yaml"
       )
-      expect(filename).toBe("webpack-development-client-hmr.yaml")
+      expect(filename).toBe("webpack-development-client-hmr.yml")
     })
 
     test("generates correct filename for json format", () => {
@@ -67,7 +67,7 @@ describe("configExporter", () => {
         "client-modern",
         "yaml"
       )
-      expect(filename).toBe("webpack-development-client-modern.yaml")
+      expect(filename).toBe("webpack-development-client-modern.yml")
     })
 
     test("generates correct filename for custom output name client-legacy", () => {
@@ -78,7 +78,7 @@ describe("configExporter", () => {
         "client-legacy",
         "yaml"
       )
-      expect(filename).toBe("webpack-production-client-legacy.yaml")
+      expect(filename).toBe("webpack-production-client-legacy.yml")
     })
 
     test("generates correct filename for custom output name server-bundle", () => {
@@ -89,7 +89,7 @@ describe("configExporter", () => {
         "server-bundle",
         "yaml"
       )
-      expect(filename).toBe("rspack-development-server-bundle.yaml")
+      expect(filename).toBe("rspack-development-server-bundle.yml")
     })
 
     test("generates correct filename with buildName override", () => {
@@ -101,7 +101,7 @@ describe("configExporter", () => {
         "yaml",
         "dev-hmr"
       )
-      expect(filename).toBe("webpack-dev-hmr-client-modern.yaml")
+      expect(filename).toBe("webpack-dev-hmr-client-modern.yml")
     })
   })
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 9.3.0.beta.6
+  version: 9.3.0.beta.7
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -273,7 +273,6 @@ files:
 - lib/tasks/shakapacker/switch_bundler.rake
 - lib/tasks/shakapacker/verify_config.rake
 - lib/tasks/shakapacker/verify_install.rake
-- package-lock.json
 - package.json
 - package/.npmignore
 - package/babel/preset.ts
@@ -385,7 +384,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.0.beta.6
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.0.beta.7
 rdoc_options: []
 require_paths:
 - lib