-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat: experimental static import.meta.env #12105
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.
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
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
d11b42e
feat: experimental static import.meta.env
florian-lefebvre ede8f22
Merge branch 'main' into feat/experimental-static-meta-env
florian-lefebvre 6c329c4
clarify
florian-lefebvre 422ea9d
fix: remove translations
florian-lefebvre 13a7144
Update src/content/docs/en/reference/experimental-flags/static-import…
florian-lefebvre 9320bad
Yan punctuation review
sarah11918 dbdb84f
Sarah draft content suggestions after talking with Florian
sarah11918 e987046
Astro 6.0 tip
sarah11918 c48f056
Yan final polish
sarah11918 20bb3f7
Merge branch 'main' into feat/experimental-static-meta-env
sarah11918 4ec4e22
semi-colons in code blocks
sarah11918 f54c754
Update src/content/docs/en/reference/experimental-flags/static-import…
florian-lefebvre efd99db
Merge branch '5.13.0' into feat/experimental-static-meta-env
sarah11918 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 0 additions & 50 deletions
50
src/content/docs/en/reference/experimental-flags/raw-env-values.mdx
This file was deleted.
Oops, something went wrong.
88 changes: 88 additions & 0 deletions
88
src/content/docs/en/reference/experimental-flags/static-import-meta-env.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
title: Experimental private meta environment variables inlining | ||
sidebar: | ||
label: Private meta environment variables inlining | ||
i18nReady: true | ||
--- | ||
|
||
import Since from '~/components/Since.astro' | ||
|
||
<p> | ||
|
||
**Type:** `boolean`<br /> | ||
**Default:** `false`<br /> | ||
<Since v="5.13.0" /> | ||
</p> | ||
|
||
:::tip[Astro 6.0 preview] | ||
The behavior enabled by this feature will become the default behavior in Astro 6.0. | ||
|
||
You may wish to add this flag whenever it is convenient to do so. You can start enjoying the benefits sooner and will avoid the need to update your project code for the next major Astro version. | ||
::: | ||
|
||
Astro allows you to configure a [type-safe schema for your environment variables](/en/guides/environment-variables/#type-safe-environment-variables), and converts variables imported via `astro:env` into the expected type. This is the recommended way to use environment variables in Astro, as it allows you to easily see and manage whether your variables are public or secret, available on the client or only on the server at build time, and the data type of your values. | ||
|
||
However, you can still access your environment variables through `process.env` as well as `import.meta.env` directly if needed. This was the only way to use environment variables in Astro before `astro:env` was added in Astro 5.0, and its handling of `import.meta.env` includes some logic that was intended for earlier versions of Astro that is no longer necessary. | ||
|
||
The `experimental.staticImportMetaEnv` flag updates the behavior when accessing `import.meta.env` directly to align with [Vite's handling of environment variables](https://vite.dev/guide/env-and-mode.html#env-variables) and ensures that `import.meta.env` values are always inlined. | ||
|
||
Currently, non-public environment variables are replaced by a reference to `process.env`. Additionally, Astro may also convert the value type of your environment variables used through `import.meta.env`, which can prevent access to some values such as the strings `"true"` (which is converted to a boolean value), and `"1"` (which is converted to a number). | ||
|
||
The `experimental.staticImportMetaEnv` flag simplifies Astro's default behavior, making it easier to understand and use. Astro will no longer replace any `import.meta.env` environment variables with a `process.env` call, nor will it coerce values. | ||
|
||
To enable this feature, add the experimental flag in your Astro config: | ||
|
||
```js title="astro.config.mjs" ins={4-6} | ||
import { defineConfig } from "astro/config" | ||
|
||
export default defineConfig({ | ||
experimental: { | ||
staticImportMetaEnv: true, | ||
} | ||
}) | ||
``` | ||
|
||
## Usage | ||
|
||
Enabling this experimental flag will no longer convert string values into booleans or numbers, nor turn `import.meta.env` values into `process.env` calls. This aligns `import.meta.env`'s behavior in Astro with [Vite](https://vite.dev/guide/env-and-mode.html#env-variables). | ||
|
||
In a future major version, Astro will switch to this behavior by default, but you can opt in to the future behavior early using the `experimental.staticImportMetaEnv` flag and, if necessary, [updating your project](#updating-your-project) accordingly. | ||
|
||
### Updating your project | ||
|
||
If you were relying on coercion, you may need to update your project code to apply it manually: | ||
|
||
```ts title="src/components/MyComponent.astro" del={1} ins={2} | ||
const enabled: boolean = import.meta.env.ENABLED; | ||
const enabled: boolean = import.meta.env.ENABLED === "true"; | ||
``` | ||
|
||
If you were relying on the transformation into `process.env`, you may need to update your project code to apply it manually: | ||
|
||
```ts title="src/components/MyComponent.astro" del={1} ins={2} | ||
const enabled: boolean = import.meta.env.DB_PASSWORD; | ||
const enabled: boolean = process.env.DB_PASSWORD; | ||
``` | ||
|
||
You may also need to update types: | ||
|
||
```ts title="src/env.d.ts" del={3-4} ins={5,12-16} | ||
interface ImportMetaEnv { | ||
readonly PUBLIC_POKEAPI: string; | ||
readonly DB_PASSWORD: string; | ||
readonly ENABLED: boolean; | ||
readonly ENABLED: string; | ||
} | ||
|
||
interface ImportMeta { | ||
readonly env: ImportMetaEnv; | ||
} | ||
|
||
namespace NodeJS { | ||
interface ProcessEnv { | ||
DB_PASSWORD: string; | ||
} | ||
} | ||
``` | ||
|
||
If you need more control over environment variables in Astro, we recommend you use [`astro:env`](/en/guides/environment-variables/). |
50 changes: 0 additions & 50 deletions
50
src/content/docs/fr/reference/experimental-flags/raw-env-values.mdx
This file was deleted.
Oops, something went wrong.
50 changes: 0 additions & 50 deletions
50
src/content/docs/ko/reference/experimental-flags/raw-env-values.mdx
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was trying to think of some "tip" to distinguish "here's a new feature" from "this is a new default" because we have two kinds of experimental flags.