error TS2688: Cannot find type definition file for 'testing-library__jest-dom'.

[rodrigc]

Describe the bug

I created a new vite project using the react-ts template,
and without modifying any files,
if I tried to build it, it would fail with errors:

error TS2688: Cannot find type definition file for 'testing-library__jest-dom'.
  The file is in the program because:
    Entry point for implicit type library 'testing-library__jest-dom'

Reproduction

https://github.com/rodrigc/vite-js-dom-issue

Steps to reproduce

pnpm create vite@latest example1 --template react-ts
cd example1
pnpm install
pnpm build

System Info

System:
    OS: macOS 14.5
    CPU: (16) x64 Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
    Memory: 11.29 GB / 32.00 GB
    Shell: 5.9 - /usr/local/bin/zsh
  Binaries:
    Node: 22.1.0 - /usr/local/bin/node
    npm: 10.7.0 - /usr/local/bin/npm
    pnpm: 9.6.0 - /usr/local/bin/pnpm
  Browsers:
    Chrome: 127.0.6533.89
    Edge: 127.0.2651.86
    Safari: 17.5
  npmPackages:
    @vitejs/plugin-react: ^4.3.1 => 4.3.1
    vite: ^5.3.4 => 5.3.5

Used Package Manager

pnpm

Logs

Click to expand!

pnpm build

> example1@0.0.0 build /Users/crodrigues/vite-js-dom-issue/example1
> tsc -b && vite build

error TS2688: Cannot find type definition file for 'testing-library__jest-dom'.
  The file is in the program because:
    Entry point for implicit type library 'testing-library__jest-dom'

error TS2688: Cannot find type definition file for 'testing-library__jest-dom'.
  The file is in the program because:
    Entry point for implicit type library 'testing-library__jest-dom'


Found 2 errors.

 ELIFECYCLE  Command failed with exit code 1.

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to vuejs/core instead.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.

[rodrigc]

I was able to eliminate this error by doing the following:

1. pnpm add "@testing-library/jest-dom"

2. Explicitly add to "types" in tsconfig.app.json and tsconfig.node.json

diff --git a/example1/tsconfig.app.json b/example1/tsconfig.app.json
index d739292..d158e31 100644
--- a/example1/tsconfig.app.json
+++ b/example1/tsconfig.app.json
@@ -21,7 +21,9 @@
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
+    "noFallthroughCasesInSwitch": true,
+
+     "types": ["@testing-library/jest-dom"]
   },
   "include": ["src"]
 }
(venv) vite-js-dom-issue/example1 - [main●] » git diff tsconfig.node.json
diff --git a/example1/tsconfig.node.json b/example1/tsconfig.node.json
index 3afdd6e..3e1280e 100644
--- a/example1/tsconfig.node.json
+++ b/example1/tsconfig.node.json
@@ -7,7 +7,9 @@
     "moduleResolution": "bundler",
     "allowSyntheticDefaultImports": true,
     "strict": true,
-    "noEmit": true
+    "noEmit": true,
+
+    "types": ["@testing-library/jest-dom"]
   },
   "include": ["vite.config.ts"]
 }

Is there a problem with the vite react-ts template, or
the way that @testing-library/jest-dom exports types?

[bluwy]

I can't replicate the issue. Vite doesn't rely on that library by default. Are there any projects / package.json / tsconfig.json beside or above the directoy of the Vite project? Maybe those are interfering it.

[darekkay]

I've had a similar issue with another library. The solution, as presented here, was to add node_modules to the typeRoots in tsconfig.json:

    "typeRoots": ["./node_modules/@types", "./node_modules"]

This is based on the changed behavior in TypeScript 5.1.0.