shakapacker 9.0.0.beta.4 → 9.0.0.beta.5

data/test/typescript/build.test.js

@@ -0,0 +1,117 @@
+/* eslint-env jest */
+const { execSync } = require("child_process")
+const { existsSync, readFileSync } = require("fs")
+const { join } = require("path")
+
+describe("typescript build", () => {
+  const rootPath = join(__dirname, "..", "..")
+
+  describe("typescript compilation", () => {
+    it("should compile TypeScript files without errors", () => {
+      expect(() => {
+        execSync("npx tsc --noEmit", { cwd: rootPath, stdio: "pipe" })
+      }).not.toThrow()
+    })
+
+    it("should generate JavaScript files from TypeScript", () => {
+      // Check that key TypeScript files compile to JavaScript
+      const tsFiles = ["config", "env", "index", "dev_server"]
+
+      tsFiles.forEach((file) => {
+        const jsPath = join(rootPath, "package", `${file}.js`)
+        const tsPath = join(rootPath, "package", `${file}.ts`)
+
+        expect(existsSync(tsPath)).toBe(true)
+        expect(existsSync(jsPath)).toBe(true)
+
+        // Verify JS file is newer than TS file (has been compiled)
+        const jsContent = readFileSync(jsPath, "utf8")
+        expect(jsContent).toContain("use strict")
+      })
+    })
+
+    it("should generate type definition files", () => {
+      const dtsFiles = ["config", "env", "index", "types", "dev_server"]
+
+      dtsFiles.forEach((file) => {
+        const dtsPath = join(rootPath, "package", `${file}.d.ts`)
+        expect(existsSync(dtsPath)).toBe(true)
+      })
+    })
+  })
+
+  describe("commonJS compatibility", () => {
+    it("should export modules using CommonJS format", () => {
+      const config = require("../../package/config")
+      const env = require("../../package/env")
+      const helpers = require("../../package/utils/helpers")
+
+      expect(config).toBeDefined()
+      expect(env.railsEnv).toBeDefined()
+      expect(helpers.moduleExists).toBeDefined()
+    })
+
+    it("should maintain backward compatibility", () => {
+      const index = require("../../package/index")
+
+      // Check all expected exports are present
+      expect(index.config).toBeDefined()
+      expect(index.env).toBeDefined()
+      expect(index.generateWebpackConfig).toBeInstanceOf(Function)
+      expect(index.moduleExists).toBeInstanceOf(Function)
+      expect(index.canProcess).toBeInstanceOf(Function)
+    })
+  })
+
+  describe("type guards", () => {
+    it("should have runtime type validation functions", () => {
+      const typeGuards = require("../../package/utils/typeGuards")
+
+      expect(typeGuards.isValidConfig).toBeInstanceOf(Function)
+      expect(typeGuards.isValidDevServerConfig).toBeInstanceOf(Function)
+      expect(typeGuards.isValidYamlConfig).toBeInstanceOf(Function)
+      expect(typeGuards.isPartialConfig).toBeInstanceOf(Function)
+    })
+
+    it("should validate config objects correctly", () => {
+      const { isPartialConfig } = require("../../package/utils/typeGuards")
+
+      const validPartial = {
+        source_path: "app/javascript",
+        nested_entries: true
+      }
+
+      const invalidPartial = {
+        source_path: 123, // Should be string
+        nested_entries: "yes" // Should be boolean
+      }
+
+      expect(isPartialConfig(validPartial)).toBe(true)
+      expect(isPartialConfig(invalidPartial)).toBe(false)
+    })
+  })
+
+  describe("error helpers", () => {
+    it("should have error handling utilities", () => {
+      const errorHelpers = require("../../package/utils/errorHelpers")
+
+      expect(errorHelpers.isFileNotFoundError).toBeInstanceOf(Function)
+      expect(errorHelpers.isModuleNotFoundError).toBeInstanceOf(Function)
+      expect(errorHelpers.getErrorMessage).toBeInstanceOf(Function)
+    })
+
+    it("should correctly identify ENOENT errors", () => {
+      const {
+        isFileNotFoundError
+      } = require("../../package/utils/errorHelpers")
+
+      const enoentError = new Error("File not found")
+      enoentError.code = "ENOENT"
+
+      const otherError = new Error("Other error")
+
+      expect(isFileNotFoundError(enoentError)).toBe(true)
+      expect(isFileNotFoundError(otherError)).toBe(false)
+    })
+  })
+})

data/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "typeRoots": ["./node_modules/@types", "node_modules/@types", "../node_modules/@types"],
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./package",
+    "rootDir": "./package",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "allowJs": true,
+    "checkJs": false,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": false,
+    "noImplicitThis": true,
+    "alwaysStrict": false,
+    "allowSyntheticDefaultImports": true,
+    "preserveConstEnums": true,
+    "isolatedModules": true,
+    "removeComments": false
+  },
+  "include": [
+    "package/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "package/**/*.test.ts",
+    "package/**/*.spec.ts"
+  ]
+}

