Skip to content

Commit 09b8f90

Browse files
chrisvfritzmichalsnik
authored andcommitted
Update example config to use essential rules (#234)
I think the `essential` rules make the most sense as a default implied recommendation, as they're the most universally useful, without anything too opinionated. I also updated the comments slightly and commented out the base config and example rule, so that users blindly copying and pasting don't add anything unnecessary. Without it commented out, some users may also assume that `eslint:recommended` is required for the plugin to work.
1 parent 0f18b3b commit 09b8f90

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,13 @@ Example **.eslintrc.js**:
3434
```js
3535
module.exports = {
3636
extends: [
37-
'eslint:recommended',
38-
'plugin:vue/recommended' // or 'plugin:vue/base'
37+
// add more generic rulesets here, such as:
38+
// 'eslint:recommended',
39+
'plugin:vue/essential'
3940
],
4041
rules: {
41-
// override/add rules' settings here
42-
'vue/valid-v-if': 'error'
42+
// override/add rules settings here, such as:
43+
// 'vue/no-unused-vars': 'error'
4344
}
4445
}
4546
```

0 commit comments

Comments
 (0)