# Rslib

> Rslib is a library development tool that leverages the well-designed configurations and plugins of Rsbuild.

## 指南

- [介绍](/zh/guide/start/index.md): Rslib 入门指南，介绍核心特性、Rstack 工具链、社区资源与在线示例。
- [快速上手](/zh/guide/start/quick-start.md): 完成运行时准备，使用 create-rslib 创建项目，选择模板、工具与技能，并快速开始使用 Rslib。
- [名词解释](/zh/guide/start/glossary.md): 查看 Rslib 常用术语，了解 bundleless、externals、shims、输出格式等库构建核心概念。
- [NPM 包](/zh/guide/start/npm-packages.md): 浏览 Rslib 官方 npm 包，包括 @rslib/core、create-rslib 以及团队维护的相关插件与工具。
- [AI](/zh/guide/start/ai.md): 通过 Agent Skills、llms.txt、Markdown 文档与 AGENTS.md，帮助 AI 更准确地理解并使用 Rslib。
- [总览](/zh/guide/solution/index.md): 查看 Rslib 的方案实践，了解如何构建浏览器库、Node.js 包与跨框架组件库等常见项目方案。
- [Node.js](/zh/guide/solution/nodejs.md): 使用 Rslib 构建 Node.js 库，涵盖运行时目标、ESM 或 CJS 输出、包配置与发布场景。
- [React](/zh/guide/solution/react.md): 使用 Rslib 构建 React 组件库，涵盖 JSX 支持、样式处理、资源导入与常用工具链集成。
- [ReactLynx](/zh/guide/solution/reactlynx.md): 使用 Rslib 构建和发布保留 JSX 的 ReactLynx 组件库，配置类型声明与组件测试，并在 Lynx 应用或其他组件库中使用。
- [Vue](/zh/guide/solution/vue.md): 使用 Rslib 构建 Vue 组件库，涵盖 SFC 支持、样式处理、资源导入、产物输出与工程实践。
- [Svelte](/zh/guide/solution/svelte.md): 使用 Rslib 构建 Svelte 组件库，涵盖编译后 ESM 产物与类型声明生成。
- [Solid](/zh/guide/solution/solid.md): 使用 Rslib 构建 Solid 组件库，涵盖编译输出与源码 JSX 输出、"solid" condition name 与类型声明生成。
- [命令行工具](/zh/guide/basic/cli.md): 使用 Rslib CLI 进行 build、inspect、watch、配置文件选择与常用命令行操作。
- [配置 Rslib](/zh/guide/basic/configure-rslib.md): 配置 Rslib，了解 lib 配置、Rsbuild 配置、顶层配置、配置文件与 defineConfig 的使用方式。
- [使用 TypeScript](/zh/guide/basic/typescript.md): 在 Rslib 中使用 TypeScript，涵盖 .ts、.tsx 支持、tsconfig 配置与声明文件输出。
- [产物输出格式](/zh/guide/basic/output-format.md): 为库构建选择 Rslib 输出格式，包括 ESM、CJS、UMD、Module Federation 与 IIFE。
- [产物结构](/zh/guide/basic/output-structure.md): 了解 Rslib 产物结构，包括 bundle 与 bundleless 模式、dist 布局与生成文件。
- [处理三方依赖](/zh/guide/advanced/third-party-deps.md): 在 Rslib 的 bundle 模式下处理三方依赖，涵盖 externals、autoExternal 与相关打包策略。
- [产物兼容性](/zh/guide/advanced/output-compatibility.md): 通过语法目标、浏览器、Node.js 版本与平台配置，控制 Rslib 产物的兼容性范围与目标环境。
- [环境变量](/zh/guide/advanced/env-vars.md): Rslib 环境变量指南：不同产物格式的默认行为、.env 文件加载、PUBLIC_ 变量与 source.define 构建时替换。
- [类型生成](/zh/guide/advanced/dts.md): 在 Rslib 中选择类型生成方式，使用 TypeScript Compiler API、tsgo、isolatedDeclarations 与 API Extractor 生成和打包类型声明文件。
- [CSS](/zh/guide/advanced/css.md): 在 Rslib 中处理 CSS，涵盖 CSS Modules、预处理器、PostCSS、Lightning CSS 与输出配置。
- [静态资源](/zh/guide/advanced/static-assets.md): Rslib 支持在代码中引用图片、字体、媒体和其他类型文件等静态资源。
- [SVGR](/zh/guide/advanced/svgr-files.md): 在 Rslib 中通过 SVGR 导入 SVG 文件，并在 React 组件与静态资源处理之间做选择。
- [JSON](/zh/guide/advanced/json-files.md): 在 Rslib 中导入 JSON、YAML 与 TOML，了解类型化数据访问、模块导入与相关配置方式。
- [Wasm](/zh/guide/advanced/wasm.md): 在 Rslib 库中导入 WebAssembly 模块，配置 compile 或 preserve 输出模式，或通过 ?inline query 将二进制内联到 JavaScript 中。
- [Web Workers](/zh/guide/advanced/web-workers.md): 本文将介绍在 Rslib 项目中如何配置和使用 Web Workers。
- [模块联邦](/zh/guide/advanced/module-federation.md): 使用 Rslib 构建 Module Federation 库，涵盖配置方式、本地开发服务与模块联邦调试流程。
- [使用 Rspress](/zh/guide/advanced/rspress.md): 在 Rslib 项目中使用 Rspress，构建组件文档、示例演示、API 页面与完整文档站点体验。
- [使用 Storybook](/zh/guide/advanced/storybook.md): 在 Rslib 项目中使用 Storybook，支持组件隔离开发、预览调试、示例展示与文档工作流整合。
- [使用 Rstest](/zh/guide/advanced/rstest.md): 在 Rslib 项目中使用 Rstest，涵盖单元测试、组件测试、调试能力与生态一致的测试工作流实践。
- [使用 Rsdoctor](/zh/guide/advanced/rsdoctor.md): 使用 Rsdoctor 分析 Rslib 构建结果，检查产物体积、依赖关系、构建瓶颈与性能问题定位。
- [版本管理与发布](/zh/guide/advanced/release-management.md): 介绍 Rslib 项目的 npm 包版本管理与发布实践，包括发布准备、版本管理、构建验证、npm 发布和 GitHub Actions 集成。
- [升级 Rslib](/zh/guide/upgrade/upgrade-rslib.md): 了解如何升级 Rslib 依赖、查看版本变更，并同步更新相关包。
- [从 0.x 升级到 v1](/zh/guide/upgrade/v0-to-v1.md): 当前文档列出了从 Rslib 0.23 到 1.0 的所有不兼容更新，你可以参考此文档来迁移。
- [tsup](/zh/guide/migration/tsup.md): 从 tsup 迁移到 Rslib，了解等价配置项、插件选择、产物行为变化与常见迁移改造完整步骤说明。
- [tsc](/zh/guide/migration/tsc.md): 从 TypeScript Compiler 迁移到 Rslib，了解配置映射、声明文件处理与产物行为变化。
- [功能类问题](/zh/guide/faq/features.md): 查看 Rslib 功能 FAQ，了解 bundleless 样式处理、静态资源、代码压缩与声明文件生成等常见问题。