data/yarn.lock

@@ -5997,7 +5997,7 @@ webpack-merge@*:
 
 webpack-merge@^5.8.0:
   version "5.10.0"
-  resolved "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz"
+  resolved "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz#a3ad5d773241e9c682803abf628d4cd62b8a4177"
   integrity sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==
   dependencies:
     clone-deep "^4.0.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 9.0.0.beta.4
+  version: 9.0.0.beta.5
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -149,6 +149,7 @@ files:
 - ".node-version"
 - ".rspec"
 - ".rubocop.yml"
+- ".yalcignore"
 - CHANGELOG.md
 - CLAUDE.md
 - CONTRIBUTING.md
@@ -180,6 +181,7 @@ files:
 - docs/subresource_integrity.md
 - docs/transpiler-performance.md
 - docs/troubleshooting.md
+- docs/typescript.md
 - docs/using_esbuild_loader.md
 - docs/using_swc_loader.md
 - docs/v6_upgrade.md
@@ -214,6 +216,7 @@ files:
 - lib/shakapacker/dev_server_proxy.rb
 - lib/shakapacker/dev_server_runner.rb
 - lib/shakapacker/digest_strategy.rb
+- lib/shakapacker/doctor.rb
 - lib/shakapacker/env.rb
 - lib/shakapacker/helper.rb
 - lib/shakapacker/instance.rb
@@ -222,6 +225,7 @@ files:
 - lib/shakapacker/railtie.rb
 - lib/shakapacker/rspack_runner.rb
 - lib/shakapacker/runner.rb
+- lib/shakapacker/swc_migrator.rb
 - lib/shakapacker/utils/manager.rb
 - lib/shakapacker/utils/misc.rb
 - lib/shakapacker/utils/version_syntax_converter.rb
@@ -236,22 +240,26 @@ files:
 - lib/tasks/shakapacker/clean.rake
 - lib/tasks/shakapacker/clobber.rake
 - lib/tasks/shakapacker/compile.rake
+- lib/tasks/shakapacker/doctor.rake
 - lib/tasks/shakapacker/info.rake
 - lib/tasks/shakapacker/install.rake
+- lib/tasks/shakapacker/migrate_to_swc.rake
 - lib/tasks/shakapacker/verify_config.rake
 - lib/tasks/shakapacker/verify_install.rake
 - package.json
 - package/babel/preset.js
-- package/config.js
-- package/dev_server.js
-- package/env.js
+- package/config.ts
+- package/dev_server.ts
+- package/env.ts
 - package/environments/base.js
+- package/environments/base.ts
 - package/environments/development.js
 - package/environments/production.js
 - package/environments/test.js
 - package/esbuild/index.js
 - package/index.d.ts
-- package/index.js
+- package/index.ts
+- package/loaders.d.ts
 - package/optimization/rspack.js
 - package/optimization/webpack.js
 - package/plugins/rspack.js
@@ -272,17 +280,20 @@ files:
 - package/rules/swc.js
 - package/rules/webpack.js
 - package/swc/index.js
-- package/utils/configPath.js
-- package/utils/debug.js
-- package/utils/defaultConfigPath.js
-- package/utils/getStyleRule.js
-- package/utils/helpers.js
-- package/utils/inliningCss.js
-- package/utils/requireOrError.js
-- package/utils/snakeToCamelCase.js
-- package/utils/validateCssModulesConfig.js
-- package/utils/validateDependencies.js
-- package/webpackDevServerConfig.js
+- package/types.ts
+- package/utils/configPath.ts
+- package/utils/debug.ts
+- package/utils/defaultConfigPath.ts
+- package/utils/errorHelpers.ts
+- package/utils/getStyleRule.ts
+- package/utils/helpers.ts
+- package/utils/inliningCss.ts
+- package/utils/requireOrError.ts
+- package/utils/snakeToCamelCase.ts
+- package/utils/typeGuards.ts
+- package/utils/validateDependencies.ts
+- package/webpack-types.d.ts
+- package/webpackDevServerConfig.ts
 - prettier.config.js
 - shakapacker.gemspec
 - test/helpers.js
@@ -307,14 +318,16 @@ files:
 - test/package/staging.test.js
 - test/package/test.test.js
 - test/resolver.js
+- test/typescript/build.test.js
 - tools/README.md
 - tools/css-modules-v9-codemod.js
+- tsconfig.json
 - yarn.lock
 homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.0.0.beta.4
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.0.0.beta.5
 rdoc_options: []
 require_paths:
 - lib
@@ -355,3 +368,4 @@ test_files:
 - test/package/staging.test.js
 - test/package/test.test.js
 - test/resolver.js
+- test/typescript/build.test.js

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 }