Add documention for globalTypesPath

[Glandos]

Vue - Official extension or vue-tsc version

3.0.4

VSCode version

1.102

Vue version

3.5.18

TypeScript version

5.8.3

System Info

System:
    OS: Linux 6.12 Debian GNU/Linux 13 (trixie) 13 (trixie)
    CPU: (8) x64 Intel(R) Core(TM) i7-8650U CPU @ 1.90GHz
    Memory: 20.81 GB / 31.21 GB
    Container: Yes
    Shell: 4.0.2 - /usr/bin/fish
  Binaries:
    Node: 20.19.2 - /run/user/1000/fnm_multishells/44247_1753438232907/bin/node
    Yarn: 4.9.2 - ~/.yarn/bin/yarn
    npm: 10.8.2 - /run/user/1000/fnm_multishells/44247_1753438232907/bin/npm
    bun: 1.2.8 - ~/.local/bin/bun
  Browsers:
    Chromium: 138.0.7204.157

package.json dependencies

Steps to reproduce

Use Yarn with PnP as your package manager in a project.
Upgrade Vue extension from 3.0.1 to 3.0.2.
See the breakage.

What is expected?

No breakage, or a clear documentation on what's missing.

The tooltip should explicitly mention "Yarn PnP" and a reference to #5505 to provide a solution for users with Yarn PnP.

What is actually happening?

Nothing, but feature are broken

Link to minimal reproduction

No response

Any additional comments?

I see that some people did raise the issue, like in #5520, but I'm not able to read this language, so I don't know if:
a. I'm concerned
b. There is a real solution provided

76fcd82 didn't really improve the situation, I tried so many times to restart Vue & TS server that I thought my machine was broken.

[Glandos]

Plus, the current suggestion doesn't mention eslint, and now it complains about many errors in vue-global-types.d.ts.

[KazariEX]

b. There is a real solution provided

Manually configuring globalTypesPath is the solution we provide for the Yarn PnP or other non-npm like environment project.

76fcd82 didn't really improve the situation

It is just an update to the warning message.

the current suggestion doesn't mention eslint

You should configure eslint to exclude this file. This is outside the scope of responsibility of this project.

[johnsoncodehk]

From a developer's perspective, I think the explanation added in 76fcd82 is clear enough.

If you have a better idea for an explanation approach, please feel free to open a PR, thanks!

[randompixel]

I just encountered this and it was not at all clear from the error message or documentation in the wiki what I was meant to do. Whether it was a file already somewhere that I needed to reference or define a path to my own file.

The reference to #5505 in the original post really helped here with the "define a .d.ts file somewhere and add it to gitignore". Maybe it could be added to the Wiki page?

[movy]

The error message should clearly specify:
If using Yarn PnP, add the following to your tsconfig.json:

    "vueCompilerOptions": {
    "globalTypesPath": "./vue-global-types.d.ts"
  },

Spent 2 days googling for this advice.

The worst part: nobody asked for this change and it's totally unclear what this change brought and why was this required in the first place.