Skip to content

Commit

Permalink
docs: Updated Rsbuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
patricklafrance committed Feb 6, 2025
1 parent c641a10 commit 45ee89b
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 29 deletions.
4 changes: 0 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,6 @@ pnpm build

By default, packages compilation output will be in their respective *dist* directory.

#### Linting errors

If you got linting error, most of the time, they can be fixed automatically using `eslint . --fix`, if not, follow the report provided by `pnpm lint`.

## Commands

From the project root, you have access to many commands the main ones are:
Expand Down
26 changes: 1 addition & 25 deletions docs/rsbuild/configure-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -566,31 +566,7 @@ export const transformer: RsbuildConfigTransformer = (config: RsbuildConfig) =>

## Setup nodemon

[Nodemon](https://nodemon.io/) is a utility that will monitor for any changes in the `rsbuild.dev.ts` file and restart the Rsbuild development server whenever a change occurs.

First, add a `nodemon.json` file at the root of the project:

``` !#8
web-project
├── public
├──── index.html
├── src
├──── ...
├── package.json
├── rsbuild.dev.ts
├── nodemon.json
```

Then, open the `nodemon.json` file and copy/paste the following content:

```json nodemon.json
{
"watch": ["rsbuild.dev.ts"],
"exec": "rsbuild dev --config rsbuild.dev.ts"
}
```

Finally, add a CLI script at the [next step](#add-a-cli-script) of this guide.
A tool such as [Nodemon](https://nodemon.io/) is not required with Rsbuild because the development server is automatically restarted when the configuration file is updated.

## Add a CLI script

Expand Down

0 comments on commit 45ee89b

Please sign in to comment.