shakapacker 9.1.0 → 9.3.0.beta.0

data/package/index.d.ts.template

@@ -0,0 +1,50 @@
+/**
+ * Manual type definitions for Shakapacker package exports.
+ *
+ * This file is manually maintained because TypeScript cannot infer types
+ * from the `export =` syntax with dynamic require() calls in index.ts.
+ *
+ * When adding/modifying exports in index.ts, update this file accordingly.
+ */
+
+import type { Configuration, RuleSetRule } from "webpack"
+import type { Config, DevServerConfig, Env } from "./types"
+
+/**
+ * The shape of the Shakapacker module exports.
+ * This interface represents the object exported via CommonJS `export =`.
+ */
+interface ShakapackerExports {
+  /** Shakapacker configuration from shakapacker.yml */
+  config: Config
+  /** Development server configuration */
+  devServer: DevServerConfig
+  /** Base webpack/rspack configuration */
+  baseConfig: Configuration
+  /** Environment configuration (railsEnv, nodeEnv, etc.) */
+  env: Env
+  /** Array of webpack/rspack loader rules */
+  rules: RuleSetRule[]
+  /** Check if a module exists in node_modules */
+  moduleExists: (packageName: string) => boolean
+  /** Process a file if a specific loader is available */
+  canProcess: <T = unknown>(
+    rule: string,
+    fn: (modulePath: string) => T
+  ) => T | null
+  /** Whether CSS should be inlined (dev server with HMR) */
+  inliningCss: boolean
+  /** Generate webpack configuration with optional custom config */
+  generateWebpackConfig: (extraConfig?: Configuration) => Configuration
+  /** webpack-merge's merge function */
+  merge: typeof import("webpack-merge").merge
+  /** webpack-merge's mergeWithCustomize function */
+  mergeWithCustomize: typeof import("webpack-merge").mergeWithCustomize
+  /** webpack-merge's mergeWithRules function */
+  mergeWithRules: typeof import("webpack-merge").mergeWithRules
+  /** webpack-merge's unique function */
+  unique: typeof import("webpack-merge").unique
+}
+
+declare const shakapacker: ShakapackerExports
+export = shakapacker

data/package/index.ts

@@ -1,17 +1,17 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const webpackMerge = require("webpack-merge")
+import * as webpackMerge from "webpack-merge"
 import { resolve } from "path"
 import { existsSync } from "fs"
 // @ts-ignore: webpack is an optional peer dependency (using type-only import)
 import type { Configuration } from "webpack"
-const config = require("./config")
-const baseConfig = require("./environments/base")
-const devServer = require("./dev_server")
-const env = require("./env")
-const { moduleExists, canProcess } = require("./utils/helpers")
-const inliningCss = require("./utils/inliningCss")
+import config from "./config"
+import baseConfig from "./environments/base"
+import devServer from "./dev_server"
+import env from "./env"
+import { moduleExists, canProcess } from "./utils/helpers"
+import inliningCss from "./utils/inliningCss"
 
 const rulesPath = resolve(__dirname, "rules", `${config.assets_bundler}.js`)
 const rules = require(rulesPath)

data/package/loaders.d.ts

@@ -1,5 +1,5 @@
 // @ts-ignore: webpack is an optional peer dependency (using type-only import)
