feat(vitest-plugin): support esm only

Author: adriencaccia

packages/vitest-plugin/package.json

@@ -8,8 +8,13 @@
     "vitest",
     "performance"
   ],
-  "main": "dist/index.es5.js",
-  "types": "dist/index.d.ts",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs"
+    }
+  },
   "type": "module",
   "files": [
     "dist"
@@ -24,14 +29,14 @@
   "dependencies": {
     "@codspeed/core": "workspace:^2.2.0"
   },
+  "peerDependencies": {
+    "vitest": ">=1.0.0-beta.4 || >=1",
+    "vite": "^4.2.0 || ^5.0.0"
+  },
   "devDependencies": {
     "@total-typescript/shoehorn": "^0.1.1",
     "execa": "^8.0.1",
-    "vite": "^4.5.0",
+    "vite": "^5.0.0",
     "vitest": "1.0.0-beta.4"
-  },
-  "peerDependencies": {
-    "vitest": ">=1.0.0-beta.4 || >=1",
-    "vite": ">=4"
   }
 }

packages/vitest-plugin/rollup.config.ts

@@ -5,11 +5,7 @@ import pkg from "./package.json" assert { type: "json" };
 export default defineConfig([
   {
     input: "src/index.ts",
-    // for some reasons, vitest only wants to require the `main` entrypoint
-    // but fails when its CJS since it cannot require `vitest/*` modules, as
-    // they are ESM only 🤷
-    // we can circumvent this by exposing the `main` entrypoint as ESM
-    output: { file: pkg.main, format: "es" },
+    output: { file: pkg.module, format: "es" },
     plugins: jsPlugins(pkg.version),
     external: ["@codspeed/core", /^vitest/],
   },
@@ -20,13 +16,13 @@ export default defineConfig([
   },
   {
     input: "src/globalSetup.ts",
-    output: { file: "dist/globalSetup.es5.js", format: "es" },
+    output: { file: "dist/globalSetup.mjs", format: "es" },
     plugins: jsPlugins(pkg.version),
     external: ["@codspeed/core", /^vitest/],
   },
   {
     input: "src/runner.ts",
-    output: { file: "dist/runner.es5.js", format: "es" },
+    output: { file: "dist/runner.mjs", format: "es" },
     plugins: jsPlugins(pkg.version),
     external: ["@codspeed/core", /^vitest/],
   },

packages/vitest-plugin/src/__tests__/globalSetup.test.ts

@@ -1,12 +1,19 @@
 import { describe, expect, it, vi } from "vitest";
-import globalSetup from "../globalSetup";
 
 console.log = vi.fn();
 
-vi.stubGlobal("__VERSION__", "1.0.0");
+async function importFreshGlobalSetup() {
+  return (
+    (await import(
+      `../globalSetup?${Date.now()}`
+    )) as typeof import("../globalSetup")
+  ).default;
+}
 
-describe("globalSetup", () => {
-  it("should log the correct message on setup and teardown, and fail when teardown is called twice", async () => {
+describe("globalSetup", async () => {
+  it("with version, should log the correct message on setup and teardown, and fail when teardown is called twice", async () => {
+    vi.stubGlobal("__VERSION__", "1.0.0");
+    const globalSetup = await importFreshGlobalSetup();
     const teardown = globalSetup();
 
     expect(console.log).toHaveBeenCalledWith(
@@ -21,4 +28,22 @@ describe("globalSetup", () => {
 
     expect(() => teardown()).toThrowError("teardown called twice");
   });
+
+  it("without version, should log the correct message on setup and teardown, and fail when teardown is called twice", async () => {
+    vi.unstubAllGlobals();
+    const globalSetup = await importFreshGlobalSetup();
+    const teardown = globalSetup();
+
+    expect(console.log).toHaveBeenCalledWith(
+      "[CodSpeed] @codspeed/vitest-plugin - setup"
+    );
+
+    teardown();
+
+    expect(console.log).toHaveBeenCalledWith(
+      "[CodSpeed] @codspeed/vitest-plugin - teardown"
+    );
+
+    expect(() => teardown()).toThrowError("teardown called twice");
+  });
 });

packages/vitest-plugin/src/__tests__/index.test.ts

@@ -77,9 +77,7 @@ describe("codSpeedPlugin", () => {
     expect(config({}, fromPartial({}))).toStrictEqual({
       test: {
         globalSetup: [
-          expect.stringContaining(
-            "packages/vitest-plugin/src/globalSetup.es5.js"
-          ),
+          expect.stringContaining("packages/vitest-plugin/src/globalSetup.ts"),
         ],
         pool: "forks",
         poolOptions: {
@@ -95,9 +93,7 @@ describe("codSpeedPlugin", () => {
             ],
           },
         },
-        runner: expect.stringContaining(
-          "packages/vitest-plugin/src/runner.es5.js"
-        ),
+        runner: expect.stringContaining("packages/vitest-plugin/src/runner.ts"),
       },
     });
   });

packages/vitest-plugin/src/globalSetup.ts

@@ -1,4 +1,4 @@
-declare const __VERSION__: string;
+declare const __VERSION__: string | undefined;
 
 /**
  * @deprecated
@@ -12,12 +12,15 @@ function logCodSpeed(message: string) {
 let teardownHappened = false;
 
 export default function () {
-  logCodSpeed(`@codspeed/vitest-plugin v${__VERSION__} - setup`);
+  // log the version of the plugin if the global variable is defined
+  const VERSION = typeof __VERSION__ === "string" ? `v${__VERSION__} ` : "";
+
+  logCodSpeed(`@codspeed/vitest-plugin ${VERSION}- setup`);
 
   return () => {
     if (teardownHappened) throw new Error("teardown called twice");
     teardownHappened = true;
 
-    logCodSpeed(`@codspeed/vitest-plugin v${__VERSION__} - teardown`);
+    logCodSpeed(`@codspeed/vitest-plugin ${VERSION}- teardown`);
   };
 }

packages/vitest-plugin/src/index.ts

@@ -1,7 +1,18 @@
 import { getV8Flags, Measurement } from "@codspeed/core";
+import { join } from "path";
 import { Plugin } from "vite";
 import { UserConfig } from "vitest/config";
 
+// get this file's directory path from import.meta.url
+const __dirname = new URL(".", import.meta.url).pathname;
+const isFileInTs = import.meta.url.endsWith(".ts");
+
+function getCodSpeedFileFromName(name: string) {
+  const fileExtension = isFileInTs ? "ts" : "mjs";
+
+  return join(__dirname, `${name}.${fileExtension}`);
+}
+
 export default function codspeedPlugin(): Plugin {
   return {
     name: "codspeed:vitest",
@@ -18,8 +29,6 @@ export default function codspeedPlugin(): Plugin {
       return true;
     },
     enforce: "post",
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore - vite does not support vitest config yet in typings
     config(): UserConfig {
       return {
         test: {
@@ -29,8 +38,8 @@ export default function codspeedPlugin(): Plugin {
               execArgv: getV8Flags(),
             },
           },
-          runner: `${__dirname}/runner.es5.js`,
-          globalSetup: [`${__dirname}/globalSetup.es5.js`],
+          runner: getCodSpeedFileFromName("runner"),
+          globalSetup: [getCodSpeedFileFromName("globalSetup")],
         },
       };
     },