Skip to content

Commit 168cf66

Browse files
committed
docs: update documentation
1 parent 3825a40 commit 168cf66

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
@@ -187,14 +187,20 @@ You can use the following configs by adding them to `extends`.
187187
- Configurations for using Vue.js 3.x:
188188
- `"plugin:vue/essential"` ... `base`, plus rules to prevent errors or unintended behavior.
189189
- `"plugin:vue/strongly-recommended"` ... Above, plus rules to considerably improve code readability and/or dev experience.
190+
- `"plugin:vue/strongly-recommended-error"` ... Above, except with all rules configured to error instead of warn.
190191
- `"plugin:vue/recommended"` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
192+
- `"plugin:vue/recommended-error"` ... Above, except with all rules configured to error instead of warn.
191193
- Configurations for using Vue.js 2.x:
192194
- `"plugin:vue/vue2-essential"` ... `base`, plus rules to prevent errors or unintended behavior.
193195
- `"plugin:vue/vue2-strongly-recommended"` ... Above, plus rules to considerably improve code readability and/or dev experience.
196+
- `"plugin:vue/vue2-strongly-recommended-error"` ... Above, except with all rules configured to error instead of warn.
194197
- `"plugin:vue/vue2-recommended"` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
198+
- `"plugin:vue/vue2-recommended-error"` ... Above, except with all rules configured to error instead of warn.
195199

196200
:::warning Reporting rules
197201
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).
202+
203+
Alternatively, there are versions of the configs with all rules set to error suffixed with `-error` that you can use.
198204
:::
199205

200206
:::warning Status of Vue.js 3.x supports

0 commit comments

Comments
 (0)