eslint-config-deepcrawl 16.0.5 → 17.0.0

package/README.md

@@ -61,6 +61,68 @@ Apart from ESLint, it is recommended to use the following Prettier configuration
 
 with `lint-staged` pre-commit hook done via `husky`.
 
+## Migrating from v16
+
+v17 replaces `eslint-plugin-jest` with `@vitest/eslint-plugin`. To upgrade:
+
+1. Rename every `jest/*` rule reference in your `eslint.config.*` to
+   `vitest/*`. For example, `"jest/expect-expect"` becomes
+   `"vitest/expect-expect"`. ESLint silently ignores unknown rule names
+   set to `"off"`, so if you miss a rename, your override stops working
+   without an error.
+2. If you still use Jest, the same rules lint Jest tests, because the test
+   APIs are largely compatible. However, these rules are gone:
+   `no-deprecated-functions`, `no-export` and `no-jasmine-globals` have no
+   Vitest equivalent, and `vitest/no-done-callback` is deprecated because
+   Vitest does not support `done` callbacks. The Jest-only globals (`jest`,
+   `fit`, `xit`, `xtest`, `xdescribe`) are no longer declared either.
+3. `@typescript-eslint/unbound-method` is replaced by
+   `vitest/unbound-method` in TypeScript files. The Vitest rule reports
+   the same problems but allows passing a method to `expect()` (for
+   example `expect(client.getAccount).toHaveBeenCalled()`) and to
+   `vi.mocked()`. Rename any `eslint-disable` comments and config overrides
+   for `@typescript-eslint/unbound-method` to `vitest/unbound-method`.
+   Remove the disable comments that only worked around mock expectations.
+   Old disable comments are reported as unused.
+4. Vitest globals are required. `vitest/no-importing-vitest-globals`
+   reports imports of `describe`, `it`, `expect`, `vi` and the other
+   globals from `vitest`. Type imports such as `Mock` are still allowed.
+   Enable globals in your Vitest config and add the global types to your
+   `tsconfig.json`:
+
+   ```ts
+   // vitest.config.ts
+   export default defineConfig({ test: { globals: true } });
+   ```
+
+   ```json
+   { "compilerOptions": { "types": ["vitest/globals"] } }
+   ```
+
+   `eslint --fix` removes the imports.
+
+5. Tests must use `it`, not `test`, both at the top level and inside
+   `describe` (`vitest/consistent-test-it`). `eslint --fix` renames them.
+6. These rules are new. Most of them can be fixed with `eslint --fix`:
+   - From the Vitest recommended preset: `vitest/no-import-node-test`,
+     `vitest/no-unneeded-async-expect-function`,
+     `vitest/prefer-called-exactly-once-with` and
+     `vitest/require-local-test-context-for-concurrent-snapshots`.
+   - Added by this config: `vitest/no-test-return-statement`,
+     `vitest/prefer-comparison-matcher`, `vitest/prefer-equality-matcher`,
+     `vitest/prefer-hooks-in-order`, `vitest/prefer-hooks-on-top`,
+     `vitest/prefer-mock-promise-shorthand`, `vitest/prefer-to-contain`,
+     `vitest/prefer-to-have-length`, `vitest/prefer-todo`,
+     `vitest/prefer-vi-mocked` and `vitest/require-awaited-expect-poll`.
+
+## Migrating from v15
+
+v16.0.0 fixed the `@stylistic/max-len` ignore pattern, which had been
+exempting every line, so long lines started to report errors. v16.0.1 then
+removed `@stylistic/max-len` altogether and left line length to Prettier.
+If you upgrade straight to v16.0.1 or later, you don't need to change
+anything. If you added overrides to work around v16.0.0, you can remove them.
+
 ## Migrating from v14
 
 v15 upgrades to ESLint 10 and replaces `eslint-plugin-import` with its

package/index.js

@@ -1,10 +1,10 @@
 import eslintJs from "@eslint/js";
 import stylisticPlugin from "@stylistic/eslint-plugin";
+import vitestPlugin from "@vitest/eslint-plugin";
 import { defineConfig } from "eslint/config";
 import eslintConfigPrettier from "eslint-config-prettier/flat";
 import arrayFuncPlugin from "eslint-plugin-array-func";
 import importXPlugin from "eslint-plugin-import-x";
-import jestPlugin from "eslint-plugin-jest";
 import nodePlugin from "eslint-plugin-n";
 import noLoopsPlugin from "eslint-plugin-no-loops";
 import packageJsonPlugin from "eslint-plugin-package-json";
