Skip to content

docs: add warning about overriding tsconfig types #1855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 13, 2025
Merged

docs: add warning about overriding tsconfig types #1855

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions guide/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,18 @@ Vite はデフォルトでは Node.js の API を提供します。Vite でク
```json [tsconfig.json]
{
"compilerOptions": {
"types": ["vite/client"]
"types": ["vite/client", "some-other-global-lib"]
}
}
```

これにより次のことが提供されます:
::: warning

[`compilerOptions.types`](https://www.typescriptlang.org/tsconfig#types) が指定された場合、グローバルスコープには（見つかるすべての "@types" パッケージの代わりに）これらのパッケージのみが含まれるようになります。

:::

`vite/client` は以下の型のシム（shim）を提供します:
Copy link
Contributor Author

@shuuji3 shuuji3 Feb 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shimの訳語がわからなかったので、MDNを参考にしてカタカナと併記するようにしました: https://developer.mozilla.org/ja/docs/Glossary/Shim

おそらく語源は隙間を埋める素材から来ていて (参考: https://jp.meviy.misumi-ec.com/info/ja/howto/33696/) そちらはカタカナ表記で定着しているみたいです。


- アセットのインポート（例: `.svg` ファイルのインポート）
- `import.meta.env` に Vite が挿入した[環境変数](./env-and-mode#env-variables)の型
Expand Down