feat: add shareable framework configs (#7)

Belco90 · web-flow · commit 022368a3d492 · 2019-09-22T21:00:58.000+02:00
* Setup eslint plugins for jest * Add snapshot test for recommended config * Revert unnecessary eslint env * Add configs for angular, react and vue * Add frameworks column to Supported Rules table * Fix framework logos links * Add category section within Shareable configurations section * Edit headers * Simplify configs tests cases with each util * feat: add commitlint and commit-msg hook (#8) * feat: add commitlint and commit-msg hook (#8) * Setup eslint plugins for jest * build: merge package-lock * Setup eslint plugins for jest * Add snapshot test for recommended config * Revert unnecessary eslint env * Add configs for angular, react and vue * Add frameworks column to Supported Rules table * Fix framework logos links * Add category section within Shareable configurations section * Edit headers * Simplify configs tests cases with each util * Setup eslint plugins for jest * build: merge package-lock
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,14 +2,19 @@
   "env": {
     "commonjs": true,
     "es6": true,
-    "node": true
+    "node": true,
+    "jest/globals": true
   },
   "extends": [
     "standard",
-    "prettier"
+    "prettier",
+    "plugin:jest/recommended",
+    "plugin:jest-formatting/recommended"
   ],
   "plugins": [
-    "prettier"
+    "prettier",
+    "jest",
+    "jest-formatting"
   ],
   "globals": {
     "Atomics": "readonly",
diff --git a/README.md b/README.md
@@ -40,8 +40,9 @@ Then configure the rules you want to use under the rules section.
 ```json
 {
   "rules": {
-    "testing-library/await-async-query": "warn",
-    "testing-library/no-await-sync-query": "error"
+    "testing-library/await-async-query": "error",
+    "testing-library/no-await-sync-query": "error",
+    "testing-library/no-debug": "warn"
   }
 }
 ```
@@ -50,22 +51,77 @@ Then configure the rules you want to use under the rules section.
 
 ### Recommended
 
-This plugin exports a recommended configuration that enforces good Testing Library practices.
+This plugin exports a recommended configuration that enforces good
+Testing Library practices _(you can find more info about enabled rules
+in [Supported Rules section](#supported-rules) within Recommended
+column)_.
 
-To enable this configuration use the `extends` property in your `.eslintrc` config file:
+To enable this configuration use the `extends` property in your
+`.eslintrc` config file:
 
 ```json
 {
   "extends": ["plugin:testing-library/recommended"]
 }
 ```
 
+### Frameworks
+
+Starting from the premise that
+[DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
+is the base for the rest of Testing Library frameworks wrappers, this
+plugin also exports different configuration for those frameworks that
+enforces good practices for specific rules that only apply to them _(you
+can find more info about enabled rules in
+[Supported Rules section](#supported-rules) within Frameworks column)_.
+
+**Note that frameworks configurations enable their specific rules +
+recommended rules.**
+
+Available frameworks configurations are:
+
+#### Angular
+
+To enable this configuration use the `extends` property in your
+`.eslintrc` config file:
+
+```json
+{
+  "extends": ["plugin:testing-library/angular"]
+}
+```
+
+#### React
+
+To enable this configuration use the `extends` property in your
+`.eslintrc` config file:
+
+```json
+{
+  "extends": ["plugin:testing-library/react"]
+}
+```
+
+#### Vue
+
+To enable this configuration use the `extends` property in your
+`.eslintrc` config file:
+
+```json
+{
+  "extends": ["plugin:testing-library/vue"]
+}
+```
+
 ## Supported Rules
 
-| Rule                                                     | Description                                   | Recommended      |
-| -------------------------------------------------------- | --------------------------------------------- | ---------------- |
-| [await-async-query](docs/rules/await-async-query.md)     | Enforce async queries to have proper `await`  | ![recommended][] |
-| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended][] |
-| [no-debug](docs/rules/no-debug.md)                       | Disallow the use of `debug`                   |                  |
+| Rule                                                     | Description                                   | Recommended      | Frameworks                       |
+| -------------------------------------------------------- | --------------------------------------------- | ---------------- | -------------------------------- |
+| [await-async-query](docs/rules/await-async-query.md)     | Enforce async queries to have proper `await`  | ![recommended][] |                                  |
+| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended][] |                                  |
+| [no-debug](docs/rules/no-debug.md)                       | Disallow the use of `debug`                   |                  | ![angular][] ![react][] ![vue][] |
 
 [recommended]: https://img.shields.io/badge/recommended-lightgrey?style=flat-square
+[angular]: https://img.shields.io/badge/-Angular-black?style=flat-square&logo=angular&logoColor=white&labelColor=DD0031&color=black
+[react]: https://img.shields.io/badge/-React-black?style=flat-square&logo=react&logoColor=white&labelColor=61DAFB&color=black
+[vue]: https://img.shields.io/badge/-Vue-black?style=flat-square&logo=vue.js&logoColor=white&labelColor=4FC08D&color=black
diff --git a/lib/index.js b/lib/index.js
@@ -5,15 +5,29 @@ const rules = {
   'no-await-sync-query': require('./rules/no-await-sync-query'),
 };
 
+const recommendedRules = {
+  'testing-library/await-async-query': 'error',
+  'testing-library/no-await-sync-query': 'error',
+};
+
 module.exports = {
   rules,
   configs: {
     recommended: {
       plugins: ['testing-library'],
-      rules: {
-        'testing-library/await-async-query': 'error',
-        'testing-library/no-await-sync-query': 'error',
-      },
+      rules: recommendedRules,
+    },
+    angular: {
+      plugins: ['testing-library'],
+      rules: { ...recommendedRules, 'testing-library/no-debug': 'warn' },
+    },
+    react: {
+      plugins: ['testing-library'],
+      rules: { ...recommendedRules, 'testing-library/no-debug': 'warn' },
+    },
+    vue: {
+      plugins: ['testing-library'],
+      rules: { ...recommendedRules, 'testing-library/no-debug': 'warn' },
     },
   },
 };
diff --git a/lib/rules/await-async-query.js b/lib/rules/await-async-query.js
@@ -97,11 +97,11 @@ function isPromiseResolved(node) {
   return hasAThenProperty(parent);
 }
 
-function findParent(node, test) {
-  if (test(node)) {
+function findParent(node, check) {
+  if (check(node)) {
     return node;
   } else if (node.parent) {
-    return findParent(node.parent, test);
+    return findParent(node.parent, check);
   }
   return null;
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -35,6 +35,8 @@
     "eslint-config-prettier": "^6.1.0",
     "eslint-config-standard": "^14.1.0",
     "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jest": "^22.17.0",
+    "eslint-plugin-jest-formatting": "^1.1.0",
     "eslint-plugin-node": "^9.2.0",
     "eslint-plugin-prettier": "^3.1.0",
     "eslint-plugin-promise": "^4.2.1",
diff --git a/tests/__snapshots__/index.js.snap b/tests/__snapshots__/index.js.snap
@@ -0,0 +1,52 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`shareable configs should export proper "angular" config 1`] = `
+Object {
+  "plugins": Array [
+    "testing-library",
+  ],
+  "rules": Object {
+    "testing-library/await-async-query": "error",
+    "testing-library/no-await-sync-query": "error",
+    "testing-library/no-debug": "warn",
+  },
+}
+`;
+
+exports[`shareable configs should export proper "react" config 1`] = `
+Object {
+  "plugins": Array [
+    "testing-library",
+  ],
+  "rules": Object {
+    "testing-library/await-async-query": "error",
+    "testing-library/no-await-sync-query": "error",
+    "testing-library/no-debug": "warn",
+  },
+}
+`;
+
+exports[`shareable configs should export proper "recommended" config 1`] = `
+Object {
+  "plugins": Array [
+    "testing-library",
+  ],
+  "rules": Object {
+    "testing-library/await-async-query": "error",
+    "testing-library/no-await-sync-query": "error",
+  },
+}
+`;
+
+exports[`shareable configs should export proper "vue" config 1`] = `
+Object {
+  "plugins": Array [
+    "testing-library",
+  ],
+  "rules": Object {
+    "testing-library/await-async-query": "error",
+    "testing-library/no-await-sync-query": "error",
+    "testing-library/no-debug": "warn",
+  },
+}
+`;
diff --git a/tests/index.js b/tests/index.js
@@ -0,0 +1,12 @@
+'use strict';
+
+const { configs } = require('../lib');
+
+describe('shareable configs', () => {
+  it.each(['recommended', 'angular', 'react', 'vue'])(
+    'should export proper "%s" config',
+    configName => {
+      expect(configs[configName]).toMatchSnapshot();
+    }
+  );
+});

Original file line number	Diff line number	Diff line change
`@@ -97,11 +97,11 @@ function isPromiseResolved(node) {`
`97`	`97`	`return hasAThenProperty(parent);`
`98`	`98`	`}`
`99`	`99`
`100`		`-function findParent(node, test) {`
`101`		`- if (test(node)) {`
	`100`	`+function findParent(node, check) {`
	`101`	`+ if (check(node)) {`
`102`	`102`	`return node;`
`103`	`103`	`} else if (node.parent) {`
`104`		`- return findParent(node.parent, test);`
	`104`	`+ return findParent(node.parent, check);`
`105`	`105`	`}`
`106`	`106`	`return null;`
`107`	`107`	`}`