@@ -17,7 +17,8 @@ export default defineConfig([
   eslintJs.configs.recommended,
   importXPlugin.flatConfigs.recommended,
   importXPlugin.flatConfigs.typescript,
-  jestPlugin.configs["flat/recommended"],
+  vitestPlugin.configs.recommended,
+  vitestPlugin.configs.env,
   nodePlugin.configs["flat/recommended"],
   promisePlugin.configs["flat/recommended"],
   {
@@ -168,7 +169,9 @@ export default defineConfig([
       "@typescript-eslint/require-array-sort-compare": "error",
       "@typescript-eslint/restrict-template-expressions": "off",
       "@typescript-eslint/return-await": "error",
+      "@typescript-eslint/unbound-method": "off",
       "@typescript-eslint/unified-signatures": "error",
+      "vitest/unbound-method": "error",
     },
   },
   {
@@ -193,15 +196,6 @@ export default defineConfig([
           groups: ["builtin", "external", "internal", "parent", "sibling", "index"],
         },
       ],
-      "jest/expect-expect": "error",
-      "jest/padding-around-after-all-blocks": "error",
-      "jest/padding-around-after-each-blocks": "error",
-      "jest/padding-around-before-all-blocks": "error",
-      "jest/padding-around-before-each-blocks": "error",
-      "jest/padding-around-describe-blocks": "error",
-      "jest/padding-around-test-blocks": "error",
-      "jest/prefer-expect-resolves": "error",
-      "jest/prefer-to-be": "error",
       "max-classes-per-file": ["error", 1],
       "max-lines-per-function": ["warn", { max: 40, skipBlankLines: true, skipComments: true, IIFEs: true }],
       "max-params": ["error", 7],
@@ -226,6 +220,31 @@ export default defineConfig([
       "object-shorthand": "error",
       "prefer-template": "error",
       "promise/prefer-await-to-then": "error",
+      "vitest/consistent-test-it": ["error", { fn: "it", withinDescribe: "it" }],
+      "vitest/expect-expect": "error",
+      "vitest/no-alias-methods": "error",
+      "vitest/no-commented-out-tests": "warn",
+      "vitest/no-importing-vitest-globals": "error",
+      "vitest/no-test-prefixes": "error",
+      "vitest/no-test-return-statement": "error",
+      "vitest/padding-around-after-all-blocks": "error",
+      "vitest/padding-around-after-each-blocks": "error",
+      "vitest/padding-around-before-all-blocks": "error",
+      "vitest/padding-around-before-each-blocks": "error",
+      "vitest/padding-around-describe-blocks": "error",
+      "vitest/padding-around-test-blocks": "error",
+      "vitest/prefer-comparison-matcher": "error",
+      "vitest/prefer-equality-matcher": "error",
+      "vitest/prefer-expect-resolves": "error",
+      "vitest/prefer-hooks-in-order": "error",
+      "vitest/prefer-hooks-on-top": "error",
+      "vitest/prefer-mock-promise-shorthand": "error",
+      "vitest/prefer-to-be": "error",
+      "vitest/prefer-to-contain": "error",
+      "vitest/prefer-to-have-length": "error",
+      "vitest/prefer-todo": "error",
+      "vitest/prefer-vi-mocked": "error",
+      "vitest/require-awaited-expect-poll": "error",
     },
   },
 ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-deepcrawl",
-  "version": "16.0.5",
+  "version": "17.0.0",
   "description": "ESLint rules recommended by Lumar (formerly DeepCrawl).",
   "homepage": "https://github.com/deepcrawl/eslint-config",
   "bugs": {
@@ -24,27 +24,28 @@
   "dependencies": {
     "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/eslint-plugin": "^8.71.0",
+    "@vitest/eslint-plugin": "^1.6.27",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-array-func": "^5.1.1",
-    "eslint-plugin-import-x": "^4.16.2",
-    "eslint-plugin-jest": "^29.15.2",
-    "eslint-plugin-n": "^18.0.1",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-n": "^18.4.0",
     "eslint-plugin-no-loops": "^0.4.0",
-    "eslint-plugin-package-json": "^1.1.0",
+    "eslint-plugin-package-json": "^1.10.1",
     "eslint-plugin-promise": "^7.3.0",
-    "eslint-plugin-sonarjs": "^4.0.3",
-    "typescript-eslint": "^8.59.4"
+    "eslint-plugin-sonarjs": "^4.2.2",
+    "typescript-eslint": "^8.71.0"
   },
   "devDependencies": {
-    "prettier": "3.8.3",
+    "prettier": "3.9.9",
     "prettier-plugin-packagejson": "3.0.2"
   },
   "peerDependencies": {
     "eslint": "^10.0.0",
-    "typescript": ">=5.8"
+    "typescript": ">=5.9"
   },
-  "packageManager": "yarn@4.14.1",
+  "packageManager": "yarn@4.18.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   }