shakapacker 9.0.0.beta.4 → 9.0.0.beta.6

data/package/config.js

@@ -1,80 +0,0 @@
-const { resolve } = require("path")
-const { load } = require("js-yaml")
-const { existsSync, readFileSync } = require("fs")
-
-const { merge } = require("webpack-merge")
-const { ensureTrailingSlash } = require("./utils/helpers")
-const { railsEnv } = require("./env")
-const configPath = require("./utils/configPath")
-
-const defaultConfigPath = require("./utils/defaultConfigPath")
-
-const getDefaultConfig = () => {
-  const defaultConfig = load(readFileSync(defaultConfigPath), "utf8")
-  return defaultConfig[railsEnv] || defaultConfig.production
-}
-
-const defaults = getDefaultConfig()
-let config
-
-if (existsSync(configPath)) {
-  const appYmlObject = load(readFileSync(configPath), "utf8")
-  const envAppConfig = appYmlObject[railsEnv]
-
-  if (!envAppConfig) {
-    /* eslint no-console:0 */
-    console.warn(
-      `Warning: ${railsEnv} key not found in the configuration file. Using production configuration as a fallback.`
-    )
-  }
-
-  config = merge(defaults, envAppConfig || {})
-} else {
-  config = merge(defaults, {})
-}
-
-config.outputPath = resolve(config.public_root_path, config.public_output_path)
-
-// Ensure that the publicPath includes our asset host so dynamic imports
-// (code-splitting chunks and static assets) load from the CDN instead of a relative path.
-const getPublicPath = () => {
-  const rootUrl = ensureTrailingSlash(process.env.SHAKAPACKER_ASSET_HOST || "/")
-  return `${rootUrl}${config.public_output_path}/`
-}
-
-config.publicPath = getPublicPath()
-config.publicPathWithoutCDN = `/${config.public_output_path}/`
-
-if (config.manifest_path) {
-  config.manifestPath = resolve(config.manifest_path)
-} else {
-  config.manifestPath = resolve(config.outputPath, "manifest.json")
-}
-// Ensure no duplicate hash functions exist in the returned config object
-config.integrity.hash_functions = [...new Set(config.integrity.hash_functions)]
-
-// Allow ENV variable to override assets_bundler
-if (process.env.SHAKAPACKER_ASSETS_BUNDLER) {
-  config.assets_bundler = process.env.SHAKAPACKER_ASSETS_BUNDLER
-}
-
-// Define clear defaults
-// SWC is now the default transpiler for both webpack and rspack
-const DEFAULT_JAVASCRIPT_TRANSPILER = "swc"
-
-// Backward compatibility: Add webpack_loader property that maps to javascript_transpiler
-// Show deprecation warning if webpack_loader is used
-if (config.webpack_loader && !config.javascript_transpiler) {
-  console.warn(
-    "⚠️  DEPRECATION WARNING: The 'webpack_loader' configuration option is deprecated. Please use 'javascript_transpiler' instead as it better reflects its purpose of configuring JavaScript transpilation regardless of the bundler used."
-  )
-  config.javascript_transpiler = config.webpack_loader
-} else if (!config.javascript_transpiler) {
-  config.javascript_transpiler =
-    config.webpack_loader || DEFAULT_JAVASCRIPT_TRANSPILER
-}
-
-// Ensure webpack_loader is always available for backward compatibility
-config.webpack_loader = config.javascript_transpiler
-
-module.exports = config

data/package/env.js

