feat: add --root cli option and make basic js api work (#453)

Author: Timeless0911

packages/core/src/build.ts renamed to packages/core/src/cli/build.ts

@@ -1,21 +1,21 @@
 import { type RsbuildInstance, createRsbuild } from '@rsbuild/core';
-import type { BuildOptions } from './cli/commands';
-import { composeRsbuildEnvironments, pruneEnvironments } from './config';
-import type { RslibConfig } from './types/config';
+import { composeRsbuildEnvironments, pruneEnvironments } from '../config';
+import type { RslibConfig } from '../types/config';
+import type { BuildOptions } from './commands';
 
 export async function build(
   config: RslibConfig,
-  options?: BuildOptions,
+  options: Pick<BuildOptions, 'lib' | 'watch'> = {},
 ): Promise<RsbuildInstance> {
   const environments = await composeRsbuildEnvironments(config);
   const rsbuildInstance = await createRsbuild({
     rsbuildConfig: {
-      environments: pruneEnvironments(environments, options?.lib),
+      environments: pruneEnvironments(environments, options.lib),
     },
   });
 
   await rsbuildInstance.build({
-    watch: options?.watch,
+    watch: options.watch,
   });
 
   return rsbuildInstance;

packages/core/src/cli/commands.ts

@@ -1,15 +1,13 @@
-import { type RsbuildMode, createRsbuild } from '@rsbuild/core';
+import type { RsbuildMode } from '@rsbuild/core';
 import { type Command, program } from 'commander';
-import { build } from '../build';
-import {
-  composeRsbuildEnvironments,
-  loadConfig,
-  pruneEnvironments,
-} from '../config';
-import { startMFDevServer } from '../mf';
 import { logger } from '../utils/logger';
+import { build } from './build';
+import { loadRslibConfig } from './init';
+import { inspect } from './inspect';
+import { startMFDevServer } from './mf';
 
 export type CommonOptions = {
+  root?: string;
   config?: string;
   envMode?: string;
   lib?: string[];
@@ -20,8 +18,8 @@ export type BuildOptions = CommonOptions & {
 };
 
 export type InspectOptions = CommonOptions & {
-  mode: RsbuildMode;
-  output: string;
+  mode?: RsbuildMode;
+  output?: string;
   verbose?: boolean;
 };
 
@@ -31,6 +29,10 @@ const applyCommonOptions = (command: Command) => {
       '-c --config <config>',
       'specify the configuration file, can be a relative or absolute path',
     )
+    .option(
+      '-r --root <root>',
+      'specify the project root directory, can be an absolute path or a path relative to cwd',
+    )
     .option(
       '--env-mode <mode>',
       'specify the env mode to load the `.env.[mode]` file',
@@ -60,11 +62,11 @@ export function runCli(): void {
     .description('build the library for production')
     .action(async (options: BuildOptions) => {
       try {
-        const rslibConfig = await loadConfig({
-          path: options.config,
-          envMode: options.envMode,
+        const rslibConfig = await loadRslibConfig(options);
+        await build(rslibConfig, {
+          lib: options.lib,
+          watch: options.watch,
         });
-        await build(rslibConfig, options);
       } catch (err) {
         logger.error('Failed to build.');
         logger.error(err);
@@ -88,21 +90,12 @@ export function runCli(): void {
     .action(async (options: InspectOptions) => {
       try {
         // TODO: inspect should output Rslib's config
-        const rslibConfig = await loadConfig({
-          path: options.config,
-          envMode: options.envMode,
-        });
-        const environments = await composeRsbuildEnvironments(rslibConfig);
-        const rsbuildInstance = await createRsbuild({
-          rsbuildConfig: {
-            environments: pruneEnvironments(environments, options.lib),
-          },
-        });
-        await rsbuildInstance.inspectConfig({
+        const rslibConfig = await loadRslibConfig(options);
+        await inspect(rslibConfig, {
+          lib: options.lib,
           mode: options.mode,
+          output: options.output,
           verbose: options.verbose,
-          outputPath: options.output,
-          writeToDisk: true,
         });
       } catch (err) {
         logger.error('Failed to inspect config.');
@@ -115,10 +108,8 @@ export function runCli(): void {
     .description('start Rsbuild dev server of Module Federation format')
     .action(async (options: CommonOptions) => {
       try {
-        const rslibConfig = await loadConfig({
-          path: options.config,
-          envMode: options.envMode,
-        });
+        const rslibConfig = await loadRslibConfig(options);
+        // TODO: support lib option in mf dev server
         await startMFDevServer(rslibConfig);
       } catch (err) {
         logger.error('Failed to start mf dev.');

packages/core/src/cli/init.ts

@@ -0,0 +1,19 @@
+import { loadConfig } from '../config';
+import type { RslibConfig } from '../types';
+import { getAbsolutePath } from '../utils/helper';
+import type { CommonOptions } from './commands';
+
+export async function loadRslibConfig(
+  options: CommonOptions,
+): Promise<RslibConfig> {
+  const cwd = process.cwd();
+  const root = options.root ? getAbsolutePath(cwd, options.root) : cwd;
+
+  const rslibConfig = await loadConfig({
+    cwd: root,
+    path: options.config,
+    envMode: options.envMode,
+  });
+
+  return rslibConfig;
+}

packages/core/src/cli/inspect.ts

@@ -0,0 +1,25 @@
+import { type RsbuildInstance, createRsbuild } from '@rsbuild/core';
+import { composeRsbuildEnvironments, pruneEnvironments } from '../config';
+import type { RslibConfig } from '../types/config';
+import type { InspectOptions } from './commands';
+
+export async function inspect(
+  config: RslibConfig,
+  options: Pick<InspectOptions, 'lib' | 'mode' | 'output' | 'verbose'> = {},
+): Promise<RsbuildInstance> {
+  const environments = await composeRsbuildEnvironments(config);
+  const rsbuildInstance = await createRsbuild({
+    rsbuildConfig: {
+      environments: pruneEnvironments(environments, options.lib),
+    },
+  });
+
+  await rsbuildInstance.inspectConfig({
+    mode: options.mode,
+    verbose: options.verbose,
+    outputPath: options.output,
+    writeToDisk: true,
+  });
+
+  return rsbuildInstance;
+}

packages/core/src/mf.ts renamed to packages/core/src/cli/mf.ts

@@ -1,8 +1,7 @@
 import { createRsbuild, mergeRsbuildConfig } from '@rsbuild/core';
-import { composeCreateRsbuildConfig } from './config';
-
 import type { RsbuildConfig, RsbuildInstance } from '@rsbuild/core';
-import type { RslibConfig } from './types';
+import { composeCreateRsbuildConfig } from '../config';
+import type { RslibConfig } from '../types';
 
 export async function startMFDevServer(
   config: RslibConfig,

packages/core/src/config.ts

@@ -53,6 +53,7 @@ import {
   calcLongestCommonPath,
   checkMFPlugin,
   color,
+  getAbsolutePath,
   isEmptyObject,
   isObject,
   nodeBuiltInModules,
@@ -1084,9 +1085,13 @@ const composeExternalHelpersConfig = (
   return defaultConfig;
 };
 
-async function composeLibRsbuildConfig(config: LibConfig, configPath: string) {
+async function composeLibRsbuildConfig(config: LibConfig) {
   checkMFPlugin(config);
-  const rootPath = dirname(configPath);
+
+  // Get the absolute path of the root directory to align with Rsbuild's default behavior
+  const rootPath = config.root
+    ? getAbsolutePath(process.cwd(), config.root)
+    : process.cwd();
   const pkgJson = readPackageJson(rootPath);
   const { compilerOptions } = await loadTsconfig(
     rootPath,
@@ -1148,7 +1153,7 @@ async function composeLibRsbuildConfig(config: LibConfig, configPath: string) {
   const { entryConfig, lcp } = await composeEntryConfig(
     config.source?.entry,
     config.bundle,
-    dirname(configPath),
+    rootPath,
     cssModulesAuto,
   );
   const cssConfig = composeCssConfig(lcp, config.bundle);
@@ -1192,10 +1197,8 @@ async function composeLibRsbuildConfig(config: LibConfig, configPath: string) {
 
 export async function composeCreateRsbuildConfig(
   rslibConfig: RslibConfig,
-  path?: string,
 ): Promise<RsbuildConfigWithLibInfo[]> {
   const constantRsbuildConfig = await createConstantRsbuildConfig();
-  const configPath = path ?? rslibConfig._privateMeta?.configFilePath!;
   const { lib: libConfigsArray, ...sharedRsbuildConfig } = rslibConfig;
 
   if (!libConfigsArray) {
@@ -1212,10 +1215,7 @@ export async function composeCreateRsbuildConfig(
 
     // Merge the configuration of each environment based on the shared Rsbuild
     // configuration and Lib configuration in the settings.
-    const libRsbuildConfig = await composeLibRsbuildConfig(
-      userConfig,
-      configPath,
-    );
+    const libRsbuildConfig = await composeLibRsbuildConfig(userConfig);
 
     // Reset certain fields because they will be completely overridden by the upcoming merge.
     // We don't want to retain them in the final configuration.
@@ -1271,12 +1271,9 @@ export async function composeCreateRsbuildConfig(
 
 export async function composeRsbuildEnvironments(
   rslibConfig: RslibConfig,
-  path?: string,
 ): Promise<Record<string, EnvironmentConfig>> {
-  const rsbuildConfigWithLibInfo = await composeCreateRsbuildConfig(
-    rslibConfig,
-    path,
-  );
+  const rsbuildConfigWithLibInfo =
+    await composeCreateRsbuildConfig(rslibConfig);
 
   // User provided ids should take precedence over generated ids.
   const usedIds = rsbuildConfigWithLibInfo

packages/core/src/index.ts

@@ -1,11 +1,13 @@
 export { prepareCli } from './cli/prepare';
 export { runCli } from './cli/commands';
+export { build } from './cli/build';
+export { inspect } from './cli/inspect';
+export { startMFDevServer } from './cli/mf';
 export {
   defineConfig,
   loadConfig,
   composeCreateRsbuildConfig as unstable_composeCreateRsbuildConfig,
 } from './config';
-export { build } from './build';
 export { logger } from './utils/logger';
 export type * from './types';
 

packages/core/src/utils/helper.ts

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import fsP from 'node:fs/promises';
-import path from 'node:path';
+import path, { isAbsolute, join } from 'node:path';
 import type { RsbuildPlugins } from '@rsbuild/core';
 import color from 'picocolors';
 
@@ -109,6 +109,10 @@ export async function calcLongestCommonPath(
   return lca;
 }
 
+export function getAbsolutePath(base: string, filepath: string): string {
+  return isAbsolute(filepath) ? filepath : join(base, filepath);
+}
+
 export const readPackageJson = (rootPath: string): undefined | PkgJson => {
   const pkgJsonPath = path.join(rootPath, './package.json');
 

packages/core/tests/__snapshots__/config.test.ts.snap

@@ -72,7 +72,7 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config 1
           "pnpapi",
         ],
         "filename": {
-          "js": "[name].js",
+          "js": "[name].mjs",
         },
         "filenameHash": false,
         "minify": {