Skip to content

Commit

Permalink
docs: improve wording
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Apr 15, 2024
1 parent c3c5b1c commit 6cce480
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/content/1.packages/0.module.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ All-in-one ESLint integration for Nuxt. It generates a project-aware [ESLint fla

:::callout{icon="i-ph-lightbulb-duotone"}
This module is designed for the [new ESLint flat config format](https://eslint.org/docs/latest/use/configure/configuration-files-new) with is the [default format since ESLint v9](https://eslint.org/blog/2024/04/eslint-v9.0.0-released/). Flat config is supported since ESLint v8.45.0 so you can use any version of ESLint later than that. We recommend you to use the latest version of ESLint to get the best experience.

<br><br>
The legacy `.eslintrc` config is **not supported** by this module. We highly recommand you to migrate over the flat config to be future-proof. If you still want to use the legacy format, you might need to manually config with [`@nuxt/eslint-config`](/packages/config), which will missing some features like project-aware settings tho.
:::

Expand All @@ -21,18 +21,21 @@ Source code on GitHub

## Features

- [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), future-proof.
- [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), composable, customizable and future-proof.
- Project-aware Nuxt-specific settings, also supports [layers](https://nuxt.com/docs/getting-started/layers).
- [Nuxt DevTools](https://github.com/nuxt/devtools) integration powered by [`@eslint/config-inspector`](https://github.com/eslint/config-inspector).
- Extensible with other modules.
- Optional [dev server checker](#dev-server-checker) integration.

## Quick Setup

```bash
Run the following command to add the `@nuxt/eslint` module to your project:

```bash [Terminal]
npx nuxi module add eslint
```

Then start your Nuxt app, a `eslint.config.mjs` file will be generated under your project root. You can customize it as needed.
Start your Nuxt app, a `eslint.config.mjs` file will be generated under your project root. You can customize it as needed.

### Manual Setup

Expand Down

0 comments on commit 6cce480

Please sign in to comment.