@@ -1,48 +0,0 @@
-const { load } = require("js-yaml")
-const { readFileSync } = require("fs")
-const defaultConfigPath = require("./utils/defaultConfigPath")
-
-const NODE_ENVIRONMENTS = ["development", "production", "test"]
-const DEFAULT = "production"
-const configPath = require("./utils/configPath")
-
-const railsEnv = process.env.RAILS_ENV
-const rawNodeEnv = process.env.NODE_ENV
-const nodeEnv =
-  rawNodeEnv && NODE_ENVIRONMENTS.includes(rawNodeEnv) ? rawNodeEnv : DEFAULT
-const isProduction = nodeEnv === "production"
-const isDevelopment = nodeEnv === "development"
-
-let config
-try {
-  config = load(readFileSync(configPath), "utf8")
-} catch (error) {
-  if (error.code === "ENOENT") {
-    // File not found, use default configuration
-    config = load(readFileSync(defaultConfigPath), "utf8")
-  } else {
-    throw error
-  }
-}
-
-const availableEnvironments = Object.keys(config).join("|")
-const regex = new RegExp(`^(${availableEnvironments})$`, "g")
-
-const runningWebpackDevServer = process.env.WEBPACK_SERVE === "true"
-
-const validatedRailsEnv = railsEnv && railsEnv.match(regex) ? railsEnv : DEFAULT
-
-if (railsEnv && validatedRailsEnv !== railsEnv) {
-  /* eslint no-console:0 */
-  console.warn(
-    `Warning: '${railsEnv}' environment not found in the configuration. Using '${DEFAULT}' configuration as a fallback.`
-  )
-}
-
-module.exports = {
-  railsEnv: validatedRailsEnv,
-  nodeEnv,
-  isProduction,
-  isDevelopment,
-  runningWebpackDevServer
-}

data/package/utils/configPath.js

@@ -1,4 +0,0 @@
-const { resolve } = require("path")
-
-module.exports =
-  process.env.SHAKAPACKER_CONFIG || resolve("config", "shakapacker.yml")

data/package/utils/defaultConfigPath.js

@@ -1,2 +0,0 @@
-const path = require.resolve("../../lib/install/config/shakapacker.yml")
-module.exports = path

data/package/utils/helpers.js

@@ -1,127 +0,0 @@
-const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
-
-const ensureTrailingSlash = (path) => (path.endsWith("/") ? path : `${path}/`)
-
-const resolvedPath = (packageName) => {
-  try {
-    return require.resolve(packageName)
-  } catch (e) {
-    if (e.code !== "MODULE_NOT_FOUND") {
-      throw e
-    }
-    return null
-  }
-}
-
-const moduleExists = (packageName) => !!resolvedPath(packageName)
-
-const canProcess = (rule, fn) => {
-  const modulePath = resolvedPath(rule)
-
-  if (modulePath) {
-    return fn(modulePath)
-  }
-
-  return null
-}
-
-const validateBabelDependencies = () => {
-  // Only validate core dependencies that are absolutely required
-  // Additional packages like presets are optional and project-specific
-  const coreRequiredPackages = ["@babel/core", "babel-loader"]
-
-  const missingCorePackages = coreRequiredPackages.filter(
-    (pkg) => !moduleExists(pkg)
-  )
-
-  if (missingCorePackages.length > 0) {
-    const installCommand = `npm install --save-dev ${missingCorePackages.join(" ")}`
-
-    // Check for commonly needed packages and suggest them
-    const suggestedPackages = [
-      "@babel/preset-env",
-      "@babel/plugin-transform-runtime",
-      "@babel/runtime"
-    ]
-
-    const missingSuggested = suggestedPackages.filter(
-      (pkg) => !moduleExists(pkg)
-    )
-    let additionalHelp = ""
-
-    if (missingSuggested.length > 0) {
-      additionalHelp =
-        `\n\nYou may also need: ${missingSuggested.join(", ")}\n` +
-        `Install with: npm install --save-dev ${missingSuggested.join(" ")}`
-    }
-
-    throw new Error(
-      `Babel is configured but core packages are missing: ${missingCorePackages.join(", ")}\n\n` +
-        `To fix this, run:\n  ${installCommand}${additionalHelp}\n\n` +
-        `💡 Tip: Consider migrating to SWC for 20x faster compilation:\n` +
-        `   1. Set javascript_transpiler: 'swc' in config/shakapacker.yml\n` +
-        `   2. Run: npm install @swc/core swc-loader`
-    )
-  }
-}
-
-const loaderMatches = (configLoader, loaderToCheck, fn) => {
-  if (configLoader !== loaderToCheck) {
-    return null
-  }
-
-  const loaderName = `${configLoader}-loader`
-
-  // Special validation for babel to check all dependencies
-  if (configLoader === "babel") {
-    validateBabelDependencies()
-  }
-
-  if (!moduleExists(loaderName)) {
-    let installCommand = ""
-    let migrationHelp = ""
-
-    if (configLoader === "babel") {
-      installCommand =
-        "npm install --save-dev babel-loader @babel/core @babel/preset-env @babel/plugin-transform-runtime @babel/runtime"
-      migrationHelp =
-        "\n\n💡 Tip: Consider migrating to SWC for 20x faster compilation:\n" +
-        "   1. Set javascript_transpiler: 'swc' in config/shakapacker.yml\n" +
-        "   2. Run: npm install @swc/core swc-loader"
-    } else if (configLoader === "swc") {
-      installCommand = "npm install --save-dev @swc/core swc-loader"
-      migrationHelp =
-        "\n\n✨ SWC is 20x faster than Babel with zero configuration!"
-    } else if (configLoader === "esbuild") {
-      installCommand = "npm install --save-dev esbuild esbuild-loader"
-    }
-
-    throw new Error(
-      `Your Shakapacker config specified using ${configLoader}, but ${loaderName} package is not installed.\n\n` +
-        `To fix this, run:\n  ${installCommand}${migrationHelp}`
-    )
-  }
-
-  return fn()
-}
-
-const packageFullVersion = (packageName) => {
-  // eslint-disable-next-line import/no-dynamic-require
-  const packageJsonPath = require.resolve(`${packageName}/package.json`)
-  // eslint-disable-next-line import/no-dynamic-require, global-require
-  return require(packageJsonPath).version
-}
-
-const packageMajorVersion = (packageName) =>
-  packageFullVersion(packageName).match(/^\d+/)[0]
-
-module.exports = {
-  isBoolean,
-  ensureTrailingSlash,
-  canProcess,
-  moduleExists,
-  validateBabelDependencies,
-  loaderMatches,
-  packageFullVersion,
-  packageMajorVersion
-}

