refactor: types (#4583)

Author: alexander-akait

package.json

@@ -97,7 +97,7 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4",
     "typescript-eslint": "^8.35.0",
-    "webpack": "^5.101.0",
+    "webpack": "^5.103.0",
     "webpack-bundle-analyzer": "^4.5.0",
     "webpack-dev-server": "^5.1.0"
   },

packages/webpack-cli/src/types.ts

@@ -9,7 +9,7 @@ import {
   type EntryOptions,
   type FileCacheOptions,
   type MultiCompiler,
-  type MultiCompilerOptions,
+  type MultiConfiguration,
   type MultiStats,
   type Stats,
   type WebpackError,
@@ -26,7 +26,10 @@ import {
  * Webpack CLI
  */
 
-type WebpackCallback = (err: Error | undefined, stats: Stats | MultiStats | undefined) => void;
+declare interface WebpackCallback {
+  (err: null | Error, result?: Stats): void;
+  (err: null | Error, result?: MultiStats): void;
+}
 
 // TODO remove me in the next major release, we don't need extra interface
 interface IWebpackCLI {
@@ -95,7 +98,7 @@ interface WebpackCLICommandOption extends CommanderOption {
 }
 
 interface WebpackCLIConfig {
-  options: WebpackConfiguration | (WebpackConfiguration[] & MultiCompilerOptions);
+  options: Configuration | MultiConfiguration;
   path: WeakMap<object, string[]>;
 }
 
@@ -159,7 +162,7 @@ type WebpackCLIExternalCommandInfo = Pick<WebpackCLIOptions, "name" | "alias" |
  */
 
 type WebpackDevServerOptions = DevServerConfig &
-  WebpackConfiguration &
+  Configuration &
   ClientConfiguration &
   AssetEmittedInfo &
   WebpackOptionsNormalized &
@@ -183,11 +186,8 @@ type WebpackDevServerOptions = DevServerConfig &
 /**
  * Webpack
  */
-type WebpackConfiguration = Configuration;
-type LoadableWebpackConfiguration = PotentialPromise<
-  WebpackConfiguration | CallableWebpackConfiguration
->;
-type CallableWebpackConfiguration = (env: Env | undefined, argv: Argv) => WebpackConfiguration;
+type LoadableWebpackConfiguration = PotentialPromise<Configuration | CallableWebpackConfiguration>;
+type CallableWebpackConfiguration = (env: Env | undefined, argv: Argv) => Configuration;
 type WebpackCompiler = Compiler | MultiCompiler;
 
 interface EnumValueObject {
@@ -205,7 +205,7 @@ interface ArgumentConfig {
   values?: EnumValue[];
 }
 
-type FileSystemCacheOptions = WebpackConfiguration & {
+type FileSystemCacheOptions = Configuration & {
   cache: FileCacheOptions & { defaultConfig: string[] };
 };
 
@@ -343,7 +343,6 @@ export {
   type WebpackCLIOptions,
   type WebpackCallback,
   type WebpackCompiler,
-  type WebpackConfiguration,
   type WebpackDevServerOptions,
   type WebpackRunOptions,
 };

packages/webpack-cli/src/webpack-cli.ts

@@ -2,7 +2,9 @@ import { type stringifyChunked } from "@discoveryjs/json-ext";
 import { type Help, type ParseOptions } from "commander";
 import {
   type Compiler,
+  type Configuration,
   type MultiCompiler,
+  type MultiConfiguration,
   type MultiStatsOptions,
   type StatsOptions,
   type WebpackError,
@@ -50,7 +52,6 @@ import {
   type WebpackCLIOptions,
   type WebpackCallback,
   type WebpackCompiler,
-  type WebpackConfiguration,
   type WebpackDevServerOptions,
   type WebpackRunOptions,
 } from "./types.js";
@@ -112,6 +113,12 @@ class WebpackCLI implements IWebpackCLI {
     });
   }
 
+  isMultipleConfiguration(
+    config: Configuration | MultiConfiguration,
+  ): config is MultiConfiguration {
+    return Array.isArray(config);
+  }
+
   isMultipleCompiler(compiler: WebpackCompiler): compiler is MultiCompiler {
     return (compiler as MultiCompiler).compilers as unknown as boolean;
   }
@@ -1791,7 +1798,7 @@ class WebpackCLI implements IWebpackCLI {
     const loadConfigByPath = async (
       configPath: string,
       argv: Argv = {},
-    ): Promise<{ options: WebpackConfiguration | WebpackConfiguration[]; path: string }> => {
+    ): Promise<{ options: Configuration | Configuration[]; path: string }> => {
       const ext = path.extname(configPath).toLowerCase();
       let interpreted = Object.keys(interpret.jsVariants).find((variant) => variant === ext);
       // Fallback `.cts` to `.ts`
@@ -1824,7 +1831,7 @@ class WebpackCLI implements IWebpackCLI {
 
       let options: LoadableWebpackConfiguration | LoadableWebpackConfiguration[];
 
-      type LoadConfigOption = PotentialPromise<WebpackConfiguration>;
+      type LoadConfigOption = PotentialPromise<Configuration>;
 
       let moduleType: "unknown" | "commonjs" | "esm" = "unknown";
 
@@ -1868,8 +1875,8 @@ class WebpackCLI implements IWebpackCLI {
         await Promise.all(
           optionsArray.map(async (_, i) => {
             if (
-              this.isPromise<WebpackConfiguration | CallableWebpackConfiguration>(
-                optionsArray[i] as Promise<WebpackConfiguration | CallableWebpackConfiguration>,
+              this.isPromise<Configuration | CallableWebpackConfiguration>(
+                optionsArray[i] as Promise<Configuration | CallableWebpackConfiguration>,
               )
             ) {
               optionsArray[i] = await optionsArray[i];
@@ -1908,7 +1915,7 @@ class WebpackCLI implements IWebpackCLI {
       }
 
       return {
-        options: options as WebpackConfiguration | WebpackConfiguration[],
+        options: options as Configuration | Configuration[],
         path: configPath,
       };
     };
@@ -1933,11 +1940,11 @@ class WebpackCLI implements IWebpackCLI {
         for (const loadedConfig of loadedConfigs) {
           if (Array.isArray(loadedConfig.options)) {
             for (const item of loadedConfig.options) {
-              (config.options as WebpackConfiguration[]).push(item);
+              (config.options as Configuration[]).push(item);
               config.path.set(options, [loadedConfig.path]);
             }
           } else {
-            (config.options as WebpackConfiguration[]).push(loadedConfig.options);
+            (config.options as Configuration[]).push(loadedConfig.options);
             config.path.set(loadedConfig.options, [loadedConfig.path]);
           }
         }
@@ -1976,7 +1983,7 @@ class WebpackCLI implements IWebpackCLI {
 
         config.options = loadedConfig.options;
 
-        if (Array.isArray(config.options)) {
+        if (this.isMultipleConfiguration(config.options)) {
           for (const item of config.options) {
             config.path.set(item, [loadedConfig.path]);
           }
@@ -1992,7 +1999,7 @@ class WebpackCLI implements IWebpackCLI {
       config.options = options.configName.map((configName) => {
         let found;
 
-        if (Array.isArray(config.options)) {
+        if (this.isMultipleConfiguration(config.options)) {
           found = config.options.find((options) => options.name === configName);
         } else {
           found = config.options.name === configName ? config.options : undefined;
@@ -2003,7 +2010,7 @@ class WebpackCLI implements IWebpackCLI {
         }
 
         return found;
-      }) as WebpackConfiguration[];
+      }) as Configuration[];
 
       if (notFoundConfigNames.length > 0) {
         this.logger.error(
@@ -2016,10 +2023,10 @@ class WebpackCLI implements IWebpackCLI {
     }
 
     const resolveExtends = async (
-      config: WebpackConfiguration,
+      config: Configuration,
       configPaths: WebpackCLIConfig["path"],
       extendsPaths: string[],
-    ): Promise<WebpackConfiguration> => {
+    ): Promise<Configuration> => {
       delete config.extends;
 
       const loadedConfigs = await Promise.all(
@@ -2044,10 +2051,7 @@ class WebpackCLI implements IWebpackCLI {
           }
         }
 
-        config = merge(
-          ...(loadedOptions as [WebpackConfiguration, ...WebpackConfiguration[]]),
-          config,
-        );
+        config = merge(...(loadedOptions as [Configuration, ...Configuration[]]), config);
 
         if (prevPaths) {
           configPaths.set(config, [...prevPaths, ...loadedPaths]);
@@ -2067,7 +2071,7 @@ class WebpackCLI implements IWebpackCLI {
     if (options.extends && options.extends.length > 0) {
       const extendsPaths = options.extends;
 
-      if (Array.isArray(config.options)) {
+      if (this.isMultipleConfiguration(config.options)) {
         config.options = await Promise.all(
           config.options.map((options) => resolveExtends(options, config.path, extendsPaths)),
         );
@@ -2077,7 +2081,10 @@ class WebpackCLI implements IWebpackCLI {
       }
     }
     // if no extends option is passed, check if the config file has extends
-    else if (Array.isArray(config.options) && config.options.some((options) => options.extends)) {
+    else if (
+      this.isMultipleConfiguration(config.options) &&
+      config.options.some((options) => options.extends)
+    ) {
       config.options = await Promise.all(
         config.options.map((options) => {
           if (options.extends) {
@@ -2090,7 +2097,7 @@ class WebpackCLI implements IWebpackCLI {
           return options;
         }),
       );
-    } else if (!Array.isArray(config.options) && config.options.extends) {
+    } else if (!this.isMultipleConfiguration(config.options) && config.options.extends) {
       config.options = await resolveExtends(
         config.options,
         config.path,
@@ -2106,7 +2113,7 @@ class WebpackCLI implements IWebpackCLI {
       // we can only merge when there are multiple configurations
       // either by passing multiple configs by flags or passing a
       // single config exporting an array
-      if (!Array.isArray(config.options) || config.options.length <= 1) {
+      if (!this.isMultipleConfiguration(config.options) || config.options.length <= 1) {
         this.logger.error("At least two configurations are required for merge.");
         process.exit(2);
       }
@@ -2159,7 +2166,7 @@ class WebpackCLI implements IWebpackCLI {
         "./plugins/cli-plugin",
       );
 
-    const internalBuildConfig = (item: WebpackConfiguration) => {
+    const internalBuildConfig = (item: Configuration) => {
       const originalWatchValue = item.watch;
 
       // Apply options
@@ -2246,9 +2253,7 @@ class WebpackCLI implements IWebpackCLI {
         }
       }
 
-      const isFileSystemCacheOptions = (
-        config: WebpackConfiguration,
-      ): config is FileSystemCacheOptions =>
+      const isFileSystemCacheOptions = (config: Configuration): config is FileSystemCacheOptions =>
         Boolean(config.cache) && (config as FileSystemCacheOptions).cache.type === "filesystem";
 
       // Setup default cache options
@@ -2325,13 +2330,13 @@ class WebpackCLI implements IWebpackCLI {
             helpfulOutput: !options.json,
             progress: options.progress,
             analyze: options.analyze,
-            isMultiCompiler: Array.isArray(config.options),
+            isMultiCompiler: this.isMultipleConfiguration(config.options),
           }),
         );
       }
     };
 
-    if (Array.isArray(config.options)) {
+    if (this.isMultipleConfiguration(config.options)) {
       for (const item of config.options) {
         internalBuildConfig(item);
       }
@@ -2364,19 +2369,16 @@ class WebpackCLI implements IWebpackCLI {
     let compiler: WebpackCompiler;
 
     try {
-      compiler = this.webpack(
-        config.options,
-        callback
-          ? (error, stats) => {
-              if (error && this.isValidationError(error)) {
-                this.logger.error(error.message);
-                process.exit(2);
-              }
-
-              callback(error as Error | undefined, stats);
+      compiler = callback
+        ? this.webpack(config.options, (error, stats) => {
+            if (error && this.isValidationError(error)) {
+              this.logger.error(error.message);
+              process.exit(2);
             }
-          : callback,
-      )!;
+
+            callback(error as Error | null, stats);
+          })!
+        : this.webpack(config.options);
     } catch (error) {
       if (this.isValidationError(error)) {
         this.logger.error(error.message);

yarn.lock

@@ -7956,10 +7956,10 @@ load-json-file@^4.0.0:
     pify "^3.0.0"
     strip-bom "^3.0.0"
 
-loader-runner@^4.2.0:
-  version "4.3.0"
-  resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1"
-  integrity sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==
+loader-runner@^4.3.1:
+  version "4.3.1"
+  resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.1.tgz#6c76ed29b0ccce9af379208299f07f876de737e3"
+  integrity sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==
 
 locate-path@^2.0.0:
   version "2.0.0"
@@ -11759,10 +11759,10 @@ webpack-sources@^3.3.3:
   resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.3.tgz#d4bf7f9909675d7a070ff14d0ef2a4f3c982c723"
   integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg==
 
-webpack@^5.101.0:
-  version "5.102.1"
-  resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.102.1.tgz#1003a3024741a96ba99c37431938bf61aad3d988"
-  integrity sha512-7h/weGm9d/ywQ6qzJ+Xy+r9n/3qgp/thalBbpOi5i223dPXKi04IBtqPN9nTd+jBc7QKfvDbaBnFipYp4sJAUQ==
+webpack@^5.103.0:
+  version "5.103.0"
+  resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.103.0.tgz#17a7c5a5020d5a3a37c118d002eade5ee2c6f3da"
+  integrity sha512-HU1JOuV1OavsZ+mfigY0j8d1TgQgbZ6M+J75zDkpEAwYeXjWSqrGJtgnPblJjd/mAyTNQ7ygw0MiKOn6etz8yw==
   dependencies:
     "@types/eslint-scope" "^3.7.7"
     "@types/estree" "^1.0.8"
@@ -11781,7 +11781,7 @@ webpack@^5.101.0:
     glob-to-regexp "^0.4.1"
     graceful-fs "^4.2.11"
     json-parse-even-better-errors "^2.3.1"
-    loader-runner "^4.2.0"
+    loader-runner "^4.3.1"
     mime-types "^2.1.27"
     neo-async "^2.6.2"
     schema-utils "^4.3.3"