From ef249bfd9704498a8148e66579abc968e42081af Mon Sep 17 00:00:00 2001 From: Chris Fritz Date: Sun, 19 Nov 2017 12:22:23 -0500 Subject: [PATCH] Update example config to use essential rules 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. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cca995804..35eedef23 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,13 @@ Example **.eslintrc.js**: ```js module.exports = { extends: [ - 'eslint:recommended', - 'plugin:vue/recommended' // or 'plugin:vue/base' + // add more generic rulesets here, such as: + // 'eslint:recommended', + 'plugin:vue/essential' ], rules: { - // override/add rules' settings here - 'vue/valid-v-if': 'error' + // override/add rules settings here, such as: + // 'vue/no-unused-vars': 'error' } } ```