data/package/utils/snakeToCamelCase.js

@@ -1,5 +0,0 @@
-function snakeToCamelCase(s) {
-  return s.replace(/(_\w)/g, (match) => match[1].toUpperCase())
-}
-
-module.exports = snakeToCamelCase

data/package/utils/validateCssModulesConfig.js

@@ -1,91 +0,0 @@
-/* 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 }

data/package/webpackDevServerConfig.js

@@ -1,73 +0,0 @@
-const shakapackerDevServerYamlConfig = require("./dev_server")
-const snakeToCamelCase = require("./utils/snakeToCamelCase")
-const { outputPath: contentBase, publicPath } = require("./config")
-
-const webpackDevServerMappedKeys = new Set([
-  // client, server, liveReload, devMiddleware are handled separately
-  "allowedHosts",
-  "bonjour",
-  "compress",
-  "headers",
-  "historyApiFallback",
-  "host",
-  "hot",
-  "http2",
-  "https",
-  "ipc",
-  "magicHtml",
-  "onAfterSetupMiddleware",
-  "onBeforeSetupMiddleware",
-  "open",
-  "port",
-  "proxy",
-  "server",
-  "setupExitSignals",
-  "setupMiddlewares",
-  "watchFiles",
-  "webSocketServer"
-])
-
-function createDevServerConfig() {
-  const devServerYamlConfig = { ...shakapackerDevServerYamlConfig }
-  const liveReload =
-    devServerYamlConfig.live_reload !== undefined
-      ? devServerYamlConfig.live_reload
-      : !devServerYamlConfig.hmr
-  delete devServerYamlConfig.live_reload
-
-  const config = {
-    devMiddleware: {
-      publicPath
-    },
-    hot: devServerYamlConfig.hmr,
-    liveReload,
-    historyApiFallback: {
-      disableDotRule: true
-    },
-    static: {
-      publicPath: contentBase
-    }
-  }
-  delete devServerYamlConfig.hmr
-
-  if (devServerYamlConfig.static) {
-    config.static = { ...config.static, ...devServerYamlConfig.static }
-    delete devServerYamlConfig.static
-  }
-
-  if (devServerYamlConfig.client) {
-    config.client = devServerYamlConfig.client
-    delete devServerYamlConfig.client
-  }
-
-  Object.keys(devServerYamlConfig).forEach((yamlKey) => {
-    const camelYamlKey = snakeToCamelCase(yamlKey)
-    if (webpackDevServerMappedKeys.has(camelYamlKey)) {
-      config[camelYamlKey] = devServerYamlConfig[yamlKey]
-    }
-  })
-
-  return config
-}
-
-module.exports = createDevServerConfig