Highlights 💡

New JavaScript API

This release introduces a new, comprehensive JavaScript API for Rslib.

See the API docs for details:

• Rslib core methods
• Rslib instance
• Rslib types

Usage

1. Install Rslib: install the @rslib/core package:

npm add @rslib/core -D

2. Create an Rslib instance: call the createRslib method to create an Rslib instance:

import { createRslib } from '@rslib/core';

const rslib = await createRslib();

3. Call Rslib instance methods: use the rslib.build method which will build production outputs:

await rslib.build();

Summary

• Provide a comprehensive JavaScript API

  Type:

   type RslibInstance = {
       build(options?: BuildOptions): Promise<BuildResult>;
       inspectConfig(options?: InspectConfigOptions): Promise<InspectConfigResult>;
       startMFDevServer(options?: StartMFDevServerOptions): Promise<StartServerResult>;
       getRslibConfig(): Readonly<RslibConfig>;
       onAfterCreateRsbuild(callback: OnAfterCreateRsbuildFn): void;
   };
   
   function createRslib(options?: CreateRslibOptions): Promise<RslibInstance>;

  Example:

   const rslib = await createRslib({
     config: {
       // Rslib configuration
     },
   });
  
   await rslib.build();

• Refactor public API

  Core methods:

  • runCLI
  • createRslib
  • defineConfig
  • loadConfig
  • loadEnv
  • mergeRslibConfig

• Verbose Rslib/Rsbuild/Rspack configurations when running with DEBUG=rslib

• Add --no-env cli options to control disable loading of .env files after refactor

Related Links

close: #1040
close: #967

Checklist

• PR Description
• Tests updated (or not required).
• JS Doc
• Documentation updated (or not required).
• Breaking changes and release notes