Skip to content
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

feat: make ImportMetaEnv strictly available #19077

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
+9 −1
Open

feat: make ImportMetaEnv strictly available #19077

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d124ebe
Remove a key definition of ImportMetaEnv
yunics-highfield Dec 26, 2024
8edd6a4
Update packages/vite/types/importMeta.d.ts
yunics-highfield Dec 26, 2024
d5ac419
Use "@ts-expect-error" instead of "@ts-ignore"
yunics-highfield Dec 26, 2024
3827282
Remove "@ts-expect-error"
yunics-highfield Dec 26, 2024
5b8527a
Update packages/vite/types/importMeta.d.ts
yunics-highfield Dec 26, 2024
43a8135
Modify a document
yunics-highfield Dec 27, 2024
2ca9ac1
Remove semicolon
yunics-highfield Dec 27, 2024
456ad40
chore: remove `declare` keyword
sapphi-red Jan 7, 2025
d184511
Update docs/guide/env-and-mode.md
yunics-highfield Jan 7, 2025
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
3 changes: 3 additions & 0 deletions docs/guide/env-and-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ To achieve this, you can create an `vite-env.d.ts` in `src` directory, then augm
```typescript [vite-env.d.ts]
/// <reference types="vite/client" />

// By adding this line, you can make the type of ImportMetaEnv strict.
yunics-highfield marked this conversation as resolved.
Show resolved Hide resolved
declare type ViteStrictImportMetaEnv = true
sapphi-red marked this conversation as resolved.
Show resolved Hide resolved

interface ImportMetaEnv {
readonly VITE_APP_TITLE: string
// more env variables...
Expand Down
6 changes: 5 additions & 1 deletion packages/vite/types/importMeta.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
// Thus cannot contain any top-level imports
// <https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation>

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore ViteStrictImportMetaEnv may or may not be declared by users
type ImportMetaKey = ViteStrictImportMetaEnv extends true ? never : string
yunics-highfield marked this conversation as resolved.
Show resolved Hide resolved

interface ImportMetaEnv {
[key: string]: any
[key: ImportMetaKey]: any
BASE_URL: string
MODE: string
DEV: boolean
Expand Down
Loading