From 9c4197c91fa96d7991acba8eac4fca909f28f8d0 Mon Sep 17 00:00:00 2001
From: Erin Zimmer <ejzimmer@gmail.com>
Date: Thu, 5 Sep 2024 05:16:34 +1000
Subject: [PATCH] fix(prefer-importing-jest-globals): don't add imports in the
 middle of statements (#1645)

* fix(prefer-importing-jest-globals): ensure imports aren't inserted in the middle of a statement

* fix(prefer-importing-jest-globals): fix indenting

* fix(prefer-importing-jest-globals): give commonjs and esmodules the same import behaviour

---------

Co-authored-by: Erin Zimmer <ezimmer@atlassian.com>
---
 .../prefer-importing-jest-globals.test.ts     | 63 +++++++++++++++++--
 src/rules/prefer-importing-jest-globals.ts    |  2 +-
 2 files changed, 60 insertions(+), 5 deletions(-)

diff --git a/src/rules/__tests__/prefer-importing-jest-globals.test.ts b/src/rules/__tests__/prefer-importing-jest-globals.test.ts
index ea5125711..fde6afd48 100644
--- a/src/rules/__tests__/prefer-importing-jest-globals.test.ts
+++ b/src/rules/__tests__/prefer-importing-jest-globals.test.ts
@@ -228,8 +228,8 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
         });
       `,
       output: dedent`
-        import { pending } from 'actions';
         import { describe, test } from '@jest/globals';
+        import { pending } from 'actions';
         describe('foo', () => {
           test.each(['hello', 'world'])("%s", (a) => {});
         });
@@ -304,11 +304,11 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
       `,
       // todo: this shouldn't be indenting the "test"
       output: dedent`
+        const { expect, test } = require('@jest/globals');
         const source = 'globals';
         const {describe} = require(\`@jest/\${source}\`);
         describe("suite", () => {
-          const { expect, test } = require('@jest/globals');
-        test("foo");
+          test("foo");
           expect(true).toBeDefined();
         })
       `,
@@ -407,8 +407,8 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
         });
       `,
       output: dedent`
-        const { pending } = require('actions');
         const { describe, test } = require('@jest/globals');
+        const { pending } = require('actions');
         describe('foo', () => {
           test.each(['hello', 'world'])("%s", (a) => {});
         });
@@ -546,6 +546,61 @@ ruleTester.run('prefer-importing-jest-globals', rule, {
         },
       ],
     },
+    {
+      code: dedent`
+        console.log('hello');
+        const onClick = jest.fn();
+        describe("suite", () => {
+          test("foo");
+          expect(onClick).toHaveBeenCalled();
+        })
+      `,
+      output: dedent`
+        const { describe, expect, jest, test } = require('@jest/globals');
+        console.log('hello');
+        const onClick = jest.fn();
+        describe("suite", () => {
+          test("foo");
+          expect(onClick).toHaveBeenCalled();
+        })
+      `,
+      errors: [
+        {
+          endColumn: 21,
+          column: 17,
+          line: 2,
+          messageId: 'preferImportingJestGlobal',
+        },
+      ],
+    },
+    {
+      code: dedent`
+        console.log('hello');
+        const onClick = jest.fn();
+        describe("suite", () => {
+          test("foo");
+          expect(onClick).toHaveBeenCalled();
+        })
+      `,
+      output: dedent`
+        import { describe, expect, jest, test } from '@jest/globals';
+        console.log('hello');
+        const onClick = jest.fn();
+        describe("suite", () => {
+          test("foo");
+          expect(onClick).toHaveBeenCalled();
+        })
+      `,
+      parserOptions: { sourceType: 'module' },
+      errors: [
+        {
+          endColumn: 21,
+          column: 17,
+          line: 2,
+          messageId: 'preferImportingJestGlobal',
+        },
+      ],
+    },
   ],
 });
 
diff --git a/src/rules/prefer-importing-jest-globals.ts b/src/rules/prefer-importing-jest-globals.ts
index fcc3bc75f..66afbd3f0 100644
--- a/src/rules/prefer-importing-jest-globals.ts
+++ b/src/rules/prefer-importing-jest-globals.ts
@@ -152,7 +152,7 @@ export default createRule({
 
             if (requireNode?.type !== AST_NODE_TYPES.VariableDeclaration) {
               return fixer.insertTextBefore(
-                reportingNode,
+                firstNode,
                 `${createFixerImports(isModule, functionsToImport)}\n`,
               );
             }