Skip to content

Create JavaScript libraries in a simple and intuitive way.

License

Notifications You must be signed in to change notification settings

MaxtuneLee/rslib

 
 

Repository files navigation

Rslib Banner

Rslib

Discord channel npm version downloads node version license

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 provides a comprehensive set of build features for library development, including:

  • 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.

✨ Why Rslib?

In the past, we typically did not use webpack or Rspack to build ESM packages because they often included excessive runtime code, making them less friendly to package consumers. However, the community has developed a vast ecosystem around webpack and Rspack, which provides powerful features like tree shaking, code splitting, module federation and more.

So we decided to create Rslib. It improves the quality of ESM output from Rspack and webpack, leverages their extensive ecosystem, and utilizes Rsbuild's excellent out-of-the-box configuration. Rslib aims to provide a superior developer experience and explore new possibilities based on the Rspack architecture.

📍 Roadmap

🚧 Rslib is still in its early stages and under active development. We are building Rslib by working in two main parts:

You can click the link above to check the progress of these tasks. The roadmap may change as we move forward.

We plan to complete the core features of Rslib in Q3 2024 and use Rslib to build our npm packages such as Rspack and Rsbuild (dogfooding). And Rslib will have a public stable version in Q4 2024.

If you're interested in Rslib, feel free to submit issues or pull requests to help us get there faster.

You can also clone the repository and run the examples in the examples folder to experience Rslib.

🦀 Links

🤝 Contribution

New contributors welcome!

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.

🌟 Quality

Rslib uses Web Infra QoS to observe the trend of key metrics, such as bundle size, compile speed and install size.

🙏 Credits

Some of the implementations of Rslib have drawn inspiration from outstanding projects in the community. We would like to express our gratitude to them:

📖 License

Rslib is licensed under the MIT License.

About

Create JavaScript libraries in a simple and intuitive way.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 71.2%
  • MDX 21.3%
  • JavaScript 5.2%
  • CSS 1.3%
  • Other 1.0%