Skip to content

Commit 3e9fb11

Browse files
committed
docs: update section about flat config
1 parent 9c56a40 commit 3e9fb11

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/user-guide/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,20 @@ You can use the following configs by adding them to `eslint.config.js`.
6565
- Configurations for using Vue.js 3.x:
6666
- `*.configs["flat/essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
6767
- `*.configs["flat/strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
68+
- `*.configs["flat/strongly-recommended-error"]` ... Above, except with all rules configured to error instead of warn.
6869
- `*.configs["flat/recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
70+
- `*.configs["flat/recommended-error"]` ... Above, except with all rules configured to error instead of warn.
6971
- Configurations for using Vue.js 2.x:
7072
- `*.configs["flat/vue2-essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
7173
- `*.configs["flat/vue2-strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
74+
- `*.configs["flat/vue2-strongly-recommended-error"]` ... Above, except with all rules configured to error instead of warn.
7275
- `*.configs["flat/vue2-recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency
76+
- `*.configs["flat/vue2-recommended-error"]` ... Above, except with all rules configured to error instead of warn.
7377

7478
:::warning Reporting rules
7579
By default, all rules from **base** and **essential** categories report ESLint errors. Other rules - because they're not covering potential bugs in the application - report warnings. What does it mean? By default - nothing, but if you want - you can set up a threshold and break the build after a certain amount of warnings, instead of any. More information [here](https://eslint.org/docs/user-guide/command-line-interface#handling-warnings).
80+
81+
Alternatively, there are versions of the configs with all rules set to error suffixed with `-error` that you can use.
7682
:::
7783

7884
#### Specifying Globals (`eslint.config.js`)

0 commit comments

Comments
 (0)