[@codspeed/vitest-plugin] TypeScript error in Vitest config

[aleclarson]

The codspeed() call is giving a TypeScript error with Vitest 1.6.0

Error

No overload matches this call.
  The last overload gave the following error.
    Type '{ name: string; apply(_: any, { mode }: { mode: any; }): boolean; enforce: string; config(): { test: { pool: string; poolOptions: { forks: { execArgv: string[]; }; }; runner: string; globalSetup: string[]; }; }; }' is not assignable to type 'PluginOption'.
      Type '{ name: string; apply(_: any, { mode }: { mode: any; }): boolean; enforce: string; config(): { test: { pool: string; poolOptions: { forks: { execArgv: string[]; }; }; runner: string; globalSetup: string[]; }; }; }' is not assignable to type 'Plugin<any>'.
        Types of property 'enforce' are incompatible.
          Type 'string' is not assignable to type '"post" | "pre" | undefined'.ts(2769)

Config

import codspeed from '@codspeed/vitest-plugin'
import { defineConfig } from 'vitest/config'

export default defineConfig({
  plugins: [codspeed()],
})

• vitest v1.6.0
• @codspeed/vitest-plugin v3.1.0

[aleclarson]

It's an ESM issue. The plugin is published without a types specifier in the package.json exports. It may also be related to the use of a .d.ts extension while the JS module uses .mjs (though I did not confirm this).

We are using "type": "module" in our package.json, which could be the reason this issue arose when it doesn't for you.

Anyway, we're using this patch in the meantime:

diff --git a/dist/index.d.ts b/dist/index.d.mts
similarity index 100%
rename from dist/index.d.ts
rename to dist/index.d.mts
diff --git a/package.json b/package.json
index f51062b7f85397bd10b24cfd01e4316c410e8fd7..cb5ed57516f899119d08bca600a3a36dab97a9d4 100644
--- a/package.json
+++ b/package.json
@@ -12,6 +12,7 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs"
     }
   },

The error message in the OP appears because no declaration file is found for dist/index.mjs and so the types are inferred from the JS code.

[Gehbt]

The issue is from to the "moduleResolution": "Bundler" in tsconfig. In fact, using .d.ts is also acceptable.

[adriencaccia]

Hey @aleclarson, thanks for the issue, I will deploy a patch release to fix that.