refactor: ♻️ group testing rules into one config object

jimmy-guzman · Apr 8, 2024 · 1c9bd20 · 1c9bd20
1 parent 00fa347
commit 1c9bd20
Show file tree

Hide file tree

Showing 11 changed files with 143 additions and 131 deletions.
diff --git a/README.md b/README.md
@@ -63,20 +63,10 @@ export default jimmyDotCodes({
    */
   imports: true,
   /**
-   * Are Jest rules are enabled?
+   * Are testing rules are enabled?
    * @default false
    */
-  jest: false,
-  /**
-   * Are Vitest rules are enabled?
-   * @default false
-   */
-  vitest: false,
-  /**
-   * Are Testing Library rules are enabled?
-   * @default false
-   */
-  testingLibrary: false,
+  testing: false,
 });
 ```
 
@@ -95,6 +85,22 @@ export default jimmyDotCodes({
 });
 ```
 
+#### Testing
+
+By default [vitest](https://vitest.dev) is used as the testing framework but you can override and add some utilities:
+
+```js
+// eslint.config.mjs
+import jimmyDotCodes from "@jimmy.codes/eslint-config";
+
+export default jimmyDotCodes({
+  testing: {
+    framework: "jest",
+    utilities: ["testing-library"],
+  },
+});
+```
+
 #### Overrides
 
 Or if you want to extend or override the configuration:

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -11,9 +11,10 @@ const jimmyDotCodes = jiti("./src").default;
 
 export default jimmyDotCodes({
   typescript: true,
-  vitest: true,
   react: true,
-  testingLibrary: true,
+  testing: {
+    utilities: ["testing-library"],
+  },
   overrides: [
     {
       ignores: ["fixtures"],

diff --git a/src/__snapshots__/factory.spec.ts.snap b/src/__snapshots__/factory.spec.ts.snap
@@ -8191,7 +8191,7 @@ exports[`jimmyDotCodes > should create configuration w/ jest & react & testing l
         "xtest": false,
       },
     },
-    "name": "jimmy.codes/jest",
+    "name": "jimmy.codes/testing",
     "plugins": {
       "jest": {
         "configs": {
@@ -9802,7 +9802,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/e2e/**/*.spec.?([cm])[jt]s?(x)",
       "**/e2e/**/*.test.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/jest/disabled",
+    "name": "jimmy.codes/testing/disabled",
     "rules": {
       "jest/require-hook": "off",
     },
@@ -9815,7 +9815,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/*.bench.?([cm])[jt]s?(x)",
       "**/*.benchmark.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/testing-library",
+    "name": "jimmy.codes/testing/testing-library",
     "plugins": {
       "jest-dom": {
         "configs": {
@@ -11801,7 +11801,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/e2e/**/*.spec.?([cm])[jt]s?(x)",
       "**/e2e/**/*.test.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/testing-library/disabled",
+    "name": "jimmy.codes/testing/testing-library/disabled",
     "rules": {
       "testing-library/prefer-screen-queries": "off",
     },
@@ -13991,7 +13991,7 @@ exports[`jimmyDotCodes > should create configuration w/ jest 1`] = `
         "xtest": false,
       },
     },
-    "name": "jimmy.codes/jest",
+    "name": "jimmy.codes/testing",
     "plugins": {
       "jest": {
         "configs": {
@@ -15602,7 +15602,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/e2e/**/*.spec.?([cm])[jt]s?(x)",
       "**/e2e/**/*.test.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/jest/disabled",
+    "name": "jimmy.codes/testing/disabled",
     "rules": {
       "jest/require-hook": "off",
     },
@@ -55807,7 +55807,7 @@ exports[`jimmyDotCodes > should create configuration w/ vitest & react & testing
         "xtest": false,
       },
     },
-    "name": "jimmy.codes/vitest",
+    "name": "jimmy.codes/testing",
     "plugins": {
       "jest": {
         "configs": {
@@ -57418,7 +57418,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/e2e/**/*.spec.?([cm])[jt]s?(x)",
       "**/e2e/**/*.test.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/vitest/disabled",
+    "name": "jimmy.codes/testing/disabled",
     "rules": {
       "jest/require-hook": "off",
     },
@@ -57431,7 +57431,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/*.bench.?([cm])[jt]s?(x)",
       "**/*.benchmark.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/testing-library",
+    "name": "jimmy.codes/testing/testing-library",
     "plugins": {
       "jest-dom": {
         "configs": {
@@ -59417,7 +59417,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/e2e/**/*.spec.?([cm])[jt]s?(x)",
       "**/e2e/**/*.test.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/testing-library/disabled",
+    "name": "jimmy.codes/testing/testing-library/disabled",
     "rules": {
       "testing-library/prefer-screen-queries": "off",
     },
@@ -61607,7 +61607,7 @@ exports[`jimmyDotCodes > should create configuration w/ vitest 1`] = `
         "xtest": false,
       },
     },
-    "name": "jimmy.codes/vitest",
+    "name": "jimmy.codes/testing",
     "plugins": {
       "jest": {
         "configs": {
@@ -63218,7 +63218,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
       "**/e2e/**/*.spec.?([cm])[jt]s?(x)",
       "**/e2e/**/*.test.?([cm])[jt]s?(x)",
     ],
-    "name": "jimmy.codes/vitest/disabled",
+    "name": "jimmy.codes/testing/disabled",
     "rules": {
       "jest/require-hook": "off",
     },

diff --git a/src/configs/jest.ts b/src/configs/jest.ts
diff --git a/src/configs/testing-library.ts b/src/configs/testing-library.ts
@@ -6,7 +6,7 @@ import { GLOB_E2E, GLOB_TESTS } from "../constants";
 const testingLibraryConfig = () => {
   return [
     {
-      name: "jimmy.codes/testing-library",
+      name: "jimmy.codes/testing/testing-library",
       files: GLOB_TESTS,
       plugins: {
         "testing-library": testingLibrary,
@@ -18,7 +18,7 @@ const testingLibraryConfig = () => {
       },
     },
     {
-      name: "jimmy.codes/testing-library/disabled",
+      name: "jimmy.codes/testing/testing-library/disabled",
       files: GLOB_E2E,
       rules: {
         "testing-library/prefer-screen-queries": "off",

diff --git a/src/configs/vitest.ts → src/configs/testing.ts b/src/configs/vitest.ts → src/configs/testing.ts
@@ -2,36 +2,31 @@ import jest from "eslint-plugin-jest";
 
 import { GLOB_E2E, GLOB_TESTS } from "../constants";
 import { jestRules } from "../rules/jest";
+import { type TestingOptions } from "../types";
 import testingLibraryConfig from "./testing-library";
 
-interface VitestConfigOptions {
-  testingLibrary?: boolean;
-  react?: boolean;
-}
-
-const vitestConfig = ({
-  testingLibrary = false,
-  react = false,
-}: VitestConfigOptions = {}) => {
+const testingConfig = ({ framework = "vitest", utilities }: TestingOptions) => {
   return [
     {
-      name: "jimmy.codes/vitest",
+      name: "jimmy.codes/testing",
       files: GLOB_TESTS,
       ...jest.configs["flat/recommended"],
       rules: {
         ...jestRules,
-        "jest/no-deprecated-functions": "off",
+        ...(framework === "vitest" && {
+          "jest/no-deprecated-functions": "off",
+        }),
       },
     },
     {
-      name: "jimmy.codes/vitest/disabled",
+      name: "jimmy.codes/testing/disabled",
       files: GLOB_E2E,
       rules: {
         "jest/require-hook": "off",
       },
     },
-    ...(testingLibrary && react ? testingLibraryConfig() : []),
+    ...(utilities?.includes("testing-library") ? testingLibraryConfig() : []),
   ];
 };
 
-export default vitestConfig;
+export default testingConfig;
diff --git a/src/factory.spec.ts b/src/factory.spec.ts
@@ -20,22 +20,28 @@ describe("jimmyDotCodes", () => {
   });
 
   it("should create configuration w/ jest", () => {
-    expect(jimmyDotCodes({ jest: true })).toMatchSnapshot();
+    expect(jimmyDotCodes({ testing: { framework: "jest" } })).toMatchSnapshot();
   });
 
   it("should create configuration w/ vitest", () => {
-    expect(jimmyDotCodes({ vitest: true })).toMatchSnapshot();
+    expect(jimmyDotCodes({ testing: true })).toMatchSnapshot();
   });
 
   it("should create configuration w/ jest & react & testing library", () => {
     expect(
-      jimmyDotCodes({ jest: true, react: true, testingLibrary: true }),
+      jimmyDotCodes({
+        react: true,
+        testing: { framework: "jest", utilities: ["testing-library"] },
+      }),
     ).toMatchSnapshot();
   });
 
   it("should create configuration w/ vitest & react & testing library", () => {
     expect(
-      jimmyDotCodes({ vitest: true, react: true, testingLibrary: true }),
+      jimmyDotCodes({
+        react: true,
+        testing: { utilities: ["testing-library"] },
+      }),
     ).toMatchSnapshot();
   });
 });
diff --git a/src/factory.ts b/src/factory.ts
@@ -1,70 +1,27 @@
-import { type Linter } from "eslint";
 import eslintConfigPrettier from "eslint-config-prettier";
 
 import importsConfig from "./configs/imports";
-import jestConfig from "./configs/jest";
 import reactConfig from "./configs/react";
+import testingConfig from "./configs/testing";
 import typescriptConfig from "./configs/typescript";
-import vitestConfig from "./configs/vitest";
 import { GLOB_IGNORES } from "./constants";
 import { baseRules } from "./rules/base";
-import { type TypescriptOptions } from "./types";
-import { getTypescriptOptions } from "./utils";
-
-interface Options {
-  /**
-   * Are TypeScript rules are enabled?
-   * @default false
-   */
-  typescript?: boolean | TypescriptOptions;
-  /**
-   * Are React rules are enabled?
-   * @default false
-   */
-  react?: boolean;
-  /**
-   * Are imports rules are enabled?
-   * @default true
-   */
-  imports?: boolean;
-  /**
-   * Are Jest rules are enabled?
-   * @default false
-   */
-  jest?: boolean;
-  /**
-   * Are Vitest rules are enabled?
-   * @default false
-   */
-  vitest?: boolean;
-  /**
-   * Are Testing Library rules are enabled?
-   * @default false
-   */
-  testingLibrary?: boolean;
-  /**
-   * Additional flat configs to either extend or overrides configurations
-   * @default []
-   */
-  overrides?: Linter.FlatConfig[];
-}
+import { type Options } from "./types";
+import { getTestingOptions, getTypescriptOptions } from "./utils";
 
 export const jimmyDotCodes = ({
   typescript = false,
   react = false,
   imports = true,
-  jest = false,
-  vitest = false,
-  testingLibrary = false,
+  testing = false,
   overrides = [],
 }: Options = {}) => {
   return [
     { name: "jimmy.codes/base", rules: baseRules },
     ...(imports ? importsConfig({ typescript }) : []),
     ...(typescript ? typescriptConfig(getTypescriptOptions(typescript)) : []),
     ...(react ? reactConfig() : []),
-    ...(jest ? jestConfig({ testingLibrary, react }) : []),
-    ...(vitest ? vitestConfig({ testingLibrary, react }) : []),
+    ...(testing ? testingConfig(getTestingOptions(testing)) : []),
     { name: "jimmy.codes/disabled", ...eslintConfigPrettier },
     {
       ignores: GLOB_IGNORES,