[BUG] PlaywrightTestConfig leads to errors when tsconfig > exactOptionalPropertyTypes is used

[ayroblu]

Describe the bug

Super basic type error so didn't fill in the template, but can do so if it helps, should be self explanatory, I got it downloading everything today. You either need to make the workers type: workers?: number | undefined or use something special in your generated playwright.config.ts

[mxschmitt]

What is your TypeScript version, vscode version and if so, your tsconfig.json?

It is already: workers?: number which means by using the ? it results in: workers: number | undefined. I tried reproducing it but for me its working fine.

Also your config looks a bit modified, since we don't have process.env["CI"] inside our code, so maybe your tooling caused something.

[ayroblu]

Oh interesting! I thought it was by default, but yeah I guess it might be an extra strict option: https://github.com/ayroblu/collab-notes/blob/main/tsconfig.json
I have all the strict options turned on

[ayroblu]

exactOptionalPropertyTypes is the one you want: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes

[mxschmitt]

Seems like exactOptionalPropertyTypes is not very common or is it somewhere a default value?

[ayroblu]

It's not common, it was released in 4.4. But it fixes a long existing bug in TypeScript that automatically made {workers?: number} equal {workers?: number | undefined}, which is incorrect. This is most obvious when you iterate over the keys and values of a type. Object.entries(config).forEach(([key, value]) => ...) -> if {workers?: number} is the type of the config, then value would be guaranteed to be a number and never undefined.

Feel free to handle this how you choose, I didn't realise it's a new option, but the TypeError is correct, {workers?: number} is not the same as {workers?: number | undefined}.

[pavelfeldman]

Why was this issue closed?

We are prioritizing the bugs based on the upvotes, recency and our ability to act. It looks like this issue only has a handful of upvotes, has not been touched recently and/or we lack sufficient feedback to act on it. We are closing issues like this one to keep our bug database maintainable. Please feel free to open a new issue and link this one to it if you think this is a mistake.