Skip to content

Commit 2f17d2f

Browse files
authored
docs: update environment api as release candidate (vitejs#20353)
1 parent bab4fbc commit 2f17d2f

File tree

6 files changed

+25
-16
lines changed

6 files changed

+25
-16
lines changed

docs/changes/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,17 @@ List of breaking changes in Vite including API deprecations, removals, and chang
66

77
These changes are planned for the next major version of Vite. The deprecation or usage warnings will guide you where possible, and we're reaching out to framework, plugin authors, and users to apply these changes.
88

9-
- _No planned changes yet_
9+
- [`this.environment` in Hooks](/changes/this-environment-in-hooks)
10+
- [HMR `hotUpdate` Plugin Hook](/changes/hotupdate-hook)
11+
- [SSR Using `ModuleRunner` API](/changes/ssr-using-modulerunner)
1012

1113
## Considering
1214

1315
These changes are being considered and are often experimental APIs that intend to improve upon current usage patterns. As not all changes are listed here, please check out the [Experimental Label in Vite GitHub Discussions](https://github.com/vitejs/vite/discussions/categories/feedback?discussions_q=label%3Aexperimental+category%3AFeedback) for the full list.
1416

1517
We don't recommend switching to these APIs yet. They are included in Vite to help us gather feedback. Please check these proposals and let us know how they work in your use case in each's linked GitHub Discussions.
1618

17-
- [`this.environment` in Hooks](/changes/this-environment-in-hooks)
18-
- [HMR `hotUpdate` Plugin Hook](/changes/hotupdate-hook)
1919
- [Move to Per-environment APIs](/changes/per-environment-apis)
20-
- [SSR Using `ModuleRunner` API](/changes/ssr-using-modulerunner)
2120
- [Shared Plugins During Build](/changes/shared-plugins-during-build)
2221

2322
## Past

docs/guide/api-environment-frameworks.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Environment API for Frameworks
22

3-
:::warning Experimental
4-
Environment API is experimental. We'll still maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
3+
:::info Release Candidate
4+
The Environment API is generally in the release candidate phase. We'll maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. However, note that [some specific APIs](/changes/#considering) are still considered experimental.
5+
6+
We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
57

68
Resources:
79

docs/guide/api-environment-instances.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Using `Environment` Instances
22

3-
:::warning Experimental
4-
Environment API is experimental. We'll still maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
3+
:::info Release Candidate
4+
The Environment API is generally in the release candidate phase. We'll maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. However, note that [some specific APIs](/changes/#considering) are still considered experimental.
5+
6+
We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
57

68
Resources:
79

docs/guide/api-environment-plugins.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Environment API for Plugins
22

3-
:::warning Experimental
4-
Environment API is experimental. We'll still maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
3+
:::info Release Candidate
4+
The Environment API is generally in the release candidate phase. We'll maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. However, note that [some specific APIs](/changes/#considering) are still considered experimental.
5+
6+
We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
57

68
Resources:
79

docs/guide/api-environment-runtimes.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Environment API for Runtimes
22

3-
:::warning Experimental
4-
Environment API is experimental. We'll still maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
3+
:::info Release Candidate
4+
The Environment API is generally in the release candidate phase. We'll maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. However, note that [some specific APIs](/changes/#considering) are still considered experimental.
5+
6+
We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
57

68
Resources:
79

docs/guide/api-environment.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Environment API
22

3-
:::warning Experimental
4-
Environment API is experimental. We'll still maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
3+
:::info Release Candidate
4+
The Environment API is generally in the release candidate phase. We'll maintain stability in the APIs between major releases to allow the ecosystem to experiment and build upon them. However, note that [some specific APIs](/changes/#considering) are still considered experimental.
5+
6+
We plan to stabilize these new APIs (with potential breaking changes) in a future major release once downstream projects have had time to experiment with the new features and validate them.
57

68
Resources:
79

@@ -13,7 +15,7 @@ Please share your feedback with us.
1315

1416
## Formalizing Environments
1517

16-
Vite 6 formalizes the concept of Environments. Until Vite 5, there were two implicit Environments (`client`, and optionally `ssr`). The new Environment API allows users and framework authors to create as many environments as needed to map the way their apps work in production. This new capability required a big internal refactoring, but a lot of effort has been placed on backward compatibility. The initial goal of Vite 6 is to move the ecosystem to the new major as smoothly as possible, delaying the adoption of these new experimental APIs until enough users have migrated and frameworks and plugin authors have validated the new design.
18+
Vite 6 formalizes the concept of Environments. Until Vite 5, there were two implicit Environments (`client`, and optionally `ssr`). The new Environment API allows users and framework authors to create as many environments as needed to map the way their apps work in production. This new capability required a big internal refactoring, but a lot of effort has been placed on backward compatibility. The initial goal of Vite 6 is to move the ecosystem to the new major as smoothly as possible, delaying the adoption of the APIs until enough users have migrated and frameworks and plugin authors have validated the new design.
1719

1820
## Closing the Gap Between Build and Dev
1921

@@ -117,7 +119,7 @@ export default {
117119

118120
## Backward Compatibility
119121

120-
The current Vite server API are not yet deprecated and are backward compatible with Vite 5. The new Environment API is experimental.
122+
The current Vite server API is not yet deprecated and is backward compatible with Vite 5.
121123

122124
The `server.moduleGraph` returns a mixed view of the client and ssr module graphs. Backward compatible mixed module nodes will be returned from all its methods. The same scheme is used for the module nodes passed to `handleHotUpdate`.
123125

0 commit comments

Comments
 (0)