Feat/eslint tests setup (#15)

* feat: add tests config

* chore: add peer deps for tests config

* feat: add examples breaking tests rules

* docs: update README

Author: P0labrD

packages/eslint-plugin/README.md

@@ -2,7 +2,7 @@
 
 This project is an ESLint plugin that gathers all the rules, plugins and parsers that should be used in any new BAM project.
 
-## How to use?
+## How to use the recommended config?
 
 In your app, run
 
@@ -19,6 +19,23 @@ In your `.eslintrc` config file, extend the exported recommended configuration:
 }
 ```
 
+## How to use the config for tests ?
+
+```bash
+yarn add --dev eslint-plugin-jest eslint-plugin-jest-formatting eslint-plugin-testing-library
+```
+
+In your `.eslintrc` config file, extend the exported recommended configuration (don't forget to add the overrides to check only the test files)
+
+```json
+  "overrides": [
+    {
+      "files": ["*.test.tsx"],
+      "extends": "plugin:@bam.tech/tests"
+    }
+  ]
+```
+
 ## How to customize?
 
 You can still customize your ESLint config by adding configurations, plugins and rules to your `.eslintrc` config file.

packages/eslint-plugin/example-app/.eslintrc

@@ -1,3 +1,9 @@
 {
-  "extends": "plugin:@bam.tech/recommended"
+  "extends": "plugin:@bam.tech/recommended",
+  "overrides": [
+    {
+      "files": ["*.test.tsx"],
+      "extends": "plugin:@bam.tech/tests"
+    }
+  ]
 }

packages/eslint-plugin/example-app/break-jest-formatting-rules.test.tsx

@@ -0,0 +1,7 @@
+// This should trigger an error breaking eslint-jest-formatting rule:
+// jest-formatting/padding-around-all
+
+it("a test", () => {
+  const abc = 123;
+  expect(abc).toEqual(123);
+});

packages/eslint-plugin/example-app/break-jest-rules.test.tsx

@@ -0,0 +1,11 @@
+// This should trigger an error breaking eslint-jest rules:
+// jest/valid-title
+// jest/no-identical-title
+
+it("should not fail", () => {
+  expect(1).toBe(1);
+});
+
+it("should not fail", () => {
+  expect(1).toBe(1);
+});

packages/eslint-plugin/example-app/break-testing-library-rules.test.tsx

@@ -0,0 +1,6 @@
+// This should trigger an error breaking eslint-testing-library rule:
+// testing-library/no-await-sync-events
+
+it("a test", () => {
+  await fireEvent();
+});

packages/eslint-plugin/example-app/package.json

@@ -11,10 +11,14 @@
     "@types/react": "^18.2.14",
     "@typescript-eslint/eslint-plugin": "^5.48.0",
     "eslint": "^8.31.0",
+    "eslint-plugin-jest": "^27.2.2",
+    "eslint-plugin-jest-formatting": "^3.1.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.31.11",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-native": "^4.0.0",
+    "eslint-plugin-testing-library": "^5.11.0",
+    "jest": "^29.5.0",
     "prettier": "^2.8.8"
   },
   "private": "true",

packages/eslint-plugin/lib/index.js

@@ -2,9 +2,11 @@
 "use strict";
 
 const recommended = require("./recommended");
+const tests = require("./tests");
 
 module.exports = {
   configs: {
     recommended,
+    tests,
   },
 };

packages/eslint-plugin/lib/tests.js

@@ -0,0 +1,46 @@
+const { defineConfig } = require("eslint-define-config");
+
+module.exports = defineConfig({
+  env: {
+    "jest/globals": true,
+  },
+  plugins: ["jest", "jest-formatting", "testing-library"],
+  rules: {
+    // Setting the recommended rules manually, because we don't want warnings, only errors
+    "jest/no-alias-methods": "error", // STYLE
+    "jest/no-commented-out-tests": "error",
+    "jest/no-conditional-expect": "error",
+    "jest/no-conditional-in-test": "error",
+    "jest/no-deprecated-functions": "error",
+    "jest/no-disabled-tests": "error",
+    "jest/no-done-callback": "error",
+    "jest/no-export": "error",
+    "jest/no-focused-tests": "error",
+    "jest/no-identical-title": "error",
+    "jest/no-mocks-import": "error",
+    "jest/no-standalone-expect": "error",
+    "jest/no-test-prefixes": "error", // STYLE - force it.skip over xtest
+    "jest/no-test-return-statement": "error",
+    "jest/prefer-to-have-length": "error", // STYLE
+    "jest/valid-describe-callback": "error",
+    "jest/valid-expect": "error",
+    "jest/valid-expect-in-promise": "error",
+    "jest/valid-title": ["error", { disallowedWords: ["should"] }], // STYLE
+    "jest-formatting/padding-around-all": "error", // STYLE
+    "testing-library/await-async-query": "error",
+    "testing-library/no-manual-cleanup": "error",
+    "testing-library/no-container": "error",
+    "testing-library/no-await-sync-query": "error",
+    "testing-library/no-await-sync-events": "error",
+    "testing-library/no-debugging-utils": "error",
+    "testing-library/await-async-utils": "error",
+    "testing-library/no-promise-in-fire-event": "error",
+    "testing-library/no-render-in-setup": "error",
+    "testing-library/no-unnecessary-act": "error",
+    "testing-library/no-wait-for-multiple-assertions": "error",
+    "testing-library/prefer-explicit-assert": "error",
+    "testing-library/prefer-presence-queries": "error",
+    "testing-library/no-wait-for-side-effects": "error",
+    "testing-library/prefer-screen-queries": "error",
+  },
+});

packages/eslint-plugin/package.json

@@ -16,10 +16,13 @@
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": ">= 5",
     "eslint": ">= 8",
+    "eslint-plugin-jest": "^27.2.2",
+    "eslint-plugin-jest-formatting": "^3.1.0",
     "eslint-plugin-prettier": ">=4.2.1",
     "eslint-plugin-react": ">=7.31.11",
     "eslint-plugin-react-hooks": ">=4.6.0",
     "eslint-plugin-react-native": ">=4.0.0",
+    "eslint-plugin-testing-library": "^5.11.0",
     "prettier": ">=2.8.8",
     "react": ">=17"
   },