Skip to content

Commit dc0d3f5

Browse files
committed
Update Environment API guides
Closes #67 Closes #69
1 parent 18999f8 commit dc0d3f5

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

docs/guide/api-environment-frameworks.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Environment API для фреймворков {#environment-api-for-frameworks}
22

33
:::warning Экспериментально
4-
Environment API является экспериментальным. Мы будем поддерживать стабильность API в Vite 6, чтобы дать экосистеме возможность экспериментировать и строить на его основе. Мы планируем стабилизировать эти новые API с возможными изменениями, нарушающими обратную совместимость, в Vite 7.
4+
Environment API находится на экспериментальной стадии. Мы будем сохранять стабильность API между крупными релизами, чтобы дать экосистеме возможность экспериментировать и развивать их. Планируется стабилизировать эти новые API (с возможными значительными изменениями) в будущем крупном релизе после того, как проекты-потребители смогут протестировать новые функции и подтвердить их работоспособность.
55

66
Ресурсы:
77

88
- [Обсуждение отзывов](https://github.com/vitejs/vite/discussions/16358), где мы собираем отзывы о новых API.
9-
- [PR Environment API](https://github.com/vitejs/vite/pull/16471), где новый API был реализован и рассмотрен.
9+
- [Пулреквест](https://github.com/vitejs/vite/pull/16471), в котором новый API был реализован и рассмотрен.
1010

1111
Пожалуйста, поделитесь с нами своим мнением.
1212
:::
@@ -88,7 +88,7 @@ Vite выполняет валидацию входных и выходных д
8888

8989
## `RunnableDevEnvironment` по умолчанию {#default-runnabledevenvironment}
9090

91-
Учитывая сервер Vite, настроенный в режиме мидлвара, как описано в [руководстве по настройке SSR](/guide/ssr#setting-up-the-dev-server), давайте реализуем мидлвар SSR, используя Environment API. Обработка ошибок опущена.
91+
Учитывая сервер Vite, настроенный в режиме мидлвара, как описано в [руководстве по настройке SSR](/guide/ssr#setting-up-the-dev-server), давайте реализуем мидлвар SSR, используя Environment API. Помните, что это не обязательно должно называться `ssr`, поэтому в этом примере мы назовём его `server`. Обработка ошибок опущена.
9292

9393
```js
9494
import fs from 'node:fs'
@@ -98,7 +98,7 @@ import { createServer } from 'vite'
9898

9999
const __dirname = path.dirname(fileURLToPath(import.meta.url))
100100

101-
const server = await createServer({
101+
const viteServer = await createServer({
102102
server: { middlewareMode: true },
103103
appType: 'custom',
104104
environments: {
@@ -110,7 +110,7 @@ const server = await createServer({
110110

111111
// Возможно, вам потребуется привести это к RunnableDevEnvironment в TypeScript или
112112
// использовать isRunnableDevEnvironment для защиты доступа к runner
113-
const environment = server.environments.node
113+
const serverEnvironment = viteServer.environments.server
114114

115115
app.use('*', async (req, res, next) => {
116116
const url = req.originalUrl
@@ -122,12 +122,14 @@ app.use('*', async (req, res, next) => {
122122
// 2. Применение HTML-преобразований Vite. Это внедряет клиент HMR Vite,
123123
// а также применяет HTML-преобразования от плагинов Vite, например,
124124
// глобальные преамбулы от @vitejs/plugin-react
125-
template = await server.transformIndexHtml(url, template)
125+
template = await viteServer.transformIndexHtml(url, template)
126126

127127
// 3. Загрузка серверного входа. import(url) автоматически преобразует
128128
// исходный код ESM для использования в Node.js! Не требуется сборка,
129129
// и обеспечивается полная поддержка HMR.
130-
const { render } = await environment.runner.import('/src/entry-server.js')
130+
const { render } = await serverEnvironment.runner.import(
131+
'/src/entry-server.js',
132+
)
131133

132134
// 4. Рендеринг HTML приложения. Это предполагает, что экспортированная
133135
// функция `render` entry-server.js вызывает соответствующие API SSR фреймворка,

docs/guide/api-environment-instances.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Использование экземпляров `Environment` {#using-environment-instances}
22

33
:::warning Экспериментально
4-
Environment API является экспериментальным. Мы будем поддерживать стабильность API в Vite 6, чтобы дать экосистеме возможность экспериментировать и строить на его основе. Мы планируем стабилизировать эти новые API с возможными изменениями, нарушающими обратную совместимость, в Vite 7.
4+
Environment API находится на экспериментальной стадии. Мы будем сохранять стабильность API между крупными релизами, чтобы дать экосистеме возможность экспериментировать и развивать их. Планируется стабилизировать эти новые API (с возможными значительными изменениями) в будущем крупном релизе после того, как проекты-потребители смогут протестировать новые функции и подтвердить их работоспособность.
55

66
Ресурсы:
77

88
- [Обсуждение отзывов](https://github.com/vitejs/vite/discussions/16358), где мы собираем отзывы о новых API.
9-
- [PR Environment API](https://github.com/vitejs/vite/pull/16471), где новый API был реализован и рассмотрен.
9+
- [Пулреквест](https://github.com/vitejs/vite/pull/16471), в котором новый API был реализован и рассмотрен.
1010

1111
Пожалуйста, поделитесь с нами своим мнением.
1212
:::
@@ -19,8 +19,8 @@ Environment API является экспериментальным. Мы буд
1919
// создайте сервер или получите его из хука configureServer
2020
const server = await createServer(/* options */)
2121

22-
const environment = server.environments.client
23-
environment.transformRequest(url)
22+
const clientEnvironment = server.environments.client
23+
clientEnvironment.transformRequest(url)
2424
console.log(server.environments.ssr.moduleGraph)
2525
```
2626

docs/guide/api-environment-plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Environment API для плагинов {#environment-api-for-plugins}
22

33
:::warning Экспериментально
4-
Environment API является экспериментальным. Мы будем поддерживать стабильность API в Vite 6, чтобы дать экосистеме возможность экспериментировать и строить на его основе. Мы планируем стабилизировать эти новые API с возможными изменениями, нарушающими обратную совместимость, в Vite 7.
4+
Environment API находится на экспериментальной стадии. Мы будем сохранять стабильность API между крупными релизами, чтобы дать экосистеме возможность экспериментировать и развивать их. Планируется стабилизировать эти новые API (с возможными значительными изменениями) в будущем крупном релизе после того, как проекты-потребители смогут протестировать новые функции и подтвердить их работоспособность.
55

66
Ресурсы:
77

88
- [Обсуждение отзывов](https://github.com/vitejs/vite/discussions/16358), где мы собираем отзывы о новых API.
9-
- [PR Environment API](https://github.com/vitejs/vite/pull/16471), где новый API был реализован и рассмотрен.
9+
- [Пулреквест](https://github.com/vitejs/vite/pull/16471), в котором новый API был реализован и рассмотрен.
1010

1111
Пожалуйста, поделитесь с нами своим мнением.
1212
:::
@@ -197,7 +197,7 @@ export default defineConfig({
197197
198198
Это заставляло фреймворки делиться состоянием между сборкой `client` и сборкой `ssr` через манифесты, записанные в файловую систему. В Vite 6 мы теперь собираем все окружения в одном процессе, поэтому способ работы конвейера плагинов и коммуникации между окружениями может быть согласован с разработкой.
199199
200-
В будущем крупном обновлении (Vite 7 или 8) мы стремимся к полной согласованности:
200+
В будущем крупном релизе мы сможем достичь полного соответствия:
201201
202202
- **Во время разработки и сборки:** плагины общие, с [фильтрацией по окружению](#per-environment-plugins)
203203

docs/guide/api-environment-runtimes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Environment API для сред выполнения {#environment-api-for-runtimes}
22

33
:::warning Экспериментально
4-
Environment API является экспериментальным. Мы будем поддерживать стабильность API в Vite 6, чтобы дать экосистеме возможность экспериментировать и строить на его основе. Мы планируем стабилизировать эти новые API с возможными изменениями, нарушающими обратную совместимость, в Vite 7.
4+
Environment API находится на экспериментальной стадии. Мы будем сохранять стабильность API между крупными релизами, чтобы дать экосистеме возможность экспериментировать и развивать их. Планируется стабилизировать эти новые API (с возможными значительными изменениями) в будущем крупном релизе после того, как проекты-потребители смогут протестировать новые функции и подтвердить их работоспособность.
55

66
Ресурсы:
77

88
- [Обсуждение отзывов](https://github.com/vitejs/vite/discussions/16358), где мы собираем отзывы о новых API.
9-
- [PR Environment API](https://github.com/vitejs/vite/pull/16471), где новый API был реализован и рассмотрен.
9+
- [Пулреквест](https://github.com/vitejs/vite/pull/16471), в котором новый API был реализован и рассмотрен.
1010

1111
Пожалуйста, поделитесь с нами своим мнением.
1212
:::

docs/guide/api-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Environment API {#environment-api}
22

33
:::warning Экспериментально
4-
Environment API является экспериментальным. Мы будем поддерживать стабильность API в Vite 6, чтобы дать экосистеме возможность экспериментировать и строить на его основе. Мы планируем стабилизировать эти новые API с возможными изменениями, нарушающими обратную совместимость, в Vite 7.
4+
Environment API находится на экспериментальной стадии. Мы будем сохранять стабильность API между крупными релизами, чтобы дать экосистеме возможность экспериментировать и развивать их. Планируется стабилизировать эти новые API (с возможными значительными изменениями) в будущем крупном релизе после того, как проекты-потребители смогут протестировать новые функции и подтвердить их работоспособность.
55

66
Ресурсы:
77

88
- [Обсуждение отзывов](https://github.com/vitejs/vite/discussions/16358), где мы собираем отзывы о новых API.
9-
- [PR Environment API](https://github.com/vitejs/vite/pull/16471), где новый API был реализован и рассмотрен.
9+
- [Пулреквест](https://github.com/vitejs/vite/pull/16471), в котором новый API был реализован и рассмотрен.
1010

1111
Пожалуйста, поделитесь с нами своим мнением.
1212
:::
@@ -22,7 +22,7 @@ Vite 6 формализует концепцию окружений. До Vite 5
2222
Когда мы переходим к типичному приложению с серверной отрисовкой (SSR), у нас будет два окружения:
2323

2424
- `client`: запускает приложение в браузере.
25-
- `server`: запускает приложение в Node (или других средах выполнения сервера), которое отрисовывает страницы перед их отправкой в браузер.
25+
- `ssr`: запускает приложение в Node (или других средах выполнения сервера), которое отрисовывает страницы перед их отправкой в браузер.
2626

2727
В режиме разработки Vite выполняет серверный код в том же процессе Node, что и dev-сервер Vite, что дает близкое приближение к продакшен-среде. Однако также возможно, чтобы серверы работали в других средах выполнения JS, таких как [workerd от Cloudflare](https://github.com/cloudflare/workerd), которые имеют другие ограничения. Современные приложения могут также работать более чем в двух окружениях, например, в браузере, на сервере Node и на краевом сервере. Vite 5 не позволял должным образом представлять эти окружения.
2828

0 commit comments

Comments
 (0)