Packages

This document showcases all the npm package information maintained by Rsbuild team.


@rsbuild/core

Rsbuild core package that provides CLI commands and build capabilities based on Rspack.


@rsbuild/plugin-react

The React plugin provides support for React, integrating features such as JSX compilation and React Refresh.


@rsbuild/plugin-vue

Vue 3 plugin that provides support for Vue 3 Single-File Components (SFC).


@rsbuild/plugin-vue-jsx

Vue 3 JSX plugin that provides support for Vue 3 JSX / TSX syntax.


@rsbuild/plugin-vue2

Vue 2 plugin that provides support for Vue 2 Single-File Components (SFC).


@rsbuild/plugin-vue2-jsx

Vue 2 JSX plugin that provides support for Vue 2 JSX / TSX syntax.


@rsbuild/plugin-eslint

The ESLint plugin is used to run ESLint checks during the compilation.


@rsbuild/plugin-type-check

Type check plugin that runs TypeScript type checker on a separate process.


@rsbuild/plugin-source-build

This plugin is designed for the monorepo scenario. It supports referencing source code from other subdirectories and performs build and hot update.


@rsbuild/plugin-stylus

Stylus plugin that uses Stylus as the CSS preprocessor.


@rsbuild/plugin-node-polyfill

Node Polyfill plugin used to inject polyfills for Node core modules in the browser.


@rsbuild/plugin-image-compress

Image Compress plugin used to compress image resources used in the project.


@rsbuild/plugin-mdx

Provide support for MDX.


@rsbuild/plugin-check-syntax

Check Syntax plugin used to analyze the syntax compatibility of artifacts, to see if there are any advanced syntaxes that may cause compatibility issues.


@rsbuild/plugin-pug

Provides support for the Pug template engine.


@rsbuild/plugin-rem

Implements the rem adaptive layout for mobile pages.


@rsbuild/plugin-umd

Used to build outputs in UMD format.


@rsbuild/plugin-yaml

Used to import YAML files and convert them into JavaScript objects.


@rsbuild/plugin-toml

Used to import TOML files and convert them into JavaScript objects.


@rsbuild/plugin-assets-retry

Used to automatically resend requests when static assets fail to load.


@rsbuild/shared

Shared modules and helpers used internally by Rsbuild.

TIP

The @rsbuild/shared is used internally by Rsbuild. Please avoid relying on the methods exported by @rsbuild/shared in web projects or community plugins.

If you need to use the methods in @rsbuild/shared, you can directly copy the relevant code into your project, or you can provide feedback through issues. We will evaluate whether there is a need to provide an external API.


@rsbuild/document

Rsbuild documentation site.


create-rsbuild

Used to create a new Rsbuild project.