## 配置

- [配置总览](/zh/config/index.md): 查看 Rslib 配置总览，了解 lib 选项、继承的 Rsbuild 配置，以及所有参考页面的导航入口。
- [默认行为](/zh/config/default-behavior.md): Rslib 的默认行为、设置原因与调整方式，涵盖环境变量、依赖处理、语法兼容、构建优化、产物输出、静态资源、CSS 和类型声明。
- [总览](/zh/config/lib/index.md): 查看 Rslib 的 lib 配置，了解每份库产物可用的 lib 配置和 Rsbuild 配置，以及顶层与非顶层 lib 配置项。
- [lib.autoExtension](/zh/config/lib/auto-extension.md): 配置 lib.autoExtension，根据所选库格式与输出模式自动推导输出文件扩展名和命名规则。
- [lib.autoExternal](/zh/config/lib/auto-external.md): 配置 lib.autoExternal，在 bundle 模式构建库时自动将依赖标记为 externals。
- [lib.banner](/zh/config/lib/banner.md): 配置 lib.banner，在 JavaScript、CSS 与声明文件产物顶部注入版权声明、注释或其他内容。
- [lib.bundle](/zh/config/lib/bundle.md): 配置 lib.bundle，选择 bundle 或 bundleless 模式，并为不同产物设置合适的入口策略。
- [lib.dts](/zh/config/lib/dts.md): 配置 lib.dts，选择类型生成方式、打包类型文件，并自定义 Rslib 构建中的类型声明输出行为。
- [lib.experiments](/zh/config/lib/experiments.md): 配置 lib.experiments，启用实验性特性并提前试用 Rslib 中的新构建能力与演进功能。
- [lib.externalHelpers](/zh/config/lib/external-helpers.md): 配置 lib.externalHelpers，从 @swc/helpers 引入 SWC 辅助函数，而不是在产物中直接内联。
- [lib.footer](/zh/config/lib/footer.md): 配置 lib.footer，在 JavaScript、CSS 和声明文件产物底部注入版权声明、注释或其他自定义内容。
- [lib.format](/zh/config/lib/format.md): 配置 lib.format，选择 Rslib 的输出格式，包括 ESM、CJS、UMD、Module Federation 与 IIFE。
- [lib.id](/zh/config/lib/id.md): 配置 lib.id，为不同库产物指定 ID，便于在 CLI 和 JavaScript API 中按需构建。
- [lib.outBase](/zh/config/lib/out-base.md): 配置 lib.outBase，控制 bundleless 产物中源码目录结构的保留方式、层级与输出目录组织。
- [lib.redirect](/zh/config/lib/redirect.md): 配置 lib.redirect，在 bundleless 模式下重写 JavaScript、样式与静态资源的导入路径。
- [lib.shims](/zh/config/lib/shims.md): 配置 lib.shims，为特定库产物目标启用 CommonJS 与 ESM 所需的 shims 及兼容处理。
- [lib.syntax](/zh/config/lib/syntax.md): 配置 lib.syntax，为生成的库产物设置 JavaScript 语法目标、兼容范围与输出级别。
- [lib.umdName](/zh/config/lib/umd-name.md): 配置 lib.umdName，设置 UMD 库产物在运行时使用的全局导出名称、挂载变量与访问方式说明。
- [lib.wasm](/zh/config/lib/wasm.md): 配置 lib.wasm，选择 WASM 模块的输出模式，或禁用对 WASM 模块的处理。
- [总览](/zh/config/rsbuild/index.md): 查看 Rslib 中的常用 Rsbuild 配置，了解日志、模块解析、源码处理、产物输出、性能和插件等构建选项。
- [logLevel](/zh/config/rsbuild/log-level.md): 配置 Rslib 的 logLevel，在开发、调试与生产构建中控制 CLI 和构建日志的详细程度与输出噪声。
- [resolve](/zh/config/rsbuild/resolve.md): 配置 Rslib 中的 Rsbuild resolve 选项，包括别名、扩展名、包解析、条件导出与模块查找规则。
- [source](/zh/config/rsbuild/source.md): 配置 Rslib 中的 Rsbuild source 选项，包括入口、全局常量、装饰器、别名与源码转换配置。
- [output](/zh/config/rsbuild/output.md): 配置 Rslib 中的 Rsbuild output 选项，包括资源前缀、输出目录、externals、文件名与 CSS 输出。
- [tools](/zh/config/rsbuild/tools.md): 配置 Rslib 中的 Rsbuild tools，自定义底层打包器、CSS、HTML 与开发工具的行为细节。
- [performance](/zh/config/rsbuild/performance.md): 配置 Rslib 中的 Rsbuild performance 选项，包括缓存、拆包、预加载与相关构建优化能力。
- [plugins](/zh/config/rsbuild/plugins.md): 配置 Rslib 中的 Rsbuild plugins，注册插件、扩展构建行为，并通过插件方式接入更多生态能力。

