# Rslib

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

## Guide

- [Introduction](https://rslib.rs/guide/start/index.md): Introduction to Rslib, including its core features, the Rstack toolchain, community resources, and online examples.
- [Quick start](https://rslib.rs/guide/start/quick-start.md): Set up a runtime, create a project with create-rslib, choose templates, tools, and skills, and start using Rslib quickly.
- [Glossary](https://rslib.rs/guide/start/glossary.md): Browse key Rslib terms such as bundleless, externals, shims, output formats, and other library build concepts.
- [Packages](https://rslib.rs/guide/start/npm-packages.md): Browse the official Rslib npm packages, including @rslib/core, create-rslib, and related plugins maintained by the team.
- [AI](https://rslib.rs/guide/start/ai.md): Use agent skills, llms.txt, Markdown docs, and AGENTS.md to help AI understand and work with Rslib more effectively.
- [Overview](https://rslib.rs/guide/solution/index.md): Explore Rslib solutions for browser libraries, Node.js packages, and component libraries across frameworks.
- [Node.js](https://rslib.rs/guide/solution/nodejs.md): Build Node.js libraries with Rslib using the right runtime targets, ESM or CJS output, and package setup.
- [React](https://rslib.rs/guide/solution/react.md): Build React component libraries with Rslib using JSX support, style handling, asset imports, and common tooling.
- [ReactLynx](https://rslib.rs/guide/solution/reactlynx.md): Build and publish ReactLynx component libraries with Rslib, preserve JSX, generate types, test components, and use them in Lynx apps or other libraries.
- [Vue](https://rslib.rs/guide/solution/vue.md): Build Vue component libraries with Rslib using SFC support, style handling, asset imports, and package output.
- [Svelte](https://rslib.rs/guide/solution/svelte.md): Build Svelte component libraries with Rslib using compiled ESM output and declaration generation.
- [Solid](https://rslib.rs/guide/solution/solid.md): Build Solid component libraries with Rslib using compiled and source JSX outputs, the "solid" condition name, and declaration generation.
- [CLI](https://rslib.rs/guide/basic/cli.md): Use the Rslib CLI for build, inspect, watch mode, config selection, and common command-line options.
- [Configure Rslib](https://rslib.rs/guide/basic/configure-rslib.md): Configure Rslib with lib configurations, Rsbuild configurations, top-level configuration, config files, and defineConfig.
- [Use TypeScript](https://rslib.rs/guide/basic/typescript.md): Use TypeScript with Rslib, including .ts and .tsx support, tsconfig settings, and declaration output.
- [Output format](https://rslib.rs/guide/basic/output-format.md): Choose Rslib output formats for library builds, including ESM, CJS, UMD, Module Federation, and IIFE.
- [Output structure](https://rslib.rs/guide/basic/output-structure.md): Understand Rslib output structure, including bundle and bundleless mode, dist layout, and generated files.
- [Handle third-party dependencies](https://rslib.rs/guide/advanced/third-party-deps.md): Handle third-party dependencies in Rslib bundle mode with externals, autoExternal, and related packaging strategies.
- [Output compatibility](https://rslib.rs/guide/advanced/output-compatibility.md): Control Rslib output compatibility with syntax targets, browsers, Node.js versions, and platform settings.
- [Environment variables](https://rslib.rs/guide/advanced/env-vars.md): Rslib environment variables across output formats: default behavior, .env loading, PUBLIC_ variables, and source.define replacements.
- [Declaration files](https://rslib.rs/guide/advanced/dts.md): Choose declaration generation methods in Rslib, and use TypeScript Compiler API, native TypeScript, isolatedDeclarations, and API Extractor to generate and bundle declaration files.
- [CSS](https://rslib.rs/guide/advanced/css.md): Use CSS in Rslib with CSS Modules, preprocessors, PostCSS, Lightning CSS, and output configuration.
- [Static assets](https://rslib.rs/guide/advanced/static-assets.md): Rslib supports importing static assets, including images, fonts, media, and other file types.
- [SVGR](https://rslib.rs/guide/advanced/svgr-files.md): Import SVG files with SVGR in Rslib and choose between React components and static asset handling.
- [JSON](https://rslib.rs/guide/advanced/json-files.md): Import JSON, YAML, and TOML in Rslib with typed data access, module imports, and related configuration.
- [Wasm](https://rslib.rs/guide/advanced/wasm.md): Import WebAssembly modules in Rslib libraries, configure compile or preserve output, or inline binaries into JavaScript with the ?inline query.
- [Web Workers](https://rslib.rs/guide/advanced/web-workers.md): This guide explains how to configure and use Web Workers in Rslib projects.
- [Module Federation](https://rslib.rs/guide/advanced/module-federation.md): Build Module Federation libraries with Rslib using the right configuration, local dev server, and debugging flow.
- [Use Rspress](https://rslib.rs/guide/advanced/rspress.md): Use Rspress with Rslib for component documentation, demos, API pages, and documentation site generation.
- [Use Storybook](https://rslib.rs/guide/advanced/storybook.md): Use Storybook with Rslib for isolated component development, preview debugging, examples, and documentation workflows.
- [Use Rstest](https://rslib.rs/guide/advanced/rstest.md): Use Rstest with Rslib for unit tests, component tests, debugging, and ecosystem-aligned testing workflows.
- [Use Rsdoctor](https://rslib.rs/guide/advanced/rsdoctor.md): Enable and configure Rsdoctor in Rslib to analyze build outputs and the build process.
- [Release management](https://rslib.rs/guide/advanced/release-management.md): Learn about npm package version management and release practices for Rslib projects, including release preparation, versioning, build validation, npm publishing, and GitHub Actions integration.
- [Upgrade Rslib](https://rslib.rs/guide/upgrade/upgrade-rslib.md): Learn how to upgrade Rslib dependencies, review release changes, and keep related packages in sync.
- [Upgrading from 0.x to v1](https://rslib.rs/guide/upgrade/v0-to-v1.md): This document lists all breaking changes from Rslib 0.23 to 1.0. You can use it as a migration reference.
- [tsup](https://rslib.rs/guide/migration/tsup.md): Migrate from tsup to Rslib with equivalent config options, plugin choices, and output behavior changes.
- [tsc](https://rslib.rs/guide/migration/tsc.md): Migrate from TypeScript Compiler to Rslib with config mapping, declaration file handling, and output behavior changes.
- [Features FAQ](https://rslib.rs/guide/faq/features.md): Check the Rslib feature FAQ for bundleless style handling, static assets, minification, and declaration file generation.

## Config

- [Config overview](https://rslib.rs/config/index.md): Browse the Rslib configuration overview, including lib options, inherited Rsbuild settings, and links to every reference page.
- [Default behavior](https://rslib.rs/config/default-behavior.md): Rslib defaults, their rationale, and how to configure environment variables, dependencies, syntax, optimization, output, assets, CSS, and type declarations.
- [Overview](https://rslib.rs/config/lib/index.md): Browse Rslib's lib configuration, including the lib and Rsbuild options available to each output and the top-level and non-top-level lib options.
- [lib.autoExtension](https://rslib.rs/config/lib/auto-extension.md): Configure lib.autoExtension to derive output file extensions from the selected library format and output mode.
- [lib.autoExternal](https://rslib.rs/config/lib/auto-external.md): Configure lib.autoExternal to automatically externalize dependencies when building libraries in bundle mode.
- [lib.banner](https://rslib.rs/config/lib/banner.md): Configure lib.banner to inject banner content at the top of JavaScript, CSS, and declaration output files.
- [lib.bundle](https://rslib.rs/config/lib/bundle.md): Configure lib.bundle to choose bundle or bundleless mode and set the right entry strategy for each output.
- [lib.dts](https://rslib.rs/config/lib/dts.md): Configure lib.dts to choose declaration generation methods, bundle declaration files, and customize Rslib type output.
- [lib.experiments](https://rslib.rs/config/lib/experiments.md): Configure lib.experiments to enable experimental features and try new build capabilities in Rslib.
- [lib.externalHelpers](https://rslib.rs/config/lib/external-helpers.md): Configure lib.externalHelpers to import SWC helpers from @swc/helpers instead of inlining them in output.
- [lib.footer](https://rslib.rs/config/lib/footer.md): Configure lib.footer to inject footer content into JavaScript, CSS, and declaration output files.
- [lib.format](https://rslib.rs/config/lib/format.md): Configure lib.format to choose Rslib output formats such as ESM, CJS, UMD, Module Federation, and IIFE.
- [lib.id](https://rslib.rs/config/lib/id.md): Configure lib.id to assign library IDs for selective builds in the CLI and JavaScript API.
- [lib.outBase](https://rslib.rs/config/lib/out-base.md): Configure lib.outBase to control how source directory structure is preserved in bundleless output directories.
- [lib.redirect](https://rslib.rs/config/lib/redirect.md): Configure lib.redirect to rewrite bundleless import paths for JavaScript, styles, and static assets.
- [lib.shims](https://rslib.rs/config/lib/shims.md): Configure lib.shims to enable the CommonJS and ESM shims required by specific library output targets.
- [lib.syntax](https://rslib.rs/config/lib/syntax.md): Configure lib.syntax to set JavaScript syntax targets and compatibility levels for generated library output.
- [lib.umdName](https://rslib.rs/config/lib/umd-name.md): Configure lib.umdName to set the global export name used by UMD library bundles at runtime.
- [lib.wasm](https://rslib.rs/config/lib/wasm.md): Configure lib.wasm to select the output mode for WASM modules, or disable the handling of WASM modules.
- [Overview](https://rslib.rs/config/rsbuild/index.md): Browse common Rsbuild configurations in Rslib, including logging, module resolution, source processing, output, performance, and plugins.
- [logLevel](https://rslib.rs/config/rsbuild/log-level.md): Configure logLevel in Rslib to control CLI and build log verbosity in development, debugging, and production builds.
- [resolve](https://rslib.rs/config/rsbuild/resolve.md): Configure Rsbuild resolve options in Rslib, including aliases, extensions, package resolution, and condition names.
- [source](https://rslib.rs/config/rsbuild/source.md): Configure Rsbuild source options in Rslib, including entries, defines, decorators, aliases, and source transforms.
- [output](https://rslib.rs/config/rsbuild/output.md): Configure Rsbuild output options in Rslib, including asset prefixes, dist paths, externals, filenames, and CSS emission.
- [tools](https://rslib.rs/config/rsbuild/tools.md): Configure Rsbuild tools in Rslib to customize lower-level bundler, JavaScript, and CSS processing.
- [performance](https://rslib.rs/config/rsbuild/performance.md): Configure Rsbuild performance options in Rslib, including persistent build caching, file size reporting, and console removal.
- [plugins](https://rslib.rs/config/rsbuild/plugins.md): Configure Rsbuild plugins in Rslib to register extensions and customize build behavior with plugin-based integration.

## API

- [JavaScript API](https://rslib.rs/api/start/index.md): Get started with the Rslib JavaScript API in Node.js, Deno, or Bun using createRslib and instance methods.
- [Rslib core](https://rslib.rs/api/javascript-api/core.md): Use Rslib core APIs such as createRslib, loadConfig, defineConfig, and environment loading in JavaScript workflows.
- [Rslib instance](https://rslib.rs/api/javascript-api/instance.md): Use the Rslib instance API for builds, Module Federation dev servers, config inspection, and lifecycle control.
- [Rslib types](https://rslib.rs/api/javascript-api/types.md): Reference the TypeScript types exported by Rslib for configs, APIs, instance methods, plugins, and Rsbuild or Rspack types.

## Blog

- [Rslib blogs](https://rslib.rs/blog/index.md): This page collects blog posts about Rslib.
- [Rslib: Build library with Rspack](https://rslib.rs/blog/introducing-rslib.md): Rslib is officially released, helping developers create JavaScript libraries and UI component libraries in a simple and intuitive way.
- [Announcing Rslib 1.0](https://rslib.rs/blog/v1-0.md): Rslib 1.0 is here, focusing on library build capabilities across use cases and the developer experience, with upgrade guidance and a look at what's next.