Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 5.19 KB

README.zh-CN.md

File metadata and controls

98 lines (63 loc) · 5.19 KB
Rslib Banner

Rslib

Discord channel npm version downloads node version license

English | 简体中文

Rslib 是一个库开发工具,它基于 Rsbuild 精心设计的配置和插件,使库开发者得以复用 webpack 和 Rspack 繁荣的知识和生态系统。

Rslib 旨在为库开发者提供:

  • 便捷的库创建:以简单直观的方式,轻松创建高质量的 JavaScript 和 TypeScript 库。
  • 简洁的构建配置:提供开箱即用的构建能力,以简洁的配置,满足库开发场景的多样化需求。
  • 完善的开发流程:包含库开发过程中构建、调试、文档和测试等环节的最佳实践,帮助提升开发效率与体验。

🔥 功能

Rslib 提供了以下功能:

  • 多种语言的编译: TypeScript、JSX、Sass、Less、CSS Modules、Wasm 等。
  • 灵活的构建模式: Bundle 和 bundleless 模式以满足不同的需求。
  • 多种输出格式: ESM、CJS 和 UMD 以实现最大兼容性。
  • 类型声明文件生成: 包括 isolated declarations。
  • 进阶功能: 模块联邦、资源压缩、PostCSS、Lightning CSS 等。

🎯 生态

Rslib 基于 Rsbuild 实现,并完全复用 Rsbuild 的能力和生态系统。

下图说明了 Rsbuild 与生态中其他工具之间的关系:

Rspack stack layers

📚 快速上手

你可以参考 快速上手 来开始体验 Rslib。

🦀 链接

🤝 参与贡献

Note

我们非常欢迎任何对 Rslib 的贡献!

请阅读 贡献指南

贡献者

行为准则

本仓库采纳了字节跳动的开源项目行为准则。请点击 行为准则 查看更多的信息。

🧑‍💻 社区

欢迎加入我们的 Discord 交流频道!Rstack 团队和用户都在那里活跃,并且我们一直期待着各种贡献。

你也可以加入 飞书群 与大家一起交流。

🌟 质量

Rslib 通过 Web Infra QoS 来观测核心指标的变化情况,比如 bundle size、compile speed 和 install size。

🙏 致谢

Rslib 的一些实现参考了社区中杰出的项目,对他们表示感谢:

Rslib 网站由 Netlify 提供支持。

📖 License

Rslib 项目基于 MIT 协议