Rsbuild 使用教程

Rsbuild 使用教程

项目地址:https://gitcode.com/gh_mirrors/rs/rsbuild

项目介绍

Rsbuild 是一个高性能的构建工具,由 Rspack 驱动。它提供了一系列精心设计的默认构建配置,为用户提供开箱即用的开发体验,并能充分发挥 Rspack 的性能优势。Rsbuild 支持丰富的构建特性,包括 TypeScript、JSX、Sass、Less、CSS 模块、Wasm 等的编译,同时还支持模块联邦、图像压缩、类型检查、PostCSS、Lightning CSS 等功能。

项目快速启动

安装 Rsbuild

首先,确保你已经安装了 Node.js 和 npm。然后,通过以下命令安装 Rsbuild:

npm install @rsbuild/core

创建项目

创建一个新的项目目录并初始化:

mkdir my-project
cd my-project
npm init -y

配置 Rsbuild

在项目根目录下创建一个 rsbuild.config.js 文件,并添加以下基本配置:

module.exports = {
  entry: './src/index.js',
  output: {
    path: __dirname + '/dist',
    filename: 'bundle.js'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  }
};

运行开发服务器

在项目根目录下运行以下命令启动开发服务器:

npx rsbuild serve

应用案例和最佳实践

模块联邦

Rsbuild 团队与模块联邦开发团队紧密合作,提供对模块联邦的一流支持,帮助你开发具有微前端架构的大型 Web 应用程序。以下是一个简单的模块联邦配置示例:

const { ModuleFederationPlugin } = require('@rsbuild/core/plugins');

module.exports = {
  plugins: [
    new ModuleFederationPlugin({
      name: 'app1',
      filename: 'remoteEntry.js',
      exposes: {
        './Button': './src/Button'
      },
      remotes: {
        app2: 'app2@http://localhost:3002/remoteEntry.js'
      }
    })
  ]
};

图像压缩

Rsbuild 支持图像压缩,可以通过配置来优化图像资源:

const ImageMinimizerPlugin = require('image-minimizer-webpack-plugin');

module.exports = {
  plugins: [
    new ImageMinimizerPlugin({
      minimizerOptions: {
        plugins: ['gifsicle', 'jpegtran', 'optipng', 'svgo']
      }
    })
  ]
};

典型生态项目

Rspack

Rspack 是一个基于 Rust 的快速 Web 打包工具,是 Rsbuild 的核心依赖。

Rspress

Rspress 是一个基于 Rsbuild 的快速静态站点生成器,适用于构建文档和博客。

Rsdoctor

Rsdoctor 是一个一站式构建分析器,用于 Rspack 和 webpack,帮助你诊断和优化构建过程。

Rslib

Rslib 是一个由 Rsbuild 驱动的库构建工具,专注于特定领域的能力开发。

通过以上教程,你可以快速上手 Rsbuild,并利用其强大的功能和生态系统来构建高性能的 Web 应用程序。

rsbuild Unleash the power of Rspack with the out-of-the-box build tool. rsbuild 项目地址: https://gitcode.com/gh_mirrors/rs/rsbuild

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

03-18
### rsbuild 是什么 rsbuild 是一个现代化的构建工具,旨在为前端开发提供高效、灵活且易于扩展的解决方案。它专注于优化 Web 应用程序的构建流程,通过内置的功能模块简化常见的开发需求,例如代码拆分、Tree Shaking 和多平台支持等[^1]。 以下是 rsbuild 的一些核心特性: - **高性能构建**:利用现代 JavaScript 技术栈(如 ESBuild),显著提升构建速度。 - **开箱即用的支持**:默认支持 JSX、TypeScript、CSS Modules 等常用技术,无需额外配置即可使用。 - **可扩展性**:允许开发者通过插件机制自定义行为,满足特定场景下的复杂需求。 - **跨端兼容**:不仅适用于浏览器环境,还提供了针对小程序和其他运行时的适配能力。 --- ### rsbuild 使用指南 #### 1. 初始化项目 要开始使用 rsbuild,可以通过 npm 或 yarn 安装 CLI 工具,并初始化一个新的项目: ```bash npx @rsbuild/cli init my-project cd my-project npm install ``` 这一步会创建一个基础目录结构,类似于以下内容: ``` my-project/ ├── public/ # 静态资源存放位置 ├── src/ # 源代码目录 │ ├── assets/ # 资产文件 (图片, 字体等) │ ├── components/ # 可重用组件 │ └── main.js # 入口文件 ├── rsbuild.config.js # 构建配置文件 └── package.json # 项目元数据和依赖声明 ``` #### 2. 基础配置 `rsbuild.config.js` 是 rsbuild 的主要配置入口,用于调整构建选项。以下是一个简单的示例配置: ```javascript module.exports = { source: { entry: './src/main.js', // 设置入口文件路径 }, output: { distDir: 'dist', // 输出目录名称 }, plugins: [], // 插件列表 }; ``` 如果需要更复杂的设置,比如启用 CSS Modules 或者 Tree Shaking,则可以在 `plugins` 中添加对应的插件实例[^2]。 #### 3. 执行构建 完成上述准备工作之后,就可以执行构建命令了: ```bash npm run build ``` 此操作将会依据当前配置生成最终产物,默认存放在 `dist/` 文件夹下。 对于本地调试而言,也可以启动开发服务器来实时预览效果: ```bash npm start ``` --- ### 示例代码片段 假设我们正在开发一个 React 组件,并希望将其纳入 rsbuild 流程中。那么可以按照如下方式编写代码: ```jsx // ./src/components/App.jsx import React from 'react'; import styles from './App.module.css'; // 导入样式表作为模块 function App() { return ( <div className={styles.container}> <h1>Hello Rsbuild!</h1> </div> ); } export default App; ``` 与此同时,在 `rsbuild.config.js` 中开启对 CSS Modules 的解析支持: ```javascript const { defineConfig } = require('@rsbuild/core'); module.exports = defineConfig({ css: { modules: true, }, }); ``` --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

晏彤钰Mighty

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值