Skip to content

Commit 056ba16

Browse files
authored
Clarify config docs wording
1 parent 29be2c9 commit 056ba16

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/user-guide/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ You can use the following configs by adding them to `eslint.config.js`.
6464
- `*.configs["flat/base"]` ... Settings and rules to enable correct ESLint parsing.
6565
- Configurations for using Vue.js 3.x:
6666
- `*.configs["flat/essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
67-
- `*.configs["flat/strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
68-
- `*.configs["flat/strongly-recommended-error"]` ... Same as strongly-recommended, except with all rules in this category configured to error instead of warn.
69-
- `*.configs["flat/recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
70-
- `*.configs["flat/recommended-error"]` ... Same as recommended, except with all rules in this category configured to error instead of warn.
67+
- `*.configs["flat/strongly-recommended"]` ... `essential`, plus rules to considerably improve code readability and/or dev experience.
68+
- `*.configs["flat/strongly-recommended-error"]` ... Same as `strongly-recommended`, except with all rules to error instead of warn.
69+
- `*.configs["flat/recommended"]` ... `strongly-recommended`, plus rules to enforce subjective community defaults to ensure consistency.
70+
- `*.configs["flat/recommended-error"]` ... Same as `recommended`, except with all rules configured to error instead of warn.
7171
- Configurations for using Vue.js 2.x:
7272
- `*.configs["flat/vue2-essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
73-
- `*.configs["flat/vue2-strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
74-
- `*.configs["flat/vue2-strongly-recommended-error"]` ... Same as vue2-strongly-recommended, except with all rules in this category configured to error instead of warn.
75-
- `*.configs["flat/vue2-recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
76-
- `*.configs["flat/vue2-recommended-error"]` ... Same as vue2-recommended, except with all rules in this category configured to error instead of warn.
73+
- `*.configs["flat/vue2-strongly-recommended"]` ... `vue2-essential`, plus rules to considerably improve code readability and/or dev experience.
74+
- `*.configs["flat/vue2-strongly-recommended-error"]` ... Same as `vue2-strongly-recommended`, except with all rules configured to error instead of warn.
75+
- `*.configs["flat/vue2-recommended"]` ... `vue2-strongly-recommended`, plus rules to enforce subjective community defaults to ensure consistency.
76+
- `*.configs["flat/vue2-recommended-error"]` ... Same as `vue2-recommended`, except with all rules configured to error instead of warn.
7777

7878
:::warning Reporting rules
7979
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).
@@ -192,16 +192,16 @@ You can use the following configs by adding them to `extends`.
192192
- `"plugin:vue/base"` ... Settings and rules to enable correct ESLint parsing.
193193
- Configurations for using Vue.js 3.x:
194194
- `"plugin:vue/essential"` ... `base`, plus rules to prevent errors or unintended behavior.
195-
- `"plugin:vue/strongly-recommended"` ... Above, plus rules to considerably improve code readability and/or dev experience.
196-
- `"plugin:vue/strongly-recommended-error"` ... Same as strongly-recommended, except with all rules in this category configured to error instead of warn.
197-
- `"plugin:vue/recommended"` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
198-
- `"plugin:vue/recommended-error"` ... Same as recommended, except with all rules in this category configured to error instead of warn.
195+
- `"plugin:vue/strongly-recommended"` ... `essential`, plus rules to considerably improve code readability and/or dev experience.
196+
- `"plugin:vue/strongly-recommended-error"` ... Same as `strongly-recommended`, except with all rules configured to error instead of warn.
197+
- `"plugin:vue/recommended"` ... `strongly-recommended`, plus rules to enforce subjective community defaults to ensure consistency.
198+
- `"plugin:vue/recommended-error"` ... Same as `recommended`, except with all rules configured to error instead of warn.
199199
- Configurations for using Vue.js 2.x:
200200
- `"plugin:vue/vue2-essential"` ... `base`, plus rules to prevent errors or unintended behavior.
201-
- `"plugin:vue/vue2-strongly-recommended"` ... Above, plus rules to considerably improve code readability and/or dev experience.
202-
- `"plugin:vue/vue2-strongly-recommended-error"` ... Same as vue2-strongly-recommended, except with all rules in this category configured to error instead of warn.
203-
- `"plugin:vue/vue2-recommended"` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
204-
- `"plugin:vue/vue2-recommended-error"` ... Same as vue2-recommended, except with all rules in this category configured to error instead of warn.
201+
- `"plugin:vue/vue2-strongly-recommended"` ... `vue2-essential`, plus rules to considerably improve code readability and/or dev experience.
202+
- `"plugin:vue/vue2-strongly-recommended-error"` ... Same as `vue2-strongly-recommended`, except with all rules configured to error instead of warn.
203+
- `"plugin:vue/vue2-recommended"` ... `vue2-strongly-recommended`, plus rules to enforce subjective community defaults to ensure consistency.
204+
- `"plugin:vue/vue2-recommended-error"` ... Same as `vue2-recommended`, except with all rules configured to error instead of warn.
205205

206206
:::warning Reporting rules
207207
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).

0 commit comments

Comments
 (0)