eslint-plugin-jest 28.1.1 → 28.3.0

package/README.md

@@ -87,6 +87,27 @@ You can tell this plugin about any global Jests you have aliased using the
 }
 ```
 
+#### Aliased `@jest/globals`
+
+You can tell this plugin to treat a different package as the source of Jest
+globals using the `globalPackage` setting:
+
+```json
+{
+  "settings": {
+    "jest": {
+      "globalPackage": "bun:test"
+    }
+  }
+}
+```
+
+> [!WARNING]
+>
+> While this can be used to apply rules when using alternative testing libraries
+> and frameworks like `bun`, `vitest` and `node`, there's no guarantee the
+> semantics this plugin assumes will hold outside of Jest
+
 ### Running rules only on test-related files
 
 The rules provided by this plugin assume that the files they are checking are

package/docs/rules/prefer-importing-jest-globals.md

@@ -42,6 +42,42 @@ describe('foo', () => {
 });
 ```
 
+## Options
+
+This rule can be configured as follows
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "types": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["hook", "describe", "test", "expect", "jest", "unknown"]
+      }
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+#### types
+
+A list of Jest global types to enforce explicit imports for. By default, all
+Jest globals are enforced.
+
+This option is useful when you only want to enforce explicit imports for a
+subset of Jest globals. For instance, when migrating to ESM, you might want to
+enforce explicit imports only for the `jest` global, as of
+[Jest's ESM documentation](https://jestjs.io/docs/ecmascript-modules#differences-between-esm-and-commonjs).
+
+```json5
+{
+  'jest/prefer-importing-jest-globals': ['error', { types: ['jest'] }],
+}
+```
+
 ## Further Reading
 
 - [Documentation](https://jestjs.io/docs/api)

package/lib/rules/expect-expect.js

@@ -40,9 +40,9 @@ var _default = exports.default = (0, _utils2.createRule)({
       properties: {
         assertFunctionNames: {
           type: 'array',
-          items: [{
+          items: {
             type: 'string'
-          }]
+          }
         },
         additionalTestBlockFunctions: {
           type: 'array',

package/lib/rules/prefer-importing-jest-globals.js

@@ -10,6 +10,7 @@ const createFixerImports = (isModule, functionsToImport) => {
   const allImportsFormatted = Array.from(functionsToImport).sort().join(', ');
   return isModule ? `import { ${allImportsFormatted} } from '@jest/globals';` : `const { ${allImportsFormatted} } = require('@jest/globals');`;
 };
+const allJestFnTypes = ['hook', 'describe', 'test', 'expect', 'jest', 'unknown'];
 var _default = exports.default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -21,10 +22,27 @@ var _default = exports.default = (0, _utils2.createRule)({
     },
     fixable: 'code',
     type: 'problem',
-    schema: []
+    schema: [{
+      type: 'object',
+      properties: {
+        types: {
+          type: 'array',
+          items: {
+            type: 'string',
+            enum: allJestFnTypes
+          }
+        }
+      },
+      additionalProperties: false
+    }]
   },
-  defaultOptions: [],
+  defaultOptions: [{
+    types: allJestFnTypes
+  }],
   create(context) {
+    const {
+      types = allJestFnTypes
+    } = context.options[0] || {};
     const importedFunctionsWithSource = {};
     const functionsToImport = new Set();
     let reportingNode;
@@ -41,7 +59,7 @@ var _default = exports.default = (0, _utils2.createRule)({
         if (!jestFnCall) {
           return;
         }
-        if (jestFnCall.head.type !== 'import') {
+        if (jestFnCall.head.type !== 'import' && types.includes(jestFnCall.type)) {
           functionsToImport.add(jestFnCall.name);
           reportingNode ||= jestFnCall.head.node;
         }

package/lib/rules/utils/parseJestFnCall.js

@@ -309,9 +309,10 @@ const resolveToJestFn = (context, accessor) => {
     return null;
   }
   if (maybeImport) {
-    // the identifier is imported from @jest/globals,
-    // so return the original import name
-    if (maybeImport.source === '@jest/globals') {
+    const globalPackage = context.settings.jest?.globalPackage ?? '@jest/globals';
+
+    // the identifier is imported from our global package so return the original import name
+    if (maybeImport.source === globalPackage) {
       return {
         original: maybeImport.imported,
         local: maybeImport.local,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "28.1.1",
+  "version": "28.3.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -29,7 +29,7 @@
     "prettier:write": "prettier --write 'docs/**/*.md' README.md '.github/**' package.json tsconfig.json src/globals.json .yarnrc.yml",
     "postpublish": "pinst --enable",
     "test": "jest",
-    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator",
+    "regenerate-docs": "yarn prepack && eslint-doc-generator",
     "typecheck": "tsc -p ."
   },
   "commitlint": {
@@ -86,13 +86,13 @@
     "babel-jest": "^29.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^1.5.0",
-    "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0",
+    "eslint": "^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-eslint-plugin": "^5.0.6",
+    "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-import": "^2.25.1",
-    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-n": "^17.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-remote-tester": "^3.0.0",
     "eslint-remote-tester-repositories": "~1.0.0",