# Rslib
English | [įŽäŊä¸æ](./README.zh-CN.md)
Rslib is a library development tool based on [Rsbuild](https://rsbuild.rs).
It gives developers a simple way to create JavaScript libraries and UI component libraries, and provides tool integrations and best practices for building, debugging, documentation, and testing throughout library development.
## đĨ Features
Rslib has the following features:
- **Easy to configure**: Out-of-the-box tooling enables developers to build libraries with zero configuration. Rslib also provides a set of semantic build configurations that can be extended as project needs grow.
- **Performance-focused**: Powered by [Rspack](https://rspack.rs), it integrates high-performance Rust-based tools from the community, including [SWC](https://swc.rs/) and [Lightning CSS](https://lightningcss.dev/), delivering first-class build speed and development experience.
- **Plugin ecosystem**: Supports [Rsbuild plugins](https://rsbuild.rs/plugins/list/), Rspack plugins, and webpack plugins, allowing developers to reuse existing plugin ecosystems and continue using familiar development workflows and engineering practices.
- **Flexible outputs**: Designed around the diverse ways libraries are published and consumed, it supports flexible build output configuration for different runtimes, distribution methods, and downstream build tools to meet the delivery needs of different types of libraries.
- **Framework agnostic**: Decoupled from frontend UI frameworks, it supports React, Vue, Svelte, Solid, and other frameworks through plugins, allowing developers to build component libraries for different frameworks with a consistent configuration and development workflow.
## đ Documentation
- [Rslib v1 docs](https://rslib.rs)
- [Rslib v0 docs](https://v0.rslib.rs)
## đĻ Rstack
Rslib is part of Rstack, the fast, unified JavaScript toolchain for developers and agents.
| Name | Description | Version |
| ----------------------------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Rspack](https://github.com/web-infra-dev/rspack) | Bundler | 
|
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | Build tool | 
|
| [Rslib](https://github.com/web-infra-dev/rslib) | Library development tool | 
|
| [Rspress](https://github.com/web-infra-dev/rspress) | Static site generator | 
|
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | Build analyzer | 
|
| [Rstest](https://github.com/web-infra-dev/rstest) | Testing framework | 
|
| [Rslint](https://github.com/web-infra-dev/rslint) | Linter | 
|
| [Rstack CLI](https://github.com/rstackjs/rstack-cli) | Unified CLI | 
|
## đ Links
- [awesome-rstack](https://github.com/rstackjs/awesome-rstack): A curated list of awesome things related to Rstack.
- [agent-skills](https://github.com/rstackjs/agent-skills): A collection of Agent Skills for Rstack.
- [rstack-examples](https://github.com/rstackjs/rstack-examples): Examples showcasing Rstack.
- [storybook-rsbuild](https://github.com/rstackjs/storybook-rsbuild): Storybook builder powered by Rsbuild.
- [rsbuild-plugin-template](https://github.com/rstackjs/rsbuild-plugin-template): Use this template to create your own Rsbuild plugin.
- [rstack-design-resources](https://github.com/rstackjs/rstack-design-resources): Design resources for Rstack.
## đ¤ Contribution
> [!NOTE]
> We highly value any contributions to Rslib!
Please read the [Contributing Guide](https://github.com/web-infra-dev/rslib/blob/main/CONTRIBUTING.md).
### Contributors
### Code of conduct
This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.
## đ§âđģ Community
Come and chat with us on [Discord](https://discord.gg/7uHaPXcVyV)! The Rstack team and users are active there, and we're always looking for contributions.
## đ Credits
Parts of Rslib are derived from or inspired by many excellent open source projects. We sincerely appreciate the work of these projects and the ideas they have shared with the community:
- [esbuild](https://github.com/evanw/esbuild)
- [mini-css-extract-plugin](https://github.com/webpack/mini-css-extract-plugin)
- [tsdown](https://github.com/rolldown/tsdown)
- [tsup](https://github.com/egoist/tsup)
- [webpack](https://github.com/webpack/webpack)
## đ License
Rslib is licensed under the [MIT License](https://github.com/web-infra-dev/rslib/blob/main/LICENSE).