Rslib

English | 简体中文

[!NOTE] The main branch is under active development for Rslib 1.0.

The stable 0.x releases are maintained in the v0.x branch.

The documentation for Rslib v1 is available at v1.rslib.rs.

Rslib is a library development tool that leverages the well-designed configurations and plugins of Rsbuild, empowering library developers to take advantage of the extensive knowledge and ecosystem of webpack and Rspack.

Rslib aims to provide library developers with:

• Easy Library Creation: Easily create high-quality JavaScript and TypeScript libraries in a simple and intuitive way.
• Simple Build Configuration: Provides out-of-the-box build capabilities to meet the diverse needs of library development scenarios with simple configurations.
• Comprehensive Development Workflow: Contains best practices for building, debugging, documentation, and testing during library development to help improve development efficiency and experience.

🔥 Features

Rslib has the following features:

• Compilation of diverse languages: TypeScript, JSX, Sass, Less, CSS Modules, Wasm, and more.
• Flexible build modes: Bundle and bundleless options to meet varying needs.
• Multiple output formats: ESM, CJS, and UMD for maximum compatibility.
• Declaration file generation: Including isolated declarations.
• Advanced features: Module Federation, asset compression, PostCSS, Lightning CSS, and more.

📚 Documentation

• Rslib docs

🎯 Ecosystem

Rslib is implemented based on Rsbuild and fully reuses the capabilities and ecosystem of Rsbuild.

The following diagram illustrates the relationship between Rslib and other tools in the ecosystem:

📚 Getting started

To get started with Rslib, see the Quick start.

🦀 Rstack

Rslib is part of Rstack, the fast, unified JavaScript toolchain for developers and agents.

🔗 Links

• awesome-rstack: A curated list of awesome things related to Rstack.
• agent-skills: A collection of Agent Skills for Rstack.
• rstack-examples: Examples for Rstack.
• storybook-rsbuild: Storybook builder powered by Rsbuild.
• rsbuild-plugin-template: Use this template to create your own Rsbuild plugin.
• rstack-design-resources: Design resources for Rstack.

🤝 Contribution

[!NOTE] We highly value any contributions to Rslib!

Please read the Contributing Guide.

Contributors

Code of conduct

This repo has adopted the ByteDance Open Source Code of Conduct. Please check Code of Conduct for more details.

🧑‍💻 Community

Come and chat with us on Discord! 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
• tsup
• webpack
• mini-css-extract-plugin
• tsdown

📖 License

Rslib is licensed under the MIT License.