## API

- [JavaScript API](/zh/api/start/index.md): 通过 createRslib 和实例方法在 Node.js、Deno、Bun 中上手 Rslib JavaScript API 与基础用法。
- [Rslib core](/zh/api/javascript-api/core.md): 使用 Rslib 核心 API，包括 createRslib、loadConfig、defineConfig 与环境变量加载等 JavaScript 工作流能力。
- [Rslib instance](/zh/api/javascript-api/instance.md): 使用 Rslib 实例 API 进行构建、Module Federation 开发服务、配置检查与生命周期控制。
- [Rslib types](/zh/api/javascript-api/types.md): 查看 Rslib 导出的 TypeScript 类型，涵盖配置、API、实例方法、插件接口以及 Rsbuild、Rspack 类型。

## 博客

- [Rslib 博客](/zh/blog/index.md): 汇总了与 Rslib 相关的博客文章
- [Rspack 生态升级！全新库开发工具 Rslib 发布](/zh/blog/introducing-rslib.md): Rslib 正式发布，帮助开发者以简单直观的方式创建 JavaScript 库和 UI 组件库。
- [Rslib 1.0 正式发布](/zh/blog/v1-0.md): Rslib 1.0 正式发布，围绕面向不同场景的库构建能力和开发者体验展开，并介绍升级指南与后续规划。