feat: Merge pull request #3 from nickmccurdy/add-recommended-config

Add recommended config

Author: benmonro

README.md

@@ -24,22 +24,34 @@ Add `jest-dom` to the plugins section of your `.eslintrc` configuration file. Yo
 
 ```json
 {
-    "plugins": [
-        "jest-dom"
-    ]
+  "plugins": ["jest-dom"]
 }
 ```
 
-
 Then configure the rules you want to use under the rules section.
 
 ```json
 {
-    "rules": {
-        "jest-dom/prefer-checked": "error",
-        "jest-dom/prefer-enabled-disabled": "error",
-        "jest-dom/prefer-required": "error"
-    }
+  "rules": {
+    "jest-dom/prefer-checked": "error",
+    "jest-dom/prefer-enabled-disabled": "error",
+    "jest-dom/prefer-required": "error"
+  }
+}
+```
+
+## Recommended Configuration
+
+This plugin exports a recommended configuration that enforces good
+`jest-dom` practices _(you can find more info about enabled rules
+in [Supported Rules section](#supported-rules))_.
+
+To enable this configuration use the `extends` property in your
+`.eslintrc` config file:
+
+```json
+{
+  "extends": ["plugin:jest-dom/recommended"]
 }
 ```
 
@@ -50,14 +62,11 @@ Then configure the rules you want to use under the rules section.
 🛠 indicates that a rule is fixable.
 
 <!-- __BEGIN AUTOGENERATED TABLE__ -->
-Name | ✔️ | 🛠 | Description
------ | ----- | ----- | -----
-[prefer-checked](https://github.com/testing-library/eslint-plugin-jest-dom/blob/master/docs/rules/prefer-checked.md) | ✔️ | 🛠 | prefer toBeChecked over checking attributes
-[prefer-enabled-disabled](https://github.com/testing-library/eslint-plugin-jest-dom/blob/master/docs/rules/prefer-enabled-disabled.md) | ✔️ | 🛠 | prefer toBeDisabled or toBeEnabled over checking attributes
-[prefer-required](https://github.com/testing-library/eslint-plugin-jest-dom/blob/master/docs/rules/prefer-required.md) | ✔️ | 🛠 | prefer toBeRequired over checking properties
-<!-- __END AUTOGENERATED TABLE__ -->
-
-
-
 
+| Name                                                                                                                                   | ✔️  | 🛠   | Description                                                 |
+| -------------------------------------------------------------------------------------------------------------------------------------- | --- | --- | ----------------------------------------------------------- |
+| [prefer-checked](https://github.com/testing-library/eslint-plugin-jest-dom/blob/master/docs/rules/prefer-checked.md)                   | ✔️  | 🛠   | prefer toBeChecked over checking attributes                 |
+| [prefer-enabled-disabled](https://github.com/testing-library/eslint-plugin-jest-dom/blob/master/docs/rules/prefer-enabled-disabled.md) | ✔️  | 🛠   | prefer toBeDisabled or toBeEnabled over checking attributes |
+| [prefer-required](https://github.com/testing-library/eslint-plugin-jest-dom/blob/master/docs/rules/prefer-required.md)                 | ✔️  | 🛠   | prefer toBeRequired over checking properties                |
 
+<!-- __END AUTOGENERATED TABLE__ -->

lib/index.js

@@ -16,3 +16,14 @@ let requireIndex = require('requireindex');
 
 // import all rules in lib/rules
 module.exports.rules = requireIndex(__dirname + '/rules');
+
+module.exports.configs = {
+  recommended: {
+    plugins: ['jest-dom'],
+    rules: {
+      'jest-dom/prefer-checked': 'error',
+      'jest-dom/prefer-enabled-disabled': 'error',
+      'jest-dom/prefer-required': 'error',
+    },
+  },
+};