You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/index.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,26 @@ export default [
47
47
48
48
See [the rule list](../rules/index.md) to get the `configs` & `rules` that this plugin provides.
49
49
50
+
#### Bundle Configurations (`eslint.config.js`)
51
+
52
+
This plugin provides some predefined configs.
53
+
You can use the following configs by adding them to `eslint.config.js`.
54
+
(All flat configs in this plugin are provided as arrays, so spread syntax is required when combining them with other configs.)
55
+
56
+
-`*.configs["flat/base"]` ... Settings and rules to enable correct ESLint parsing.
57
+
- Configurations for using Vue.js 3.x:
58
+
-`*.configs["flat/essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
59
+
-`*.configs["flat/strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
60
+
-`*.configs["flat/recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
61
+
- Configurations for using Vue.js 2.x:
62
+
-`*.configs["flat/vue2-essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
63
+
-`*.configs["flat/vue2-strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
64
+
-`*.configs["flat/vue2-recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency
65
+
66
+
:::warning Reporting rules
67
+
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).
68
+
:::
69
+
50
70
#### Example configuration with [typescript-eslint](https://typescript-eslint.io/) and [Prettier](https://prettier.io/)
You can use the following configs by adding them to `eslint.config.js`.
92
-
(All flat configs in this plugin are provided as arrays, so spread syntax is required when combining them with other configs.)
93
-
94
-
-`*.configs["flat/base"]` ... Settings and rules to enable correct ESLint parsing.
95
-
- Configurations for using Vue.js 3.x:
96
-
-`*.configs["flat/essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
97
-
-`*.configs["flat/strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
98
-
-`*.configs["flat/recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency.
99
-
- Configurations for using Vue.js 2.x:
100
-
-`*.configs["flat/vue2-essential"]` ... `base`, plus rules to prevent errors or unintended behavior.
101
-
-`*.configs["flat/vue2-strongly-recommended"]` ... Above, plus rules to considerably improve code readability and/or dev experience.
102
-
-`*.configs["flat/vue2-recommended"]` ... Above, plus rules to enforce subjective community defaults to ensure consistency
103
-
104
-
:::warning Reporting rules
105
-
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).
106
-
:::
107
-
108
108
### Configuration (`.eslintrc`)
109
109
110
110
Use `.eslintrc.*` file to configure rules in ESLint < v9. See also: <https://eslint.org/docs/latest/use/configure/>.
0 commit comments