Enhancement: Add "recommended" config which auto-adds plugins and a…

…ll current rules (one as a warning)
Turbo87 · Oct 24, 2019 · c70d8a7 · c70d8a7
1 parent 8681162
commit c70d8a7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,14 @@ Enable the rules that you would like to use:
 }
 ```
 
+Or, if you just want the above defaults, you can avoid all of the above
+and just extend the config:
+
+```json
+{
+  "extends": ["plugin:chai-expect/recommended"]
+}
+```
 
 ## Rules
 

diff --git a/index.js b/index.js
@@ -1,6 +1,16 @@
 'use strict';
 
 module.exports = {
+  configs: {
+    recommended: {
+      plugins: ['chai-expect'],
+      rules: {
+        'chai-expect/no-inner-compare': 'warn',
+        'chai-expect/missing-assertion': 'error',
+        'chai-expect/terminating-properties': 'error'
+      }
+    }
+  },
   rules: {
     'no-inner-compare': require('./lib/rules/no-inner-compare'),
     'missing-assertion': require('./lib/rules/missing-assertion'),