-import type { LoaderDefinitionFunction } from 'webpack'
+import type { LoaderDefinitionFunction } from "webpack"
 
 export interface ShakapackerLoaderOptions {
   [key: string]: any
@@ -25,4 +25,4 @@ export interface LoaderConfig {
 }
 
 export function resolveLoader(name: string): string
-export function createLoader(config: LoaderConfig): LoaderConfig
+export function createLoader(config: LoaderConfig): LoaderConfig

data/package/optimization/rspack.ts

@@ -18,7 +18,7 @@ const getOptimization = (): OptimizationConfig => {
     ]
   } catch (error: unknown) {
     const errorMessage = error instanceof Error ? error.message : String(error)
-    const errorStack = error instanceof Error ? error.stack : ''
+    const errorStack = error instanceof Error ? error.stack : ""
     // Log full error with stack trace
     logError(
       `Failed to configure Rspack minimizers: ${errorMessage}\n${errorStack}`

data/package/plugins/rspack.ts

@@ -18,7 +18,11 @@ interface EntrypointAssets {
 
 interface Manifest {
   entrypoints?: Record<string, { assets: EntrypointAssets }>
-  [key: string]: string | { assets: EntrypointAssets } | Record<string, { assets: EntrypointAssets }> | undefined
+  [key: string]:
+    | string
+    | { assets: EntrypointAssets }
+    | Record<string, { assets: EntrypointAssets }>
+    | undefined
 }
 
 const getPlugins = (): unknown[] => {
@@ -29,7 +33,11 @@ const getPlugins = (): unknown[] => {
       publicPath: config.publicPathWithoutCDN,
       writeToFileEmit: true,
       // rspack-manifest-plugin uses different option names than webpack-assets-manifest
-      generate: (seed: Manifest | null, files: ManifestFile[], entrypoints: Record<string, string[]>) => {
+      generate: (
+        seed: Manifest | null,
+        files: ManifestFile[],
+        entrypoints: Record<string, string[]>
+      ) => {
         const manifest: Manifest = seed || {}
 
         // Add files mapping first
@@ -38,7 +46,10 @@ const getPlugins = (): unknown[] => {
         })
 
         // Add entrypoints information compatible with Shakapacker expectations
-        const entrypointsManifest: Record<string, { assets: EntrypointAssets }> = {}
+        const entrypointsManifest: Record<
+          string,
+          { assets: EntrypointAssets }
+        > = {}
         Object.entries(entrypoints).forEach(
           ([entrypointName, entrypointFiles]) => {
             const jsFiles = entrypointFiles
@@ -86,7 +97,7 @@ const getPlugins = (): unknown[] => {
   }
 
   // Use Rspack's built-in SubresourceIntegrityPlugin
-  if (config.integrity.enabled) {
+  if (config.integrity?.enabled) {
     plugins.push(
       new rspack.SubresourceIntegrityPlugin({
         hashFuncNames: config.integrity.hash_functions,

data/package/plugins/webpack.ts

@@ -20,8 +20,12 @@ const getPlugins = (): unknown[] => {
       output: config.manifestPath,
       entrypointsUseAssets: true,
       publicPath: config.publicPathWithoutCDN,
-      integrity: config.integrity.enabled,
-      integrityHashes: config.integrity.hash_functions
+      ...(config.integrity
+        ? {
+            integrity: config.integrity.enabled,
+            integrityHashes: config.integrity.hash_functions
+          }
+        : {})
     })
   ]
 
@@ -40,7 +44,7 @@ const getPlugins = (): unknown[] => {
   }
 
   if (
-    config.integrity.enabled &&
+    config.integrity?.enabled &&
     moduleExists("webpack-subresource-integrity")
   ) {
     const SubresourceIntegrityPlugin = requireOrError(

data/package/rspack/index.ts

@@ -21,7 +21,10 @@ const { validateRspackDependencies } = require("../utils/validateDependencies")
 const rulesPath = resolve(__dirname, "../rules", "rspack.js")
 const rules = require(rulesPath)
 
-const generateRspackConfig = (extraConfig: RspackConfigWithDevServer = {}, ...extraArgs: unknown[]): RspackConfigWithDevServer => {
+const generateRspackConfig = (
+  extraConfig: RspackConfigWithDevServer = {},
+  ...extraArgs: unknown[]
+): RspackConfigWithDevServer => {
   // Validate required dependencies first
   validateRspackDependencies()
   if (extraArgs.length > 0) {
@@ -49,7 +52,12 @@ const generateRspackConfig = (extraConfig: RspackConfigWithDevServer = {}, ...ex
 }
 
 // Re-export webpack-merge utilities for backward compatibility
-export { merge, mergeWithCustomize, mergeWithRules, unique } from "webpack-merge"
+export {
+  merge,
+  mergeWithCustomize,
+  mergeWithRules,
+  unique
+} from "webpack-merge"
 
 export {
   config, // shakapacker.yml

data/package/rules/raw.ts

@@ -21,5 +21,6 @@ const webpackRawConfig = () => ({
   ]
 })
 
-export =
-  config.assets_bundler === "rspack" ? rspackRawConfig() : webpackRawConfig()
+export = config.assets_bundler === "rspack"
+  ? rspackRawConfig()
+  : webpackRawConfig()

data/package/rules/sass.ts

@@ -6,7 +6,7 @@ const { additional_paths: extraPaths } = require("../config")
 
 export = canProcess("sass-loader", (resolvedPath: string) => {
   const optionKey =
-    packageMajorVersion("sass-loader") > 15 ? "loadPaths" : "includePaths"
+    packageMajorVersion("sass-loader") >= 16 ? "loadPaths" : "includePaths"
   return getStyleRule(/\.(scss|sass)(\.erb)?$/i, [
     {
       loader: resolvedPath,

data/package/types/README.md

@@ -8,8 +8,8 @@ Instead of importing types from deep paths:
 
 ```typescript
 // ❌ Old way - importing from multiple deep paths
-import type { Config } from 'shakapacker/package/types'
-import type { WebpackConfigWithDevServer } from 'shakapacker/package/environments/types'
+import type { Config } from "shakapacker/package/types"
+import type { WebpackConfigWithDevServer } from "shakapacker/package/environments/types"
 ```
 
 You can now import all types from a single location:
@@ -20,12 +20,13 @@ import type {
   Config,
   WebpackConfigWithDevServer,
   RspackConfigWithDevServer
-} from 'shakapacker/types'
+} from "shakapacker/types"
 ```
 
 ## Available Types
 
 ### Core Configuration Types
+
 - `Config` - Main Shakapacker configuration interface
 - `YamlConfig` - YAML configuration structure
 - `LegacyConfig` - Legacy configuration with deprecated options
@@ -33,12 +34,14 @@ import type {
 - `DevServerConfig` - Development server configuration
 
 ### Loader Types
+
 - `ShakapackerLoader` - Loader interface
 - `ShakapackerLoaderOptions` - Loader options interface
 - `LoaderResolver` - Function type for resolving loaders
 - `LoaderConfig` - Loader configuration interface
 
 ### Webpack/Rspack Types
+
 - `WebpackConfigWithDevServer` - Webpack config with dev server
 - `RspackConfigWithDevServer` - Rspack config with dev server
 - `RspackPluginInstance` - Rspack plugin instance type
@@ -50,12 +53,14 @@ import type {
 - `ReactRefreshRspackPlugin` - React refresh plugin for Rspack
 
 ### Webpack-Specific Types
+
 - `ShakapackerWebpackConfig` - Extended Webpack configuration
 - `ShakapackerRule` - Extended Webpack rule
 - `LoaderType` - String or loader object type
 - `LoaderUtils` - Loader utility functions
 
 ### Re-exported Types
+
 - `WebpackConfiguration` - From 'webpack'
 - `WebpackPluginInstance` - From 'webpack'
 - `RuleSetRule` - From 'webpack'
@@ -64,25 +69,22 @@ import type {
 ## Example Usage
 
 ```typescript
-import type {
-  Config,
-  WebpackConfigWithDevServer
-} from 'shakapacker/types'
+import type { Config, WebpackConfigWithDevServer } from "shakapacker/types"
 
 const config: Config = {
-  source_path: 'app/javascript',
-  source_entry_path: 'packs',
-  public_root_path: 'public',
-  public_output_path: 'packs',
+  source_path: "app/javascript",
+  source_entry_path: "packs",
+  public_root_path: "public",
+  public_output_path: "packs"
   // ... other config
 }
 
 const webpackConfig: WebpackConfigWithDevServer = {
-  mode: 'development',
+  mode: "development",
   devServer: {
     hot: true,
     port: 3035
   }
   // ... other webpack config
 }
-```
+```

data/package/types/index.ts

@@ -17,7 +17,7 @@ export type {
   LegacyConfig,
   Env,
   DevServerConfig
-} from '../types'
+} from "../types"
 
 // Loader types
 export type {
@@ -25,7 +25,7 @@ export type {
   ShakapackerLoaderOptions,
   LoaderResolver,
   LoaderConfig
-} from '../loaders'
+} from "../loaders"
 
 // Webpack-specific types
 export type {
@@ -35,7 +35,7 @@ export type {
   ShakapackerLoader as WebpackLoader,
   LoaderType,
   LoaderUtils
-} from '../webpack-types'
+} from "../webpack-types"
 
 // Environment configuration types
 export type {
@@ -48,7 +48,7 @@ export type {
   CompressionPluginConstructor,
   ReactRefreshWebpackPlugin,
   ReactRefreshRspackPlugin
-} from '../environments/types'
+} from "../environments/types"
 
 // Node.js error type (re-exported for convenience)
 export type NodeJSError = NodeJS.ErrnoException
@@ -58,4 +58,4 @@ export type {
   Configuration as WebpackConfiguration,
   WebpackPluginInstance,
   RuleSetRule
-} from 'webpack'
+} from "webpack"

data/package/types.ts

@@ -105,4 +105,3 @@ export interface DevServerConfig {
     | { type?: string | boolean | ServerType; options?: https.ServerOptions }
   [otherWebpackDevServerConfigKey: string]: unknown
 }
-

data/package/utils/defaultConfigPath.ts

@@ -1,4 +1,7 @@
 import { resolve } from "path"
 
-const path: string = resolve(__dirname, "../../lib/install/config/shakapacker.yml")
+const path: string = resolve(
+  __dirname,
+  "../../lib/install/config/shakapacker.yml"
+)
 export = path