# Rsbuild

> * **Type:**`'prefer-tsconfig' | 'prefer-alias'`

## Pages

- [resolve.aliasStrategy](alias-strategy.md): * **Type:**`'prefer-tsconfig' | 'prefer-alias'`
- [Path aliases](alias.md): Path aliases allow developers to define aliases for modules, making it easier to reference them in code. This can be ...
- [html.appIcon](app-icon.md): * **Type:**
- [dev.assetPrefix](asset-prefix.md): * **Type:**`boolean | string | 'auto'`
- [source.assetsInclude](assets-include.md): * **Type:** [Rspack.RuleSetCondition](https://rspack.rs/config/module-rules#condition)
- [server.base](base.md): * **Type:**`string`
- [Browser compatibility](browser-compatibility.md): Rsbuild supports [modern browsers](/guide/advanced/browserslist.md#default-browserslist) by default and provides synt...
- [dev.browserLogs](browser-logs.md): * **Type:**
- [Browserslist](browserslist.md): Rsbuild supports using [Browserslist](https://browsersl.ist/) to specify which browsers should be supported in your w...
- [performance.buildCache](build-cache.md): * **Type:**
- [Improve build performance](build-performance.md): While Rsbuild optimizes build performance by default, performance issues can arise as your project grows.
- [Build profiling](build-profiling.md): Running a performance analysis helps you identify bottlenecks in your project so you can optimize the right areas.
- [performance.bundleAnalyze](bundle-analyze.md): * **Type:**`Object | undefined`
- [tools.bundlerChain](bundler-chain.md): * **Type:**
- [output.charset](charset.md): * **Type:**`'ascii' | 'utf8'`
- [performance.chunkSplit](chunk-split.md): * **Type:**`ChunkSplit`
- [output.cleanDistPath](clean-dist-path.md): * **Type:**
- [dev.cliShortcuts](cli-shortcuts.md): * **Type:**
- [CLI](cli.md): Rsbuild includes a lightweight CLI with commands like rsbuild dev and rsbuild build.
- [dev.client](client.md): Configure the client code injected by Rsbuild during the development process. This can be used to set the WebSocket U...
- [Code splitting](code-splitting.md): A good chunk splitting strategy is important for improving application load performance. It leverages browser caching...
- [server.compress](compress.md): * **Type:**
- [resolve.conditionNames](condition-names.md): * **Type:**`string[]`
- [output.copy](copy.md): * **Type:**`Rspack.CopyRspackPluginOptions | Rspack.CopyRspackPluginOptions['patterns']`
- [Plugin API](core.md): This page explains the type definitions and usage of Rsbuild plugin APIs.
- [server.cors](cors.md): * **Type:**`boolean | import('cors').CorsOptions`
- [Create React App](cra.md): This chapter introduces how to migrate a [Create React App](https://github.com/facebook/create-react-app) (CRA) or [C...
- [html.crossorigin](crossorigin.md): * **Type:**`boolean | 'anonymous' | 'use-credentials'`
- [tools.cssExtract](css-extract.md): * **Type:**
- [CSS-in-JS](css-in-js.md): This document outlines how to use common CSS-in-JS libraries in Rsbuild.
- [tools.cssLoader](css-loader.md): * **Type:**`Object | Function`
- [CSS Modules](css-modules.md): [CSS Modules](https://github.com/css-modules/css-modules) allows you to write CSS in a modular way, and import these ...
- [CSS](css-usage.md): Rsbuild provides out-of-the-box support for CSS, including PostCSS, CSS Modules, CSS preprocessors, CSS inlining, and...
- [output.dataUriLimit](data-uri-limit.md): * **Type:**
- [Debug mode](debug-mode.md): Rsbuild provides a debug mode to troubleshoot problems. Add the`DEBUG=rsbuild`environment variable when you run a b...
- [source.decorators](decorators.md): * **Type:**
- [resolve.dedupe](dedupe.md): * **Type:**`string[]`
- [source.define](define.md): * **Type:**`Record`
- [Dev server API](dev-server-api.md): Rsbuild provides a set of dev server APIs that you can access through plugin hooks or JavaScript API.
- [output.distPath](dist-path.md): * **Type:**
- [performance.dnsPrefetch](dns-prefetch.md): * **Type:**`string[] | undefined`
- [output.emitAssets](emit-assets.md): * **Type:**`boolean`
- [output.emitCss](emit-css.md): * **Type:**`boolean`
- [source.entry](entry.md): * **Type:**
- [Environment variables](env-vars.md): Rsbuild supports injecting environment variables or expressions into your code during the build. This helps you disti...
- [Environment API](environment-api.md): Here you can find all environment APIs.
- [Multi-environment builds](environments.md): Rsbuild can build outputs for multiple environments in a single run. Use [environments](/config/environments.md) to b...
- [Exceptions FAQ](exceptions.md): By default, Rsbuild does not compile JavaScript files in`node_modules`. If an npm package includes ESNext syntax, th...
- [source.exclude](exclude.md): * **Type:** [Rspack.RuleSetCondition](https://rspack.rs/config/module-rules#condition)
- [resolve.extensions](extensions.md): * **Type:**`string[]`
- [output.externals](externals.md): * **Type:**
- [html.favicon](favicon.md): * **Type:**`string ｜ Function`
- [Features](features.md): Overview of the main features supported by Rsbuild.
- [output.filenameHash](filename-hash.md): * **Type:**`boolean | string`
- [output.filename](filename.md): * **Type:**
- [General FAQ](general.md): Rspack is the underlying bundler for Rsbuild. The goal of Rsbuild is to provide out-of-the-box build capabilities for...
- [Glossary](glossary.md): Module bundlers like [Rspack](https://rspack.rs/) and [webpack](https://webpack.js.org/).
- [server.headers](headers.md): * **Type:**`Record`
- [server.historyApiFallback](history-api-fallback.md): * **Type:**`boolean | HistoryApiFallbackOptions`
- [Hot module replacement](hmr.md): Hot Module Replacement (HMR) exchanges, adds, or removes modules while an application is running, without a full page...
- [Plugin hooks](hooks.md): This page outlines the plugin hooks available for Rsbuild plugins.
- [server.host](host.md): * **Type:**`string`
- [server.htmlFallback](html-fallback.md): * **Type:**`false | 'index'`
- [tools.htmlPlugin](html-plugin.md): * **Type:**`boolean | Object | Function`
- [server.https](https.md): * **Type:**
- [source.include](include.md): * **Type:** [Rspack.RuleSetCondition](https://rspack.rs/config/module-rules#condition)
- [Introduction](index.md): Rsbuild is a high-performance build tool powered by Rspack. It provides carefully designed defaults for an out-of-the...
- [output.injectStyles](inject-styles.md): * **Type:**`boolean`
- [Inline static assets](inline-assets.md): Inlining static assets refers to embedding the content of a static asset directly in an HTML or JS file instead of li...
- [Rsbuild instance](instance.md): This section describes all the properties and methods on the Rsbuild instance object.
- [JSON](json-files.md): Rsbuild supports importing JSON files in code, and also supports importing [YAML](https://yaml.org/) and [TOML](https...
- [dev.lazyCompilation](lazy-compilation.md): * **Type:**
- [output.legalComments](legal-comments.md): * **Type:**`'linked' | 'inline' | 'none'`
- [tools.lightningcssLoader](lightningcss-loader.md): * **Type:**`Rspack.LightningcssLoaderOptions | Function | boolean`
- [dev.liveReload](live-reload.md): * **Type:**`boolean`
- [logLevel](log-level.md): * **Type:**`'info' | 'warn' | 'error' | 'silent'`
- [resolve.mainFields](main-fields.md): * **Type:**`string[]`
- [output.manifest](manifest.md): * **Type:**`string | boolean`
- [html.meta](meta.md): * **Type:**`Object | Function`
- [server.middlewareMode](middleware-mode.md): * **Type:**`boolean`
- [output.minify](minify.md): * **Type:**
- [mode](mode.md): * **Type:**`'production' | 'development' | 'none'`
- [Modern.js Builder](modern-builder.md): This chapter introduces how to migrate a Modern.js Builder (or EdenX Builder) project to Rsbuild.
- [Module Federation](module-federation.md): Module Federation is an architectural pattern for decomposing JavaScript applications. Similar to server-side microse...
- [output.module](module.md): * **Type:**`boolean`
- [html.mountId](mount-id.md): * **Type:**`string`
- [security.nonce](nonce.md): * **Type:**
- [server.open](open.md): * **Type:**
- [Bundle size optimization](optimize-bundle.md): Bundle size optimization is critical for production builds because it directly affects user experience. This document...
- [moduleFederation.options](options.md): * **Type:** [Rspack.ModuleFederationPluginOptions](https://rspack.rs/plugins/webpack/module-federation-plugin#options)
- [Output files](output-files.md): This section covers the output file directory structure and how to control output directories for different file types.
- [html.outputStructure](output-structure.md): * **Type:**`'flat' | 'nested'`
- [output.overrideBrowserslist](override-browserslist.md): * **Type:**`string[]`
- [Babel plugin](plugin-babel.md): import { SourceCode } from '@theme';
- [Less plugin](plugin-less.md): import { SourceCode } from '@theme';
- [Preact plugin](plugin-preact.md): import { SourceCode } from '@theme';
- [React plugin](plugin-react.md): import { SourceCode } from '@theme';
- [Sass plugin](plugin-sass.md): import { SourceCode } from '@theme';
- [Solid plugin](plugin-solid.md): import { SourceCode } from '@theme';
- [Stylus plugin](plugin-stylus.md): import { SourceCode } from '@theme';
- [Svelte plugin](plugin-svelte.md): import { SourceCode } from '@theme';
- [SVGR plugin](plugin-svgr.md): import { SourceCode } from '@theme';
- [Vue plugin](plugin-vue.md): import { SourceCode } from '@theme';
- [plugins](plugins.md): Registers Rsbuild plugins.
- [output.polyfill](polyfill.md): * **Type:**`'entry' | 'usage' | 'off'`
- [server.port](port.md): * **Type:**`number`
- [tools.postcss](postcss.md): * **Type:**`Object | Function`
- [source.preEntry](pre-entry.md): * **Type:**`string | string[]`
- [Preact](preact.md): In this document, you will learn how to build a Preact application using Rsbuild.
- [performance.preconnect](preconnect.md): * **Type:**
- [performance.printFileSize](print-file-size.md): * **Type:**
- [server.printUrls](print-urls.md): * **Type:**
- [performance.profile](profile.md): * **Type:**`boolean`
- [dev.progressBar](progress-bar.md): * **Type:**
- [server.proxy](proxy.md): * **Type:**
- [server.publicDir](public-dir.md): * **Type:**
- [Quick start](quick-start.md): We provide online Rsbuild examples that showcase Rspack's build performance and Rsbuild's development experience:
- [React](react.md): This document explains how to use Rsbuild to build a React application.
- [performance.removeConsole](remove-console.md): * **Type:**`boolean | ConsoleType[]`
- [performance.removeMomentLocale](remove-moment-locale.md): * **Type:**`boolean`
- [root](root.md): * **Type:**`string`
- [Migrating from Rsbuild 0.x](rsbuild-0-x.md): This document lists all breaking changes from Rsbuild 0.7 to 1.0. Use it as a migration reference.
- [Configure Rsbuild](rsbuild.md): Rsbuild provides a wide range of configuration options with sensible defaults for most use cases. In most scenarios, ...
- [Use Rsdoctor](rsdoctor.md): [Rsdoctor](https://rsdoctor.rs/) is a build analyzer tailored for the Rspack ecosystem.
- [Configure Rspack](rspack.md): Rsbuild supports directly modifying the Rspack configuration object, and supports modifying the built-in Rspack confi...
- [Dev server](server.md): Rsbuild includes a built-in dev server that enhances the development experience. When you run`rsbuild dev`or`rsbui...
- [dev.setupMiddlewares](setup-middlewares.md): * **Type:**
- [Solid](solid.md): In this document, you will learn how to build a Solid application using Rsbuild.
- [output.sourceMap](source-map.md): * **Type:**
- [security.sri](sri.md): * **Type:**
- [Server-side rendering (SSR)](ssr.md): This chapter introduces how to implement SSR functionality using Rsbuild.
- [Static assets](static-assets.md): Rsbuild supports importing static assets, including images, fonts, audio, and video.
- [Deploy static site](static-deploy.md): This section explains how to deploy Rsbuild build outputs as a static site.
- [server.strictPort](strict-port.md): * **Type:**`boolean`
- [tools.styleLoader](style-loader.md): * **Type:**`Object | Function`
- [Svelte](svelte.md): In this document, you will learn how to build a Svelte application using Rsbuild.
- [Configure SWC](swc.md): [SWC](https://github.com/swc-project/swc) (Speedy Web Compiler) is a transformer and minimizer for JavaScript and Typ...
- [Tailwind CSS v3](tailwindcss-v3.md): [Tailwind CSS](https://v3.tailwindcss.com/) is a CSS framework and design system based on utility classes, which can ...
- [Tailwind CSS v4](tailwindcss.md): [Tailwind CSS](https://tailwindcss.com/) is a CSS framework and design system based on utility classes, which can qui...
- [output.target](target.md): * **Type:**
- [html.templateParameters](template-parameters.md): * **Type:**`Record | Function`
- [Testing](testing.md): Rsbuild doesn't include built-in testing frameworks, but integrates seamlessly with popular testing tools.
- [html.title](title.md): * **Type:**`string ｜ Function`
- [source.transformImport](transform-import.md): * **Type:**
- [source.tsconfigPath](tsconfig-path.md): * **Type:**`string`
- [Rsbuild types](types.md): This section describes some of the type definitions provided by the Rsbuild.
- [TypeScript](typescript.md): Rsbuild supports TypeScript by default, allowing you to directly use`.ts`and`.tsx`files in your project.
- [UnoCSS](unocss.md): [UnoCSS](https://unocss.dev/) is the instant atomic CSS engine, which is designed to be flexible and extensible. The ...
- [Upgrading Rsbuild](upgrade-rsbuild.md): This section explains how to upgrade your project's Rsbuild dependencies to the latest version.
- [Announcing Rsbuild 0.1](v0-1.md): *November 22, 2023*
- [Announcing Rsbuild 0.2](v0-2.md): *December 11, 2023*
- [Announcing Rsbuild 0.3](v0-3.md): *January 10, 2024*
- [Announcing Rsbuild 0.4](v0-4.md): *February 06, 2024*
- [Announcing Rsbuild 0.5](v0-5.md): *March 19, 2024*
- [Announcing Rsbuild 0.6](v0-6.md): *April 10, 2024*
- [Announcing Rsbuild 0.7](v0-7.md): *May 28, 2024*
- [Upgrading from 0.x to v1](v0-to-v1.md): This document lists all breaking changes from Rsbuild 0.7 to 1.0. Use it as a migration reference.
- [Announcing Rsbuild 1.0](v1-0.md): *September 10, 2024*
- [Vite plugin](vite-plugin.md): This chapter introduces how to migrate a Vite plugin to Rsbuild plugin.
- [Vite](vite.md): This guide explains how to migrate a Vite project to Rsbuild.
- [Vue CLI](vue-cli.md): This chapter introduces how to migrate a [Vue CLI](https://github.com/vuejs/vue-cli) project to Rsbuild.
- [Vue](vue.md): This document explains how to build a Vue 3 or Vue 2 application using Rsbuild.
- [Wasm](wasm-assets.md): Rsbuild provides native support for WebAssembly (WASM) modules, allowing you to import and use`.wasm`files directly...
- [dev.watchFiles](watch-files.md): * **Type:**
- [Web Workers](web-workers.md): This page explains how to configure and use [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Worker...
- [webpack](webpack.md): This section introduces how to migrate a webpack project to Rsbuild.
- [dev.writeToDisk](write-to-disk.md): * **Type:**`boolean | ((filename: string) => boolean)`