feature: @putout/plugin-vitest: apply-hoisted: add

Author: coderaiser

packages/plugin-vitest/README.md

@@ -17,6 +17,7 @@ npm i @putout/plugin-vitest -D
 
 ## Rules
 
+- ✅ [apply-hoisted](#apply-hoisted);
 - ✅ [v3-apply-options-as-second-argument](#v3-apply-options-as-second-argument);
 - ✅ [v3-apply-browser-instances](#v3-apply-browser-instances);
 
@@ -25,13 +26,51 @@ npm i @putout/plugin-vitest -D
 ```json
 {
     "rules": {
+        "vitest/apply-hoisted": "on",
         "vitest/v3-apply-options-as-second-argument": "on",
         "vitest/v3-apply-browser-instances": "on"
     },
     "plugins": ["vitest"]
 }
 ```
 
+## apply-hoisted
+
+> All static import statements in ES modules are hoisted to the top of the file, so any code that is defined before the imports will actually be executed after imports are evaluated.
+>
+> (c) [vitest.dev](https://vitest.dev/api/vi.html#vi-hoisted)
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/1ce501a96baced5c46b07aac1cbdb1ff/70d2710641f57c20781208a28a81cf3a04c79a37).
+
+### ❌ Example of incorrect code
+
+```js
+let hello;
+let world;
+
+it('hello', () => {
+    hello.calledWith();
+});
+```
+
+### ✅ Example of correct code
+
+```js
+const hoisted = vi.hoisted({
+    hello: vi.fn(),
+    world: vi.fn(),
+});
+
+beforeEach(() => {
+    hello.mockClear();
+    world.mockClear();
+});
+
+it('hello', () => {
+    hoisted.hello.calledWith();
+});
+```
+
 ## v3-apply-options-as-second-argument
 
 > Vitest 3.0 prints a warning if you pass down an object as a third argument to test or describe functions.

packages/plugin-vitest/lib/apply-hoisted/fixture/apply-hoisted-fix.js

@@ -0,0 +1,13 @@
+import a from 'b';
+
+const hoisted = vi.hoisted({
+    hello: vi.fn(),
+    world: vi.fn(),
+});
+beforeEach(() => {
+    hello.mockClear();
+    world.mockClear();
+});
+it('hello', () => {
+    hoisted.hello.calledWith();
+});

packages/plugin-vitest/lib/apply-hoisted/fixture/apply-hoisted.js

@@ -0,0 +1,10 @@
+import a from 'b';
+
+let hello;
+let world;
+
+
+it('hello', () => {
+    hello.calledWith();
+});
+

packages/plugin-vitest/lib/apply-hoisted/index.js

@@ -0,0 +1,76 @@
+import {
+    template,
+    types,
+    operator,
+} from 'putout';
+
+const {
+    remove,
+    rename,
+    insertBefore,
+    getPathAfterImports,
+} = operator;
+
+const {
+    isVariableDeclaration,
+    expressionStatement,
+    objectProperty,
+    identifier,
+} = types;
+const {entries} = Object;
+
+const createHoisted = template('const hoisted = vi.hoisted({})');
+const createMockClear = template('NAME.mockClear();');
+const createBeforeEach = template('beforeEach(() => {})');
+
+export const report = () => `Use 'vi.hoisted()'`;
+
+export const fix = ({path, names}) => {
+    const hoistedNode = createHoisted();
+    const beforeEach = createBeforeEach();
+    
+    const [object] = hoistedNode.declarations[0].init.arguments;
+    const {body} = beforeEach.arguments[0].body;
+    
+    for (const name of names) {
+        const key = identifier(name);
+        const value = template.ast('vi.fn()');
+        const property = objectProperty(key, value);
+        
+        object.properties.push(property);
+        body.push(expressionStatement(createMockClear({
+            NAME: name,
+        })));
+    }
+    
+    const afterImportsPath = getPathAfterImports(path.get('body'));
+    
+    insertBefore(afterImportsPath, hoistedNode);
+    insertBefore(afterImportsPath, expressionStatement(beforeEach));
+};
+
+export const traverse = ({push}) => ({
+    Program(path) {
+        const names = [];
+        
+        for (const [name, binding] of entries(path.scope.bindings)) {
+            const {parentPath} = binding.path;
+            
+            if (!isVariableDeclaration(parentPath))
+                continue;
+            
+            if (parentPath.node.declarations[0].init)
+                continue;
+            
+            rename(path, name, `hoisted.${name}`);
+            remove(binding.path);
+            names.push(name);
+        }
+        
+        if (names.length)
+            push({
+                path,
+                names,
+            });
+    },
+});

packages/plugin-vitest/lib/apply-hoisted/index.spec.js

@@ -0,0 +1,18 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['apply-hoisted', plugin],
+    ],
+});
+
+test('vitest: apply-hoisted: report', (t) => {
+    t.report('apply-hoisted', `Use 'vi.hoisted()'`);
+    t.end();
+});
+
+test('vitest: apply-hoisted: transform', (t) => {
+    t.transform('apply-hoisted');
+    t.end();
+});

packages/plugin-vitest/lib/index.js

@@ -1,7 +1,9 @@
+import * as applyHoisted from './apply-hoisted/index.js';
 import * as v3ApplyOptionsAsSecondArgument from './v3-apply-options-as-second-argument/index.js';
 import * as v3ApplyBrowserInstances from './v3-apply-browser-instances/index.js';
 
 export const rules = {
     'v3-apply-options-as-second-argument': v3ApplyOptionsAsSecondArgument,
     'v3-apply-browser-instances': v3ApplyBrowserInstances,
+    'apply-hoisted': applyHoisted,
 };

packages/plugin-vitest/test/fixture/apply-hoisted-fix.js

@@ -0,0 +1,13 @@
+import a from 'b';
+
+const hoisted = vi.hoisted({
+    hello: vi.fn(),
+    world: vi.fn(),
+});
+beforeEach(() => {
+    hello.mockClear();
+    world.mockClear();
+});
+it('hello', () => {
+    hoisted.hello.calledWith();
+});

packages/plugin-vitest/test/fixture/apply-hoisted.js

@@ -0,0 +1,10 @@
+import a from 'b';
+
+let hello;
+let world;
+
+
+it('hello', () => {
+    hello.calledWith();
+});
+

packages/plugin-vitest/test/vitest.js

@@ -16,3 +16,8 @@ test('plugin-vitest: transform: v3-apply-browser-instances', (t) => {
     t.transform('v3-apply-browser-instances');
     t.end();
 });
+
+test('plugin-vitest: transform: apply-hoisted', (t) => {
+    t.transform('apply-hoisted');
+    t.end();
+});