3ff21ed178
Continues #39778 Closes #40499 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) Co-authored-by: Tim Neutkens <tim@timneutkens.nl> Co-authored-by: JJ Kasper <jj@jjsweb.site>
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# Linting
|
|
|
|
The Next.js repository runs [ESLint](https://eslint.org), [Prettier](https://prettier.io) and [alex](https://alexjs.com) to lint and format all code and documentation.
|
|
|
|
To lint all code you can run:
|
|
|
|
```sh
|
|
pnpm lint
|
|
```
|
|
|
|
If you get errors, you can run the ESLint and Prettier auto-fix using:
|
|
|
|
```sh
|
|
pnpm lint-fix
|
|
```
|
|
|
|
Not all rules can be auto-fixed, those require manual changes.
|
|
|
|
If you get a warning by alex, follow the instructions to correct the language.
|
|
|
|
## ESLint
|
|
|
|
We recommend installing the [ESLint plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
|
|
|
|
You can find the enabled rules in the [ESLint config](../../.eslintrc.json).
|
|
|
|
## Prettier
|
|
|
|
We recommend installing the [Prettier plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode).
|
|
|
|
You can find the format configuration in the [Prettier config](../../.prettierrc.json).
|
|
|
|
## alex
|
|
|
|
We recommend installing the [AlexJS Linter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=TLahmann.alex-linter)
|
|
|
|
You can find the configuration in the [alex config](../../.alexrc).
|