How to pass custom CLI arguments to my globalSetup script?

[maxpatiiuk]

Inside of my global setup file, I am starting Puppeteer browser to do E2E testing (I will migrate to Vitest Browser Mode in the future, but not ready yet).

I would like to add a CLI option to Vitest like --devtools that would be used by my global setup script to decide if Puppeteer should be started with DevTools opened or not.

However, if I do so, Vitest will complain about unknown CLI options: "Unknown option --test". Are there other ways to pass arguments to globalSetup script?

Options considered:

• Creating a small CLI wrapper around vitest that would convert my CLI argument into an env variable before passing the rest to Vitest's API. This would be a bit of maintenance work, and may make IDE integration harder.
  • Stencil done something similar when they wished to add custom arguments to Jest. From what I have seen this is a big maintenance effort and source of issues (i.e bug: Unit test --watchAll argument parsed incorrectly ionic-team/stencil#5640 and feat: decouple Jest from Stencil ionic-team/stencil#3156).
• Enabling devtools based on whether --inspect argument was passed to Vitest. This works, but debugging Node.js test and debugging the rendered browser output via browser DevTools are separate things and sometimes I need to debug just one side or another, rather than both.
• Using env variables (PUPPETEER_DEBUG=true yarn vitest). This works, but is more verbose than yarn vitest --devtools. It also doesn't work on Windows without crossenv.
  • This might have to be my solution for now, along with some package.json scripts to shorten the command a bit.

Are there better options available that I am not aware of? Thanks!

[hi-ogawa]

There were similar requests (the one I remember is on Vite vitejs/vite#16251), but personally it feels unusual to support such custom argument for tools like Vite and Vitest, so probably it's not going forward.

I would imagine your 3rd option (env var) isn't too bad. For pnpm (and probably yarn?), shell emulator provides a uniform env var support https://pnpm.io/cli/run#shell-emulator

[maxpatiiuk]

Thanks - I looked for duplicate issues in Vitest, but forgot to look in Vite.
I didn't realize that yarn does shell emulation - neat.
I will proceed with env variables and will mark this discussion as resolved.