npm 包

本文档展示了 Rsbuild 团队维护的所有 npm 包信息。

@rsbuild/core

Rsbuild 核心包,提供 CLI 命令和基于 Rspack 的构建能力。

@rsbuild/plugin-react

React 插件提供了对 React 的支持,插件内部集成了 JSX 编译、React Refresh 等功能。

@rsbuild/plugin-vue

Vue 3 插件,提供对 Vue 3 SFC(单文件组件)的支持。

@rsbuild/plugin-vue-jsx

Vue 3 JSX 插件,提供对 Vue 3 JSX / TSX 语法的支持。

@rsbuild/plugin-vue2

Vue 2 插件,提供对 Vue 2 SFC(单文件组件)的支持。

@rsbuild/plugin-vue2-jsx

Vue 2 JSX 插件,提供对 Vue 2 JSX / TSX 语法的支持。

@rsbuild/plugin-eslint

ESLint 插件,用于在编译过程中运行 ESLint 检查。

@rsbuild/plugin-type-check

Type check 插件,在单独的进程中运行 TypeScript 类型检查。

@rsbuild/plugin-typed-css-modules

为项目中的 CSS Modules 文件生成类型声明文件。

@rsbuild/plugin-sass

Sass 插件,使用 Sass 作为 CSS 预处理器。

@rsbuild/plugin-less

Less 插件,使用 Less 作为 CSS 预处理器。

@rsbuild/plugin-stylus

Stylus 插件,使用 Stylus 作为 CSS 预处理器。

@rsbuild/plugin-source-build

用于 monorepo 场景,支持引用其他子目录的源代码,并完成构建和热更新。

@rsbuild/plugin-node-polyfill

Node Polyfill 插件,用于注入 Node 核心模块在浏览器端的 polyfills。

@rsbuild/plugin-image-compress

Image Compress 插件,将项目中用到的图片资源进行压缩处理。

@rsbuild/plugin-mdx

提供 MDX 支持。

@rsbuild/plugin-check-syntax

Check Syntax 插件,用于分析产物的语法兼容性,判断是否存在导致兼容性问题的高级语法。

@rsbuild/plugin-pug

提供对 Pug 模板引擎的支持。

@rsbuild/plugin-rem

用于实现移动端页面的 rem 自适应布局。

@rsbuild/plugin-umd

用于构建 UMD 格式的产物。

@rsbuild/plugin-yaml

用于引用 YAML 文件,并将其转换为 JavaScript 对象。

@rsbuild/plugin-toml

用于引用 TOML 文件,并将其转换为 JavaScript 对象。

@rsbuild/plugin-assets-retry

用于在静态资源加载失败时自动发起重试请求。

@rsbuild/plugin-basic-ssl

为 HTTPS server 生成不受信任的自签名证书。

@rsbuild/shared

Rsbuild 内部使用的公共模块和 helpers。

WARNING

@rsbuild/shared 是 Rsbuild 内部使用的,请避免在 Web 项目或社区插件中依赖 @rsbuild/shared 导出的方法。

如果你需要使用 @rsbuild/shared 里的方法,可以直接拷贝相关代码到项目中,也可以通过 issues 反馈,我们会评估是否需要提供对外的 API。

create-rsbuild

用于创建 Rsbuild 新项目。