docs: add basic description and JSDoc for lib options (#372)

Author: chenjiahan

packages/core/src/types/config/index.ts

@@ -72,18 +72,78 @@ export type Redirect = {
 };
 
 export interface LibConfig extends RsbuildConfig {
+  /**
+   * Whether to bundle the library.
+   * @default true
+   */
   bundle?: boolean;
+  /**
+   * Output format for the generated JavaScript files.
+   * @default undefined
+   */
   format?: Format;
+  /**
+   * Whether to automatically set the file extension based on the `format` option in the JS and DTS output files.
+   * @default true
+   */
   autoExtension?: boolean;
+  /**
+   * Whether to automatically externalize dependencies and do not bundle them.
+   * @default true
+   */
   autoExternal?: AutoExternal;
+  /**
+   * Configure the redirect of the import paths.
+   * @default {}
+   */
   redirect?: Redirect;
-  /** Support esX and browserslist query */
+  /**
+   * Support esX and browserslist query
+   * @default 'esnext'
+   */
   syntax?: Syntax;
+  /**
+   * Whether to import SWC helper functions from `@swc/helpers` instead of inlining them.
+   * @default false
+   */
   externalHelpers?: boolean;
+  /**
+   * Inject content into the top of each JS, CSS or DTS file.
+   * @default {}
+   */
   banner?: BannerAndFooter;
+  /**
+   * Inject content into the bottom of each JS, CSS or DTS file.
+   * @default {}
+   */
   footer?: BannerAndFooter;
+  /**
+   * Configure the shims for CommonJS and ESM output.
+   *
+   * @default
+   * ```js
+   * const defaultShims = {
+   *   cjs: {
+   *     'import.meta.url': true,
+   *   },
+   *   esm: {
+   *     __filename: false,
+   *     __dirname: false,
+   *     require: false,
+   *   },
+   * };
+   * ```
+   */
   shims?: Shims;
+  /**
+   * Configure the generation of the TypeScript declaration files.
+   * @default false
+   */
   dts?: Dts;
+  /**
+   * The export name of the UMD bundle.
+   * @default undefined
+   */
   umdName?: string;
 }
 

website/docs/en/config/lib/auto-extension.mdx

@@ -2,3 +2,5 @@
 
 - **Type:** `boolean`
 - **Default:** `true`
+
+Whether to automatically set the file extension based on the `format` option in the JS and DTS output files.

website/docs/en/config/lib/auto-external.mdx

@@ -2,3 +2,5 @@
 
 - **Type:** `boolean`
 - **Default:** `true`
+
+Whether to automatically externalize dependencies and do not bundle them.

website/docs/en/config/lib/banner.mdx

@@ -11,3 +11,5 @@ type Banner = {
 ```
 
 - **Default:** `{}`
+
+Inject content into the top of each JS, CSS or DTS file.

website/docs/en/config/lib/bundle.mdx

@@ -2,3 +2,5 @@
 
 - **Type:** `boolean`
 - **Default:** `true`
+
+Whether to bundle the library.

website/docs/en/config/lib/dts.mdx

@@ -15,3 +15,5 @@ type Dts =
 ```
 
 - **Default:** `undefined`
+
+Configure the generation of the TypeScript declaration files.

website/docs/en/config/lib/external-helpers.mdx

@@ -2,3 +2,5 @@
 
 - **Type:** `boolean`
 - **Default:** `false`
+
+Whether to import SWC helper functions from `@swc/helpers` instead of inlining them.

website/docs/en/config/lib/footer.mdx

@@ -11,3 +11,5 @@ type Footer = {
 ```
 
 - **Default:** `{}`
+
+Inject content into the bottom of each JS, CSS or DTS file.

website/docs/en/config/lib/format.mdx

@@ -2,3 +2,5 @@
 
 - **Type:** `string`
 - **Default:** `undefined`
+
+Output format for the generated JavaScript files.

website/docs/en/config/lib/redirect.mdx

@@ -9,3 +9,5 @@ type Redirect = {
 ```
 
 - **Default:** `{}`
+
+Configure the redirect of the import paths.