refactor: consolidate helpers (#1245)

jbroma · web-flow · commit b690044bceaf · 2025-08-06T18:25:29.000+02:00
diff --git a/packages/repack/src/commands/common/adaptFilenameToPlatform.ts b/packages/repack/src/commands/common/adaptFilenameToPlatform.ts
diff --git a/packages/repack/src/commands/common/cliError.ts b/packages/repack/src/commands/common/cliError.ts
diff --git a/packages/repack/src/commands/common/config/getConfigFilePath.ts b/packages/repack/src/commands/common/config/getConfigFilePath.ts
@@ -1,10 +1,10 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import { CLIError } from '../../../helpers/index.js';
 import {
   DEFAULT_RSPACK_CONFIG_LOCATIONS,
   DEFAULT_WEBPACK_CONFIG_LOCATIONS,
 } from '../../consts.js';
-import { CLIError } from '../cliError.js';
 
 function discoverConfigFilePath(root: string, candidates: string[]) {
   for (const candidate of candidates) {
diff --git a/packages/repack/src/commands/common/index.ts b/packages/repack/src/commands/common/index.ts
@@ -1,10 +1,10 @@
-export * from './adaptFilenameToPlatform.js';
 export * from './getDevMiddleware.js';
 export * from './getMimeType.js';
-export * from './resolveProjectPath.js';
-export * from './runAdbReverse.js';
 export * from './parseUrl.js';
 export * from './resetPersistentCache.js';
+export * from './resolveProjectPath.js';
+export * from './runAdbReverse.js';
+export * from './setupEnvironment.js';
 export * from './setupInteractions.js';
 export * from './setupStatsWriter.js';
 
diff --git a/packages/repack/src/commands/rspack/Compiler.ts b/packages/repack/src/commands/rspack/Compiler.ts
@@ -8,10 +8,10 @@ import type {
   StatsCompilation,
 } from '@rspack/core';
 import memfs from 'memfs';
+import { CLIError, adaptFilenameToPlatform } from '../../helpers/index.js';
 import type { Reporter } from '../../logging/types.js';
 import type { HMRMessage } from '../../types.js';
-import { CLIError } from '../common/cliError.js';
-import { adaptFilenameToPlatform, runAdbReverse } from '../common/index.js';
+import { runAdbReverse } from '../common/index.js';
 import { DEV_SERVER_ASSET_TYPES } from '../consts.js';
 import type { CompilerAsset } from './types.js';
 
diff --git a/packages/repack/src/commands/rspack/bundle.ts b/packages/repack/src/commands/rspack/bundle.ts
@@ -1,6 +1,6 @@
 import { type Configuration, rspack } from '@rspack/core';
 import type { Stats } from '@rspack/core';
-import { CLIError } from '../common/cliError.js';
+import { CLIError } from '../../helpers/index.js';
 import { makeCompilerConfig } from '../common/config/makeCompilerConfig.js';
 import {
   normalizeStatsOptions,
diff --git a/packages/repack/src/commands/rspack/start.ts b/packages/repack/src/commands/rspack/start.ts
@@ -1,13 +1,13 @@
 import type { Configuration } from '@rspack/core';
 import packageJson from '../../../package.json';
+import { CLIError } from '../../helpers/index.js';
 import {
   ConsoleReporter,
   FileReporter,
   type Reporter,
   composeReporters,
   makeLogEntryFromFastifyLog,
 } from '../../logging/index.js';
-import { CLIError } from '../common/cliError.js';
 import { makeCompilerConfig } from '../common/config/makeCompilerConfig.js';
 import {
   getDevMiddleware,
diff --git a/packages/repack/src/commands/webpack/Compiler.ts b/packages/repack/src/commands/webpack/Compiler.ts
@@ -5,8 +5,8 @@ import { Worker } from 'node:worker_threads';
 import type { SendProgress } from '@callstack/repack-dev-server';
 import type webpack from 'webpack';
 import { WORKER_ENV_KEY } from '../../env.js';
+import { CLIError } from '../../helpers/index.js';
 import type { LogType, Reporter } from '../../logging/types.js';
-import { CLIError } from '../common/cliError.js';
 import { DEV_SERVER_ASSET_TYPES } from '../consts.js';
 import type { StartArguments } from '../types.js';
 import type {
diff --git a/packages/repack/src/commands/webpack/CompilerWorker.ts b/packages/repack/src/commands/webpack/CompilerWorker.ts
@@ -2,8 +2,8 @@ import path from 'node:path';
 import { parentPort, workerData } from 'node:worker_threads';
 import memfs from 'memfs';
 import webpack, { type Configuration } from 'webpack';
+import { adaptFilenameToPlatform } from '../../helpers/index.js';
 import { makeCompilerConfig } from '../common/config/makeCompilerConfig.js';
-import { adaptFilenameToPlatform } from '../common/index.js';
 import type {
   CompilerAsset,
   WebpackWorkerOptions,
diff --git a/packages/repack/src/commands/webpack/bundle.ts b/packages/repack/src/commands/webpack/bundle.ts
@@ -1,5 +1,5 @@
 import webpack, { type Configuration } from 'webpack';
-import { CLIError } from '../common/cliError.js';
+import { CLIError } from '../../helpers/index.js';
 import { makeCompilerConfig } from '../common/config/makeCompilerConfig.js';
 import {
   normalizeStatsOptions,
diff --git a/packages/repack/src/commands/webpack/start.ts b/packages/repack/src/commands/webpack/start.ts
@@ -1,6 +1,7 @@
 import type { Server } from '@callstack/repack-dev-server';
 import type { Configuration, StatsCompilation } from 'webpack';
 import packageJson from '../../../package.json';
+import { CLIError } from '../../helpers/index.js';
 import {
   ConsoleReporter,
   FileReporter,
@@ -9,7 +10,6 @@ import {
   makeLogEntryFromFastifyLog,
 } from '../../logging/index.js';
 import type { HMRMessage } from '../../types.js';
-import { CLIError } from '../common/cliError.js';
 import { makeCompilerConfig } from '../common/config/makeCompilerConfig.js';
 import {
   getDevMiddleware,
diff --git a/packages/repack/src/helpers/__tests__/helpers.test.ts b/packages/repack/src/helpers/__tests__/helpers.test.ts
@@ -1,4 +1,4 @@
-import { moveElementBefore } from '../moveElementBefore.js';
+import { moveElementBefore } from '../helpers.js';
 
 describe('moveElementBefore', () => {
   it('should move element before target using string matcher', () => {
diff --git a/packages/repack/src/helpers/errors.ts b/packages/repack/src/helpers/errors.ts
@@ -0,0 +1,26 @@
+import { VERBOSE_ENV_KEY } from '../env.js';
+import { isTruthyEnv } from './helpers.js';
+
+export class ConfigurationError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'ConfigurationError';
+
+    // hide stack trace in non-verbose mode
+    if (!isTruthyEnv(process.env[VERBOSE_ENV_KEY])) {
+      this.stack = undefined;
+    }
+  }
+}
+
+export class CLIError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'CLIError';
+
+    // hide stack trace in non-verbose mode
+    if (!isTruthyEnv(process.env[VERBOSE_ENV_KEY])) {
+      this.stack = undefined;
+    }
+  }
+}
diff --git a/packages/repack/src/helpers/helpers.ts b/packages/repack/src/helpers/helpers.ts
@@ -1,3 +1,21 @@
+import os from 'node:os';
+import type { Compiler as RspackCompiler } from '@rspack/core';
+import type { Compiler as WebpackCompiler } from 'webpack';
+
+// reference: https://github.com/web-infra-dev/rspack/discussions/2640
+export function isRspackCompiler(compiler: RspackCompiler | WebpackCompiler) {
+  return 'rspackVersion' in compiler.webpack;
+}
+
+export function isTruthyEnv(env: string | undefined): boolean {
+  return !!env && env !== 'false' && env !== '0';
+}
+
+export function adaptFilenameToPlatform(filename: string): string {
+  if (os.platform() !== 'win32') return filename;
+  return filename.replace(/\\/g, '/');
+}
+
 interface MoveElementBeforeConfig<T> {
   beforeElement: string | RegExp;
   elementToMove: string | RegExp;
diff --git a/packages/repack/src/helpers/index.ts b/packages/repack/src/helpers/index.ts
@@ -0,0 +1,2 @@
+export * from './errors.js';
+export * from './helpers.js';
diff --git a/packages/repack/src/plugins/DevelopmentPlugin.ts b/packages/repack/src/plugins/DevelopmentPlugin.ts
@@ -7,8 +7,7 @@ import type {
 } from '@rspack/core';
 import ReactRefreshPlugin from '@rspack/plugin-react-refresh';
 import type { Compiler as WebpackCompiler } from 'webpack';
-import { isRspackCompiler } from './utils/isRspackCompiler.js';
-import { moveElementBefore } from './utils/moveElementBefore.js';
+import { isRspackCompiler, moveElementBefore } from '../helpers/index.js';
 
 const [reactRefreshEntryPath, reactRefreshPath, refreshUtilsPath] =
   ReactRefreshPlugin.deprecated_runtimePaths;
diff --git a/packages/repack/src/plugins/LoggerPlugin.ts b/packages/repack/src/plugins/LoggerPlugin.ts
@@ -1,6 +1,7 @@
 import type { Compiler as RspackCompiler } from '@rspack/core';
 import type { Compiler as WebpackCompiler } from 'webpack';
 import { VERBOSE_ENV_KEY, WORKER_ENV_KEY } from '../env.js';
+import { isTruthyEnv } from '../helpers/index.js';
 import {
   ConsoleReporter,
   FileReporter,
@@ -53,10 +54,6 @@ export class LoggerPlugin {
   constructor(private config: LoggerPluginConfig) {
     this.config.output = this.config.output ?? { console: true };
 
-    const isTruthyEnv = (env: string | undefined) => {
-      return !!env && env !== 'false' && env !== '0';
-    };
-
     const reporters = [];
     if (this.config.output.console) {
       reporters.push(
diff --git a/packages/repack/src/plugins/ModuleFederationPluginV1.ts b/packages/repack/src/plugins/ModuleFederationPluginV1.ts
@@ -1,7 +1,7 @@
 import type { Compiler as RspackCompiler, container } from '@rspack/core';
 import type { Compiler as WebpackCompiler } from 'webpack';
+import { isRspackCompiler } from '../helpers/index.js';
 import { Federated } from '../utils/federated.js';
-import { isRspackCompiler } from './utils/isRspackCompiler.js';
 
 type MFPluginV1 = typeof container.ModuleFederationPluginV1;
 type MFPluginV1Options = ConstructorParameters<MFPluginV1>[0];
diff --git a/packages/repack/src/plugins/ModuleFederationPluginV2.ts b/packages/repack/src/plugins/ModuleFederationPluginV2.ts
@@ -2,7 +2,7 @@ import type { moduleFederationPlugin as MF } from '@module-federation/sdk';
 import type { Compiler as RspackCompiler } from '@rspack/core';
 import { name as isIdentifier } from 'estree-util-is-identifier-name';
 import type { Compiler as WebpackCompiler } from 'webpack';
-import { isRspackCompiler } from './utils/isRspackCompiler.js';
+import { isRspackCompiler } from '../helpers/index.js';
 
 type JsModuleDescriptor = {
   identifier: string;
diff --git a/packages/repack/src/plugins/NativeEntryPlugin.ts b/packages/repack/src/plugins/NativeEntryPlugin.ts
@@ -1,8 +1,7 @@
 import path from 'node:path';
 import type { ResolveAlias, Compiler as RspackCompiler } from '@rspack/core';
 import type { Compiler as WebpackCompiler } from 'webpack';
-import { isRspackCompiler } from './utils/isRspackCompiler.js';
-import { moveElementBefore } from './utils/moveElementBefore.js';
+import { isRspackCompiler, moveElementBefore } from '../helpers/index.js';
 
 export interface NativeEntryPluginConfig {
   /**
diff --git a/packages/repack/src/plugins/SourceMapPlugin.ts b/packages/repack/src/plugins/SourceMapPlugin.ts
@@ -4,7 +4,7 @@ import type {
   SourceMapDevToolPluginOptions,
 } from '@rspack/core';
 import type { Compiler as WebpackCompiler } from 'webpack';
-import { ConfigurationError } from './utils/ConfigurationError.js';
+import { ConfigurationError } from '../helpers/index.js';
 
 type ModuleFilenameTemplate =
   SourceMapDevToolPluginOptions['moduleFilenameTemplate'];
diff --git a/packages/repack/src/plugins/utils/ConfigurationError.ts b/packages/repack/src/plugins/utils/ConfigurationError.ts
diff --git a/packages/repack/src/plugins/utils/isRspackCompiler.ts b/packages/repack/src/plugins/utils/isRspackCompiler.ts
