Merge branch 'jest-community:main' into prefer-jest-globals

Author: MadeinFrance

.yarn/releases/yarn-3.7.0.cjs

@@ -6,4 +6,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
     spec: '@yarnpkg/plugin-interactive-tools'
 
-yarnPath: .yarn/releases/yarn-3.7.0.cjs
+yarnPath: .yarn/releases/yarn-3.8.0.cjs

.yarn/releases/yarn-3.8.0.cjs

@@ -154,7 +154,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.7.0",
+  "packageManager": "yarn@3.8.0",
   "engines": {
     "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   },

.yarnrc.yml

@@ -44,6 +44,12 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
         test("foo");
       `,
     },
+    {
+      code: dedent`
+        const { test } = require('my-test-library');
+        test("foo");
+      `,
+    },
   ],
   invalid: [
     {
@@ -137,18 +143,43 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
     },
     {
       code: dedent`
-        const { test } = require('@jest/globals');
+        console.log('hello');
+        const fs = require('fs');
+        const { test, 'describe': describe } = require('@jest/globals');
         describe("suite", () => {
           test("foo");
           expect(true).toBeDefined();
         })
       `,
       output: dedent`
+        console.log('hello');
+        const fs = require('fs');
         const { test, describe, expect } = require('@jest/globals');
         describe("suite", () => {
           test("foo");
           expect(true).toBeDefined();
         })
+    `,
+      errors: [
+        { endColumn: 9, column: 3, messageId: 'preferImportingJestGlobal' },
+      ],
+    },
+    {
+      code: dedent`
+        console.log('hello');
+        const jestGlobals = require('@jest/globals');
+        describe("suite", () => {
+          test("foo");
+          expect(true).toBeDefined();
+        })
+      `,
+      output: dedent`
+        console.log('hello');
+        const { describe, test, expect } = require('@jest/globals');
+        describe("suite", () => {
+          test("foo");
+          expect(true).toBeDefined();
+        })
     `,
       errors: [
         { endColumn: 9, column: 1, messageId: 'preferImportingJestGlobal' },
@@ -172,5 +203,23 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
         { endColumn: 9, column: 1, messageId: 'preferImportingJestGlobal' },
       ],
     },
+    {
+      code: dedent`
+        describe("suite", () => {
+          test("foo");
+          expect(true).toBeDefined();
+        })
+      `,
+      output: dedent`
+        const { describe, test, expect } = require('@jest/globals');
+        describe("suite", () => {
+          test("foo");
+          expect(true).toBeDefined();
+        })
+    `,
+      errors: [
+        { endColumn: 9, column: 1, messageId: 'preferImportingJestGlobal' },
+      ],
+    },
   ],
 });

package.json

@@ -3,7 +3,7 @@ import type { Literal } from 'estree';
 import { type ParsedJestFnCall, createRule, parseJestFnCall } from './utils';
 
 const createFixerImports = (isModule: boolean, functionsToImport: string[]) => {
-  const allImportsFormatted = functionsToImport.filter(Boolean).join(', ');
+  const allImportsFormatted = functionsToImport.join(', ');
 
   return isModule
     ? `import { ${allImportsFormatted} } from '@jest/globals';`
@@ -137,24 +137,26 @@ export default createRule({
               const existingImports =
                 requireNode.declarations[0]?.id.type ===
                 AST_NODE_TYPES.ObjectPattern
-                  ? requireNode.declarations[0]?.id.properties?.map(
-                      property => {
-                        /* istanbul ignore else */
-                        if (property.type === AST_NODE_TYPES.Property) {
-                          /* istanbul ignore else */
-                          if (property.key.type === AST_NODE_TYPES.Identifier) {
-                            return property.key.name;
-                          }
-                        }
-
-                        // istanbul ignore next
-                        return null;
-                      },
-                    ) ||
-                    // istanbul ignore next
-                    []
-                  : // istanbul ignore next
-                    [];
+                  ? requireNode.declarations[0]?.id.properties.map(property => {
+                      if (
+                        property.type === AST_NODE_TYPES.Property &&
+                        property.key.type === AST_NODE_TYPES.Identifier
+                      ) {
+                        return property.key.name;
+                      }
+                      /* istanbul ignore else */
+                      if (
+                        property.type === AST_NODE_TYPES.Property &&
+                        property.key.type === AST_NODE_TYPES.Literal
+                      ) {
+                        return property.key.value;
+                      }
+
+                      // istanbul ignore next
+                      return null;
+                    })
+                  : [];
+
               const allImports = [
                 ...new Set([
                   ...existingImports.filter(

src/rules/__tests__/prefer-importing-jest-globals.test.ts

@@ -16,9 +16,9 @@
     "resolveJsonModule": true,
     "isolatedModules": true,
     "skipLibCheck": false,
-    "forceConsistentCasingInFileNames": true,
+    "forceConsistentCasingInFileNames": true
   },
   "files": ["eslint-remote-tester.config.ts"],
   "include": ["src/**/*", "tools/**/*"],
-  "exclude": ["src/rules/__tests__/fixtures/**/*"],
+  "exclude": ["src/rules/__tests__/fixtures/**/*"]
 }