feat: ✨ use @vitest/eslint-plugin for vitest

jimmy-guzman · Nov 5, 2024 · 023b2dc · 023b2dc
1 parent e644b68
commit 023b2dc
Show file tree

Hide file tree

Showing 8 changed files with 559 additions and 64 deletions.
diff --git a/package.json b/package.json
@@ -53,6 +53,7 @@
     "@types/eslint": "9.6.1",
     "@typescript-eslint/parser": "^8.13.0",
     "@typescript-eslint/utils": "^8.13.0",
+    "@vitest/eslint-plugin": "^1.1.7",
     "astro-eslint-parser": "^1.0.3",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.3",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/typegen.ts b/scripts/typegen.ts
@@ -15,7 +15,12 @@ const ruleDts = await flatConfigsToRulesDTS(
       },
     },
     // @ts-expect-error TODO: config types don't seem to match
-    ...config(),
+    ...config({
+      testing: {
+        // TODO: remove when framework approach is removed
+        framework: "jest",
+      },
+    }),
   ],
   {
     includeAugmentation: false,

diff --git a/src/configs/testing.spec.ts b/src/configs/testing.spec.ts
diff --git a/src/configs/testing.ts b/src/configs/testing.ts
@@ -1,10 +1,12 @@
+import vitest from "@vitest/eslint-plugin";
 import jest from "eslint-plugin-jest";
 
 import type { Rules, TestingOptions } from "../types";
 
-import { ALLOWED_VITEST_FUNCS, GLOB_E2E, GLOB_TESTS } from "../constants";
+import { GLOB_E2E, GLOB_TESTS } from "../constants";
 import { hasJest, hasTestingLibrary, hasVitest } from "../has-dep";
 import { jestRules } from "../rules/jest";
+import { vitestRules } from "../rules/vitest";
 import testingLibraryConfig from "./testing-library";
 
 const testingConfig = (
@@ -18,36 +20,22 @@ const testingConfig = (
     (autoDetect && hasTestingLibrary());
 
   return [
-    {
-      files: GLOB_TESTS,
-      name: "jimmy.codes/testing",
-      ...jest.configs["flat/recommended"],
-    },
     ...(isVitest
       ? [
           {
             files: GLOB_TESTS,
+            ...vitest.configs.recommended,
             name: "jimmy.codes/testing/vitest",
-            ...jest.configs["flat/recommended"],
-            rules: {
-              ...jestRules,
-              "jest/no-deprecated-functions": "off",
-              "jest/require-hook": [
-                "error",
-                {
-                  allowedFunctionCalls: ALLOWED_VITEST_FUNCS,
-                },
-              ],
-            } satisfies Rules,
+            rules: vitestRules,
           },
         ]
       : []),
     ...(isJest
       ? [
           {
             files: GLOB_TESTS,
-            name: "jimmy.codes/testing/jest",
             ...jest.configs["flat/recommended"],
+            name: "jimmy.codes/testing/jest",
             rules: jestRules,
           },
         ]
@@ -59,6 +47,8 @@ const testingConfig = (
         "jest/expect-expect": "off",
         "jest/no-deprecated-functions": "off",
         "jest/require-hook": "off",
+        "vitest/expect-expect": "off",
+        "vitest/require-hook": "off",
       } satisfies Rules,
     },
     ...(includeTestingLibrary ? testingLibraryConfig() : []),

diff --git a/src/factory.spec.ts b/src/factory.spec.ts
@@ -62,7 +62,6 @@ describe("jimmyDotCodes", () => {
       jimmyDotCodes({ autoDetect: false, testing: { framework: "jest" } }),
     ).toStrictEqual(
       expect.arrayContaining([
-        expect.objectContaining({ name: "jimmy.codes/testing" }),
         expect.objectContaining({ name: "jimmy.codes/testing/disabled" }),
         expect.objectContaining({ name: "jimmy.codes/testing/jest" }),
         expect.not.objectContaining({ name: "jimmy.codes/testing/vitest" }),
@@ -73,7 +72,6 @@ describe("jimmyDotCodes", () => {
   it("should create configuration w/ vitest", () => {
     expect(jimmyDotCodes({ autoDetect: false, testing: true })).toStrictEqual(
       expect.arrayContaining([
-        expect.objectContaining({ name: "jimmy.codes/testing" }),
         expect.objectContaining({ name: "jimmy.codes/testing/disabled" }),
         expect.not.objectContaining({ name: "jimmy.codes/testing/jest" }),
         expect.objectContaining({ name: "jimmy.codes/testing/vitest" }),
@@ -90,7 +88,6 @@ describe("jimmyDotCodes", () => {
       }),
     ).toStrictEqual(
       expect.arrayContaining([
-        expect.objectContaining({ name: "jimmy.codes/testing" }),
         expect.objectContaining({ name: "jimmy.codes/testing/disabled" }),
         expect.objectContaining({ name: "jimmy.codes/testing/jest" }),
         expect.objectContaining({ name: "jimmy.codes/react" }),
@@ -113,7 +110,6 @@ describe("jimmyDotCodes", () => {
       }),
     ).toStrictEqual(
       expect.arrayContaining([
-        expect.objectContaining({ name: "jimmy.codes/testing" }),
         expect.objectContaining({ name: "jimmy.codes/testing/disabled" }),
         expect.objectContaining({ name: "jimmy.codes/testing/vitest" }),
         expect.objectContaining({ name: "jimmy.codes/react" }),
@@ -186,7 +182,6 @@ describe("jimmyDotCodes", () => {
 
     it("should include react-query when auto detection is enabled", () => {
       vi.mocked(isPackageExists).mockImplementation((name) => {
-        // eslint-disable-next-line jest/no-conditional-in-test -- this condition is only for the mock.
         return name === "react" || name === "@tanstack/react-query";
       });
 
@@ -213,7 +208,7 @@ describe("jimmyDotCodes", () => {
       expect(jimmyDotCodes({ autoDetect: true })).toStrictEqual(
         expect.arrayContaining([
           expect.not.objectContaining({ name: "jimmy.codes/typescript" }),
-          expect.objectContaining({ name: "jimmy.codes/testing" }),
+
           expect.objectContaining({ name: "jimmy.codes/testing/vitest" }),
           expect.not.objectContaining({ name: "jimmy.codes/testing/jest" }),
           expect.not.objectContaining({ name: "jimmy.codes/react" }),
@@ -233,7 +228,7 @@ describe("jimmyDotCodes", () => {
       expect(jimmyDotCodes({ autoDetect: true })).toStrictEqual(
         expect.arrayContaining([
           expect.not.objectContaining({ name: "jimmy.codes/typescript" }),
-          expect.objectContaining({ name: "jimmy.codes/testing" }),
+
           expect.not.objectContaining({ name: "jimmy.codes/testing/vitest" }),
           expect.objectContaining({ name: "jimmy.codes/testing/jest" }),
           expect.not.objectContaining({ name: "jimmy.codes/react" }),
@@ -247,14 +242,13 @@ describe("jimmyDotCodes", () => {
 
     it("should include test-library when auto detection is enabled", () => {
       vi.mocked(isPackageExists).mockImplementation((name) => {
-        // eslint-disable-next-line jest/no-conditional-in-test -- this condition is only for the mock.
         return name === "@testing-library/react" || name === "vitest";
       });
 
       expect(jimmyDotCodes({ autoDetect: true })).toStrictEqual(
         expect.arrayContaining([
           expect.not.objectContaining({ name: "jimmy.codes/typescript" }),
-          expect.objectContaining({ name: "jimmy.codes/testing" }),
+
           expect.objectContaining({ name: "jimmy.codes/testing/vitest" }),
           expect.not.objectContaining({ name: "jimmy.codes/testing/jest" }),
           expect.not.objectContaining({ name: "jimmy.codes/react" }),