2021-11-27 18:47:02 +08:00
|
|
|
# Prettier Build Script
|
|
|
|
|
|
2021-12-02 20:59:38 +09:00
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
- Node.js version `>= 14.18`.
|
|
|
|
|
|
2021-11-27 18:47:02 +08:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Flags
|
|
|
|
|
|
|
|
|
|
### `--playground`
|
|
|
|
|
|
|
|
|
|
Run script with `--playground` flag will only build files needed for the website.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --playground
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### `--print-size`
|
|
|
|
|
|
|
|
|
|
To print the bundled file sizes:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --print-size
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### `--file`
|
|
|
|
|
|
2022-01-27 09:37:55 +08:00
|
|
|
To build specific file(s):
|
2021-11-27 18:47:02 +08:00
|
|
|
|
|
|
|
|
```sh
|
2022-01-27 09:37:55 +08:00
|
|
|
yarn build --file=esm/parser-babel.mjs
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --file=standalone.js --file=parser-meriyah.js
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### `--save-as`
|
|
|
|
|
|
|
|
|
|
To save bundled file to a different location, this flag can only use together with ONE `--file` flag
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --file=parser-babel.js --save-as=babel-for-test.js
|
2021-11-27 18:47:02 +08:00
|
|
|
```
|
|
|
|
|
|
2022-01-27 11:16:50 +08:00
|
|
|
### `--report`
|
|
|
|
|
|
|
|
|
|
Visualize and analyze your esbuild bundle to see which modules are taking up space.
|
|
|
|
|
|
2022-01-27 16:53:07 +08:00
|
|
|
Available reporter formats:
|
|
|
|
|
|
|
|
|
|
- `html` Generate a HTML report file, saved next to the bundled file with `.report.html` suffix.
|
|
|
|
|
- `text` Generate a plain text report file, saved next to the bundled file with `.report.txt` suffix.
|
|
|
|
|
- `stdout` Log report information in console.
|
2022-01-27 11:16:50 +08:00
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --report
|
2022-01-27 16:53:07 +08:00
|
|
|
yarn build --report=stdout --report=text --report=html
|
2022-01-27 11:16:50 +08:00
|
|
|
```
|
|
|
|
|
|
2022-01-27 16:53:07 +08:00
|
|
|
**`--report` equals to `--report=html`**
|
|
|
|
|
|
2021-11-27 18:47:02 +08:00
|
|
|
### `--minify` and `--no-minify`
|
|
|
|
|
|
|
|
|
|
By default, the file minification is controlled by `config.mjs` and `bundler.mjs`, these flags are added to override that behavior.
|
|
|
|
|
|
|
|
|
|
These should only be used for debugging purposes, suggest to use them together with the `--file` flag.
|
|
|
|
|
|
|
|
|
|
Force minify files:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --file=index.js --minify
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Disable minify files:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --file=parser-babel.js --no-minify
|
|
|
|
|
```
|
2022-01-26 20:33:15 +08:00
|
|
|
|
|
|
|
|
### `--no-babel`
|
|
|
|
|
|
|
|
|
|
Currently, we need babel to transform/shim following new language features:
|
|
|
|
|
|
|
|
|
|
- `Array#flat()` for Node.js 10
|
|
|
|
|
- `Array#flatMap()` for Node.js 10
|
|
|
|
|
- `Object.fromEntries()` for Node.js 10
|
|
|
|
|
|
|
|
|
|
When debugging the build script, we may want skip this step, so the build process can be faster.
|
|
|
|
|
|
|
|
|
|
Playground use this flag to speed up the build too.
|
|
|
|
|
|
|
|
|
|
`--babel` have no effect, don't use.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn build --file=index.js --no-babel
|
|
|
|
|
```
|
