feat(create-app): improve client types

[fi3ework]

Description

Definition of tsconfig.types on the TS documentation writes

If types is specified, only packages listed will be included in the global scope. For instance:

So if use Vite to create a *-ts project and TS will not recognize global definition such as Jest unless add Jest to tsconfig.types.

Additional context

---

What is the purpose of this pull request?

• Bug fix
• New Feature
• Documentation update
• Other

Before submitting the PR, please make sure you do the following

• Read the Contributing Guidelines.
• Read the Pull Request Guidelines and follow the Commit Convention.
• Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
• Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
• Ideally, include relevant tests that fail without this PR but pass with it.

[fi3ework]

Anyone would like to review this PR? cc @Shinigami92 😉

[Shinigami92]

I'm not so sure about this PR 🤔
But I'm also not biased about it...

On the one side, if someone really needs it, they could easily just add types to the types field or change it just on their own to this solution.
On the other side, I think I saw some other templates from other tools that also just generated like this way with types.

e.g. for tests, I personally have an extra tsconfig.json file for my tests and define cypress and jest there so they don't interfere each other.

Are there more benefits of doing this? Do we have some real world examples?

[nihalgonsalves]

@Shinigami92 I'd say setting types is a less sensible default than providing a globals file. As a user you'd expect Jest and other global types to just work, but if we pre-set types then users will have to find out why their project is broken (when they add a new package and the types don't work).

Next.js also uses this approach, creating a next-env.d.ts file with the client types referenced.

Cypress is an exception since the Cypress & Jest globals interfere with each other, and like you said, that is normally a separate tsconfig in any case.

In general you shouldn't have to make a config change for each package you add [that affects the global types].

[fi3ework]

Yes, remove compilerOptions.types and adding a global declaration file won't block other new added global types. create-react-app also init a react-app-env.d.ts for TypeScript template. And maybe we can tweak and unify the d.ts naming.

[Shinigami92]

Okay, so what about naming the file vite-env.d.ts

Also we could add a documentation section for explaining this file, like in the Next.js docs.
Please also check if there isn't already "old" documentation that needs to be updated.

[Shinigami92]

Have tested it and yes it's working, please rename the file and then we can merge it

[fi3ework]

Also updated the doc of Client Types 🤠