fix: Autogenerate recommended config

Merge pull request #4 from nickmccurdy/autogenerate-recommended-config

Author: benmonro

README.md

@@ -32,11 +32,7 @@ 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": {}
 }
 ```
 

lib/index.js

@@ -17,13 +17,17 @@ let requireIndex = require('requireindex');
 // import all rules in lib/rules
 module.exports.rules = requireIndex(__dirname + '/rules');
 
+module.exports.generateRecommendedConfig = rules => {
+  return Object.entries(rules).reduce(
+    (memo, [name, rule]) =>
+      rule.meta.docs.recommended ? { ...memo, [name]: 'error' } : memo,
+    {}
+  );
+};
+
 module.exports.configs = {
   recommended: {
     plugins: ['jest-dom'],
-    rules: {
-      'jest-dom/prefer-checked': 'error',
-      'jest-dom/prefer-enabled-disabled': 'error',
-      'jest-dom/prefer-required': 'error',
-    },
+    rules: module.exports.generateRecommendedConfig(module.exports.rules),
   },
 };

package.json

@@ -15,7 +15,7 @@
     "generate-readme-table": "node build/generate-readme-table.js"
   },
   "dependencies": {
-    "requireindex": "~1.1.0"
+    "requireindex": "~1.2.0"
   },
   "devDependencies": {
     "eslint": "^6.6.0",
@@ -30,4 +30,4 @@
     "node": ">=0.10.0"
   },
   "license": "ISC"
-}
+}

tests/__snapshots__/index.test.js.snap

@@ -1,3 +1,42 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`should have all the rules 1`] = `Object {}`;
+exports[`should have all the rules 1`] = `
+Object {
+  "prefer-checked": Object {
+    "create": [Function],
+    "meta": Object {
+      "docs": Object {
+        "category": "jest-dom",
+        "description": "prefer toBeChecked over checking attributes",
+        "recommended": true,
+        "url": "prefer-checked",
+      },
+      "fixable": "code",
+    },
+  },
+  "prefer-enabled-disabled": Object {
+    "create": [Function],
+    "meta": Object {
+      "docs": Object {
+        "category": "jest-dom",
+        "description": "prefer toBeDisabled or toBeEnabled over checking attributes",
+        "recommended": true,
+        "url": "prefer-enabled-disabled",
+      },
+      "fixable": "code",
+    },
+  },
+  "prefer-required": Object {
+    "create": [Function],
+    "meta": Object {
+      "docs": Object {
+        "category": "jest-dom",
+        "description": "prefer toBeRequired over checking properties",
+        "recommended": true,
+        "url": "prefer-required",
+      },
+      "fixable": "code",
+    },
+  },
+}
+`;

tests/index.test.js

@@ -1,5 +1,14 @@
-const { rules } = require('../lib/index');
+const { rules, generateRecommendedConfig, configs } = require('../lib/index');
 
 it('should have all the rules', () => {
   expect(rules).toMatchSnapshot();
 });
+
+it('should have a recommended config with recommended rules', () => {
+  expect(
+    generateRecommendedConfig({
+      good: { meta: { docs: { recommended: true } } },
+      bad: { meta: { docs: { recommended: false } } },
+    })
+  ).toEqual({ good: 'error' });
+});