refactor: add CLI config schema to make sure we don't miss options

[sheremet-va]

Description

This PR makes it easier for us to make sure we didn't forget to add a CLI option because it requires an explicit opt-out.

This is also a continuation of #3983 to make sure all types are correct.

Closes #3983
Fixes #3962

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

• It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
• Ideally, include a test that fails without this PR but passes with it.
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

• Run the tests with pnpm test:ci.

Documentation

• If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

[netlify]

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

Name	Link
🔨 Latest commit	37cd585
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/65c4f1ac5c31cd00089c6fa4

[AriPerkkio]

Overall looks really nice. 🙌
I think this is a solution that we can maintain quite easily. I'm glad to see the --someOption --someOption.nestedOption=value working without specifying the .enabled explicitly.

Some quick comments below for now. I'll do proper review later this week and do some manual testing.

[AriPerkkio]

to make sure we didn't forget to add a CLI option because it requires an explicit opt-out.

This seems to work for top-level configurations, but not for sub-commands.

I have not yet finished reviewing this completely, but I'm confident enough about the changes. Feel free to merge this if needed. I'll look into this more later this week once I find some time.

[sheremet-va]

This seems to work for top-level configurations, but not for sub-commands.

Can you give an example when this doesn't work? If I remove any nested commands, I get a type error.

[AriPerkkio]

Can you give an example when this doesn't work? If I remove any nested commands, I get a type error.

I tested this by adding new option to provider specific coverage options. But when I add an option to all providers, then it raises an error on CLI definitions. So it's got something to do with conditional types. Detecting all those combinations might be difficult so the current implementation is enough I think.

[sheremet-va]

I tested this by adding new option to provider specific coverage options.

Ah, yes. This only happens with provider because it has a complex type, and TypeScript uses the smallest common denominator when checking this. I think requiring all options to be available in CLI would be a mistake here actually.

[AriPerkkio]

Looks good to me, thanks! Also thanks to @LorenzoBloedow for earlier work on #3983! 🙌

[LorenzoBloedow]

Also thanks to @LorenzoBloedow for earlier work on #3983! 🙌

No problem, glad you guys found a solution! If you need any help feel free to hit me up on Twitter!

[AriPerkkio]

This broke browser-simple project of ecosystem-ci: https://github.com/vitest-dev/vitest-ecosystem-ci/actions/runs/7854132436/job/21434556372

It doesn't find test cases to run. When this commit is reverted all works fine.

vitest/packages/vitest/src/node/cli/cac.ts

Lines 170 to 172 in 4e17942

	cli
	.command('[...filters]')
	.action((filters, options) => start('test', filters, options))

$ pnpm test

> @vitest-tests/browser-simple@ test /z/y/x/browser-simple
> vitest --browser=firefox

{
  filters: [ 'firefox' ],
  options: { '--': [], color: true, browser: { enabled: true } }
}