Skip to content

Latest commit

 

History

History
167 lines (117 loc) · 10.4 KB

README.zh-CN.md

File metadata and controls

167 lines (117 loc) · 10.4 KB
Rsbuild Banner

Rsbuild

discord channel npm version downloads node version license

English | Portuguese | 简体中文

Rsbuild 是由 Rspack 驱动的高性能构建工具,它默认包含了一套精心设计的构建配置,提供开箱即用的开发体验,并能够充分发挥出 Rspack 的性能优势。

Rsbuild 提供 丰富的构建功能,包括编译 TypeScript,JSX,Sass,Less,CSS Modules,Wasm,以及其他资源,也支持模块联邦、图片压缩、类型检查、PostCSS,Lightning CSS 等功能。

💡 对比其他工具

Rsbuild 是与 ViteCreate React AppVue CLI 相似的构建工具,它们都默认包含了开发服务器、命令行工具和合理的构建配置,以此来提供开箱即用的体验。

CRA / Vue CLI

你可以将 Rsbuild 理解为一个现代化的 Create React App 或 Vue CLI,它与这些工具的主要区别在于:

  • 底层的打包工具由 Webpack 替换为 Rspack,提供 5 ~ 10 倍的构建性能。
  • 与前端 UI 框架解耦,并通过 插件 来支持所有 UI 框架,包括 React、Vue、Svelte、Solid 等。
  • 提供更好的扩展性,你可以通过 配置插件 APIJavaScript API 来灵活地扩展 Rsbuild。

Vite

Rsbuild 与 Vite 有许多相似之处,它们皆致力于提升前端的开发体验。其主要区别在于:

  • 生态兼容性:Rsbuild 兼容大部分的 webpack 插件和所有 Rspack 插件,而 Vite 则是兼容 Rollup 插件。如果你目前更多地使用了 webpack 生态的插件和 loaders,那么迁移到 Rsbuild 是相对容易的。
  • 生产一致性:Rsbuild 在开发阶段和生产构建均使用 Rspack 进行打包,因此开发和生产构建的产物具备较强的一致性,这也是 Vite 通过 Rolldown 想要实现的目标之一。
  • 模块联邦:Rsbuild 团队与 Module Federation 的开发团队密切合作,并为 Module Federation 提供一流的支持,帮助你开发微前端架构的大型 Web 应用。

🚀 性能

Rsbuild 能够充分发挥 Rspack 的性能优势,以下是构建 1000 个 React 组件的时间:

benchmark

以上数据来自 performance-compare benchmark。

🔥 特性

Rsbuild 具备以下特性:

  • 易于配置:Rsbuild 的目标之一,是为 Rspack 用户提供开箱即用的构建能力,使开发者能够在零配置的情况下开发 web 项目。同时,Rsbuild 提供一套语义化的构建配置,以降低 Rspack 配置的学习成本。

  • 性能优先:Rsbuild 集成了社区中基于 Rust 的高性能工具,包括 RspackSWCLightning CSS,以提供一流的构建速度和开发体验。

  • 插件生态:Rsbuild 内置一个轻量级的插件系统,提供一系列高质量的官方插件。此外,Rsbuild 兼容大部分的 webpack 插件和所有的 Rspack 插件,这意味着你可以在 Rsbuild 中使用社区或公司内沉淀的现有插件,而无须重写相关代码。

  • 产物稳定:Rsbuild 设计时充分考虑了构建产物的稳定性,它的开发和生产构建产物具备较强的一致性,并自动完成语法降级和 polyfill 注入。Rsbuild 也提供插件来进行 TypeScript 类型检查和产物语法检查,以避免线上代码的质量问题和兼容性问题。

  • 框架无关:Rsbuild 不与前端 UI 框架耦合,并通过插件来支持 React、Vue、Svelte、Solid、Preact 等框架,未来也计划支持社区中更多的 UI 框架。

🎯 生态

Rsbuild 为上层的框架和工具提供了 JavaScript API 和 plugin API。例如,我们基于 Rsbuild 实现了 RspressRslib,并充分复用 Rsbuild 的能力和生态。

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

Rspack stack layers

📚 快速上手

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

🦀 链接

  • Rspack:基于 Rust 的高性能打包工具。
  • Rspress:基于 Rsbuild 的静态站点生成器。
  • Rsdoctor:针对 Rspack 和 webpack 的一站式构建分析工具。
  • Rslib: 基于 Rsbuild 的 library 构建工具。
  • Modern.js:基于 Rsbuild 的渐进式 React 框架。
  • awesome-rspack:与 Rspack 和 Rsbuild 相关的精彩内容列表。
  • rspack-examples:Rspack、Rsbuild、Rspress 和 Rsdoctor 的示例项目。
  • storybook-rsbuild: 基于 Rsbuild 构建的 Storybook。
  • rsbuild-plugin-template:使用此模板创建你的 Rsbuild 插件。
  • rstack-design-resources:Rspack、Rsbuild、Rspress 和 Rsdoctor 的设计资源。

🤝 参与贡献

欢迎参与 Rsbuild 贡献!

请阅读 贡献指南 来共同参与 Rsbuild 的建设。

贡献者




Contributors of web-infra-dev/rsbuild New trends of web-infra-dev
Contributors of web-infra-dev/rsbuild

行为准则

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

🧑‍💻 社区

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

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

🌟 质量

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

🙏 致谢

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

Rsbuild 网站由 Netlify 提供支持。

📖 License

Rsbuild 项目基于 MIT 协议,请自由地享受和参与开源。