Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/atom-yang/aumi

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/atom-yang/aumi
Owner: atom-yang
Created: 2024-08-11T09:05:39.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-09-10T11:23:34.000Z (4 months ago)
Last Synced: 2024-09-10T12:53:25.162Z (4 months ago)
Language: TypeScript
Size: 418 KB
Stars: 8
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-rspack - AUmi

README

# AUmi

Build Umi based on Rsbuild

English | [简体中文](./README.zh-CN.md)

AUmi switches Umi's default bundler from Webpack to [Rsbuild](https://rsbuild.dev/zh/)

## Features

* [10x performance improvement](https://rsbuild.dev/zh/guide/start/index#-%E6%80%A7%E8%83%BD);
* Retain Umi plugin system and the same user experience;
* Migration Umi project in 5 minutes.

## Migration

**Notice: Make sure your Umi version is >= 4.0**

**Notice: V**

### Installation

```bash
npm add @aumi/aumi@latest -S
```

### File changes

#### Updating `.umirc.ts` :

```diff title=".umirc.ts"
- import { defineConfig } from 'umi';
+ import {defineAUMIConfig} from "@aumi/aumi";

- export default defineConfig({
+ export default defineAUMIConfig({
...,
});
```

Due to compatibility or lacking of testing, cannot support the following configurations.

`defineAUMIConfig` has comprehensive TypeScript typing support except Umi plugins' typing

### Updating `package.json`

Updating `scripts` field of `package.json`.

```diff title="package.json"
{
"scripts": {
- "dev": "umi dev",
+ "dev": "aumi dev",
- "build": "umi build",
+ "build": "aumi build",
+ "analyze": "RSDOCTOR=true aumi build",
- "postinstall": "umi setup",
+ "postinstall": "aumi setup",
- "setup": "umi setup",
+ "setup": "aumi setup",
"start": "npm run dev"
}
}
```

The `analyze` command replaces Umi's `analyze` functionality by using [Rsdoctor](https://rsbuild.dev/zh/guide/debug/rsdoctor).

## Start a new Project

Take Umi [Getting Started](https://umijs.org/en-US/docs/guides/getting-started) as a reference to start a new project, and follow instructions above [Migration](#Migration)

## Other changes

### New configuration in `.umirc.ts`

| Field | Default value | Usage |
|:----------------|:--------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| rsbuildConfig | undefined | Full RsbuildConfig and has higher priority than other configs, will be merged by [mergeRsbuildConfig](https://rsbuild.dev/api/javascript-api/core#mergersbuildconfig), [Reference](https://rsbuild.dev/config/index) |
| aliasStrategy | 'prefer-alias' | The strategy of `alias` configuration, [Reference](https://rsbuild.dev/config/source/alias-strategy) |
| transformImport | undefined | Similar to `babel-plugin-import`, [Reference](https://rsbuild.dev/config/source/transform-import) |
| react | [reference](https://rsbuild.dev/plugins/list/plugin-react#%E9%80%89%E9%A1%B9) | The configuration of Rsbuild plugin `@rsbuild/plugin-react`, [Reference](https://rsbuild.dev/plugins/list/plugin-react#%E9%80%89%E9%A1%B9) |
| rspack | undefined | Modify rspack configuration, [Reference](https://rsbuild.dev/config/tools/rspack) |

### Changes of Umi plugins' extended methods

Umi provides massive extended methods by its plugin mechanism [Umi Plugin Api](https://umijs.org/en-US/docs/api/plugin-api).
Due to we switch the bundler from `@umijs/bundler-webpack` to `Rsbuild`, some underlying build processes are inconsistent with `@umijs/bundler-webpack`. As a result, certain custom methods have been removed, if any removed methods are called, an error will be thrown out.

Remove extended methods as below, most are `Babel` related:

* [addExtraBabelPresets](https://umijs.org/docs/api/plugin-api#addextrababelpresets)
* [addExtraBabelPlugins](https://umijs.org/docs/api/plugin-api#addextrababelplugins)
* [addBeforeBabelPresets](https://umijs.org/docs/api/plugin-api#addbeforebabelpresets)
* [addBeforeBabelPlugins](https://umijs.org/docs/api/plugin-api#addbeforebabelplugins)
* [modifyWebpackConfig](https://umijs.org/docs/api/plugin-api#modifywebpackconfig)
* [modifyViteConfig](https://umijs.org/docs/api/plugin-api#modifyviteconfig)
* [modifyServerRendererPath](https://umijs.org/docs/api/plugin-api#modifyserverrendererpath)
* modifyBabelPresetOpts

Add new extended methods for `Rsbuild`

* `modifyRsbuildPlugins`: modifying `Rsbuild` plugins

Example:
```typescript
api.modifyRsbuildPlugins(plugins => {
return plugins.slice(1);
});
```

* `modifyRsbuildConfig`: modifying `RsbuildConfig` with the highest priority

example:
```typescript
api.modifyRsbuildConfig(config => {
config.root = './';
return config;
});
```

## Remain issues

TODO