nuxt / nuxt/devtools

DevTools silently disabled when `test: true` is set - seems not documented and possibly environment-dependent

Open
#867 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3.3k
Forks
214
Avg merge
13h 22m
Merged PRs (30d)
18

Description

Description

When test: true is set in nuxt.config.ts, the Nuxt DevTools are silently disabled - even if devtools.enabled: true is explicitly configured.

This behavior seems environment-dependent. I've personally tested the following setups:

  • ✅ Ubuntu native → DevTools show up even with test: true (Ubuntu 24.04.1 LTS)
  • ❌ Debian native → DevTools do not show up when test: true (Debian 12.11)
  • ❌ WSL2 (Ubuntu on Windows 10) → DevTools do not show up when test: true (WSL2 Ubuntu 24.04.1 LTS on Windows 10 version 22H2)

I haven't tested on macOS or CI environments.

Also, I am not sure if this is not operating system dependent, but more node or pnpm version dependent as I had the same node, pnpm and project setup unified tested:

test setup
  • node v22.14.0
  • pnpm v10.9.0
  • setup clean project only with: pnpm create nuxt@latest with pnpm, no modules and not git.
    Only modification in nuxt.config.ts, see below.
Test Result
  1. The following nuxt.config.ts configuration:
    devtools: { enabled: true },
    test: true
    
    Results in:
    > pnpm dev
    > nuxt dev
    
    Nuxt 3.17.5 with Nitro 2.11.12
    
      ➜ Local:    http://localhost:3000/
      ➜ Network:  use --host to expose
    
    ✔ Vite client built in 43ms       
    ✔ Vite server built in 308ms      
    ✔ Nuxt Nitro server built in 702ms
    ℹ Vite client warmed up in 2ms     
    ℹ Vite server warmed up in 492ms
    
  2. The following nuxt.config.ts configuration:
    devtools: { enabled: true },
    test: false
    
    Results in:
    > pnpm dev
    > nuxt dev
    
    Nuxt 3.17.5 with Nitro 2.11.12
    
      ➜ Local:    http://localhost:3000/
      ➜ Network:  use --host to expose
    
      ➜ DevTools: press Shift + Alt + D in the browser (v2.5.0)
    
    ✔ Vite client built in 45ms                                 
    ✔ Vite server built in 326ms                                
    ✔ Nuxt Nitro server built in 879ms                          
    ℹ Vite client warmed up in 2ms                               
    ℹ Vite server warmed up in 515ms    
    

Expectation

If this is intentional behavior, it should be clearly documented.
If it's unintended, it might be worth addressing.

Currently, the documentation at https://nuxt.com/docs/getting-started/testing does not mention that enabling test mode disables DevTools.

Suggestion

Either:

  • Clarify in the docs that test: true disables DevTools (and why),
  • Or treat it as a bug and allow DevTools to remain active in test mode unless explicitly disabled.

Final Note

I'm not sure whether this is intended or accidental. Just raising this here so it's visible to the Nuxt team and the community.

I don't want to rule out the possibility that I may have missed something in the documentation. If that's the case, I apologize for the time taken and kindly ask you to close this issue.

Happy to help test further if needed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the behavior from nuxt.config.ts with devtools.enabled and test toggled, then read the testing documentation at nuxt.com/docs/getting-started/testing. Trace how test mode affects DevTools enablement across the reported environments. Done means the intended behavior is confirmed and either documented clearly or corrected, with the relevant checks passing.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt, typescript
Domain
devtools, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.