refactor(config): move CLI path fallback to callers (#601)

Author: chenjiahan

packages/rstack/src/cli/commands.ts

@@ -1,6 +1,6 @@
 import { join, resolve } from 'node:path';
 import { pathToFileURL } from 'node:url';
-import { CLI_CONFIG_PATH_ENV, getConfigState } from '../config.ts';
+import { CLI_CONFIG_PATH_ENV, getConfigState } from './config.ts';
 import { insertConfigArg, parseArgs, parseCliArgs } from './args.ts';
 import { hasHelpFlag, printCommandHelp } from './help.ts';
 

packages/rstack/src/cli/config.ts

@@ -0,0 +1,35 @@
+import {
+  loadRstackConfig,
+  type LoadedRstackConfig,
+  type LoadRstackConfigOptions,
+} from '../config.ts';
+
+type ConfigState = {
+  /**
+   * Absolute config path from the global `--config` flag, resolved at parse
+   * time so a later cwd (such as an LSP workspace root) cannot change it.
+   */
+  configPath?: string;
+};
+
+declare global {
+  // rslint-disable-next-line no-var
+  var __rstackCliState: ConfigState | undefined;
+}
+
+export const getConfigState = (): ConfigState => {
+  // The CLI and internal tool configs may be loaded as separate module instances.
+  return (globalThis.__rstackCliState ??= {});
+};
+
+/** Passes `--config` to Rslint's JS plugin workers, which run in a fresh realm. */
+export const CLI_CONFIG_PATH_ENV = 'RSTACK_CLI_CONFIG_PATH';
+
+/** Loads a root tool config using the CLI path unless explicitly overridden. */
+export const loadCliRstackConfig = (
+  options: LoadRstackConfigOptions = {},
+): Promise<LoadedRstackConfig> =>
+  loadRstackConfig({
+    ...options,
+    configFilePath: options.configFilePath ?? getConfigState().configPath,
+  });

packages/rstack/src/config.ts

@@ -84,11 +84,9 @@ export type LoadRstackConfigOptions = {
   /**
    * The path to the Rstack config file, can be a relative or absolute path.
    * A relative path is resolved from `cwd`.
-   * If `configFilePath` is omitted, the config path set by the CLI is used.
-   * If neither path is provided, the function will search for the config file in `cwd`.
-   * Pass `null` to search `cwd` and ignore the CLI config path.
+   * If omitted, the function searches for the config file in `cwd`.
    */
-  configFilePath?: string | null;
+  configFilePath?: string;
   /**
    * The directory the config file is searched in and relative config paths are resolved from.
    * Defaults to the current working directory.
@@ -102,21 +100,10 @@ type ConfigSession = {
   active: boolean;
 };
 
-type ConfigState = {
-  /**
-   * Config file path from the global `--config` flag. Always absolute: the CLI
-   * resolves it at parse time so it stays independent of later cwd choices
-   * (`loadRstackConfig` may be called with an LSP workspace root as `cwd`).
-   */
-  configPath?: string;
-};
-
 declare global {
   // rslint-disable-next-line no-var
   var __rstackConfigSessionStorage:
     AsyncLocalStorage<ConfigSession> | undefined;
-  // rslint-disable-next-line no-var
-  var __rstackCliState: ConfigState | undefined;
 }
 
 const getConfigSessionStorage = (): AsyncLocalStorage<ConfigSession> => {
@@ -131,23 +118,6 @@ const getConfigSessionStorage = (): AsyncLocalStorage<ConfigSession> => {
   return globalThis.__rstackConfigSessionStorage;
 };
 
-export const getConfigState = (): ConfigState => {
-  // The CLI and its internal tool config can also be loaded as separate module
-  // instances. Keep only the CLI config path in its own global state.
-  if (!globalThis.__rstackCliState) {
-    globalThis.__rstackCliState = {};
-  }
-
-  return globalThis.__rstackCliState;
-};
-
-/**
- * Passes the `--config` path to Rslint's JS plugin workers, which import the
- * internal lint config in a fresh realm without the CLI state above. Only that
- * config reads it.
- */
-export const CLI_CONFIG_PATH_ENV = 'RSTACK_CLI_CONFIG_PATH';
-
 type Define = {
   /**
    * Inherits shared configs from left to right, followed by the project's own
@@ -269,9 +239,6 @@ export const loadRstackConfig = async ({
   configFilePath,
   cwd,
 }: LoadRstackConfigOptions = {}): Promise<LoadedRstackConfig> => {
-  const state = getConfigState();
-  const configPath =
-    configFilePath === null ? undefined : (configFilePath ?? state.configPath);
   const session: ConfigSession = {
     configs: {},
     active: true,
@@ -284,8 +251,8 @@ export const loadRstackConfig = async ({
         exportName: false,
         fresh: true,
         cwd,
-        ...(configPath !== undefined
-          ? { path: configPath }
+        ...(configFilePath !== undefined
+          ? { path: configFilePath }
           : {
               configFileNames: [
                 'rstack.config.ts',

packages/rstack/src/fmt/cli.ts

@@ -3,7 +3,8 @@ import { performance } from 'node:perf_hooks';
 import { color, logger } from 'rslog';
 import { parseArgs } from '../cli/args.ts';
 import { printCommandHelp } from '../cli/help.ts';
-import { loadRstackConfig, type LoadedRstackConfig } from '../config.ts';
+import type { LoadedRstackConfig } from '../config.ts';
+import { loadCliRstackConfig } from '../cli/config.ts';
 import { ensureProjectCacheDir } from '../projectCache.ts';
 import { fmtCacheFileName } from './cacheStore.ts';
 import { resolveFmtConfig } from './config.ts';
@@ -250,7 +251,7 @@ const loadFmtConfig = async (
   loadedConfig?: LoadedRstackConfig,
 ): Promise<ResolvedFmtConfig> => {
   const { configs, filePath } =
-    loadedConfig ?? (await loadRstackConfig({ cwd }));
+    loadedConfig ?? (await loadCliRstackConfig({ cwd }));
 
   return resolveFmtConfig({
     layers: [configs],

packages/rstack/src/rsbuildConfig.ts

@@ -5,7 +5,8 @@ import {
   mergeRsbuildConfig,
 } from '@rsbuild/core';
 import { withConfigMeta } from '@rstackjs/load-config';
-import { loadRstackConfig, type RstackConfigDefinitions } from './config.ts';
+import type { RstackConfigDefinitions } from './config.ts';
+import { loadCliRstackConfig } from './cli/config.ts';
 import { resolveConfigLayers } from './configLayers.ts';
 
 export const resolveRsbuildConfig = async (
@@ -19,7 +20,7 @@ export const resolveRsbuildConfig = async (
 };
 
 const loadRsbuildConfig: RsbuildConfigDefinition = async (params) => {
-  const { configs, filePath, dependencies } = await loadRstackConfig();
+  const { configs, filePath, dependencies } = await loadCliRstackConfig();
   const config = await resolveRsbuildConfig([configs], params);
 
   return withConfigMeta(config, { filePath, dependencies });

packages/rstack/src/rslibConfig.ts

@@ -5,7 +5,8 @@ import {
   mergeRslibConfig,
 } from '@rslib/core';
 import { withConfigMeta } from '@rstackjs/load-config';
-import { loadRstackConfig, type RstackConfigDefinitions } from './config.ts';
+import type { RstackConfigDefinitions } from './config.ts';
+import { loadCliRstackConfig } from './cli/config.ts';
 import { resolveConfigLayers } from './configLayers.ts';
 
 export const resolveRslibConfig = async (
@@ -17,7 +18,7 @@ export const resolveRslibConfig = async (
 };
 
 const loadRslibConfig = (async (params: ConfigParams) => {
-  const { configs, filePath, dependencies } = await loadRstackConfig();
+  const { configs, filePath, dependencies } = await loadCliRstackConfig();
   const config = await resolveRslibConfig([configs], params);
 
   return withConfigMeta(config, { filePath, dependencies });

packages/rstack/src/rslintConfig.ts

@@ -1,18 +1,15 @@
 import { existsSync } from 'node:fs';
 import { join } from 'node:path';
-import {
-  CLI_CONFIG_PATH_ENV,
-  loadRstackConfig,
-  type LoadedRstackConfig,
-} from './config.ts';
+import { CLI_CONFIG_PATH_ENV, loadCliRstackConfig } from './cli/config.ts';
+import type { LoadedRstackConfig } from './config.ts';
 import type { RslintConfig } from '@rslint/core';
 import { color, logger } from 'rslog';
 import { resolveRslintConfig } from './configLayers.ts';
 
 // Expose the loaded config so `rs check` can pass it to fmt instead of loading
 // and executing the Rstack config a second time. Rslint also imports this
 // module in its JS plugin workers, which get `--config` from the environment.
-export const loadedConfig: LoadedRstackConfig = await loadRstackConfig({
+export const loadedConfig: LoadedRstackConfig = await loadCliRstackConfig({
   configFilePath: process.env[CLI_CONFIG_PATH_ENV],
 });
 const { configs } = loadedConfig;

packages/rstack/src/rspressConfig.ts

@@ -1,6 +1,7 @@
 import type { WatchFiles } from '@rsbuild/core';
 import type { UserConfig } from '@rspress/core';
-import { loadRstackConfig, type RstackConfigDefinitions } from './config.ts';
+import type { RstackConfigDefinitions } from './config.ts';
+import { loadCliRstackConfig } from './cli/config.ts';
 import { resolveConfigLayers } from './configLayers.ts';
 
 export const resolveRspressConfig = async (
@@ -16,7 +17,7 @@ export const resolveRspressConfig = async (
 };
 
 export default async (): Promise<UserConfig> => {
-  const { configs, filePath, dependencies } = await loadRstackConfig();
+  const { configs, filePath, dependencies } = await loadCliRstackConfig();
   const config = await resolveRspressConfig([configs]);
 
   if (!filePath) {

packages/rstack/src/rstestConfig.ts

@@ -7,6 +7,7 @@ import {
 } from '@rstest/core';
 import { type LoadProjectConfig, PROJECT_LOADER } from '@rstest/core/api';
 import { loadRstackConfig, type RstackConfigDefinitions } from './config.ts';
+import { loadCliRstackConfig } from './cli/config.ts';
 import { resolveConfigLayers } from './configLayers.ts';
 
 const resolveAutomaticExtends = async (
@@ -120,11 +121,9 @@ export const resolveRstestConfig = async (
 const createProjectLoader =
   (params: ConfigParams): LoadProjectConfig =>
   async ({ dirPath, filePath }) => {
-    // `null` searches the project directory with the default config file names
-    // instead of reusing the `rs --config` path that loads the root config.
     const loaded = await loadRstackConfig({
       cwd: dirPath,
-      configFilePath: filePath ?? null,
+      configFilePath: filePath,
     });
     if (loaded.filePath === null) {
       return null;
@@ -140,7 +139,7 @@ const createProjectLoader =
   };
 
 const loadRstestConfig = (async (params: ConfigParams) => {
-  const { configs } = await loadRstackConfig();
+  const { configs } = await loadCliRstackConfig();
   const config = await resolveRstestConfig([configs], params);
   return {
     ...config,

packages/rstack/src/staged.ts

@@ -1,7 +1,7 @@
 import lintStaged from 'lint-staged';
 import { parseArgs } from './cli/args.ts';
 import { printCommandHelp } from './cli/help.ts';
-import { loadRstackConfig } from './config.ts';
+import { loadCliRstackConfig } from './cli/config.ts';
 import { resolveStagedConfig } from './configLayers.ts';
 
 export type StagedSyncTaskGenerator = (
@@ -51,7 +51,7 @@ export async function runStagedCLI(args: string[]): Promise<void> {
     return;
   }
 
-  const { configs } = await loadRstackConfig();
+  const { configs } = await loadCliRstackConfig();
   const stagedConfig = await resolveStagedConfig([configs]);
   if (stagedConfig === undefined) {
     throw new Error(