From 58bfde73af61e06ff72c2b1657d7f08490454450 Mon Sep 17 00:00:00 2001 From: Patrick Patenaude <69786203+Kamaiko@users.noreply.github.com> Date: Mon, 5 Jan 2026 20:31:39 -0500 Subject: [PATCH 1/2] docs: fix grammar and typos across documentation (#21360) --- blog/announcing-vite3.md | 2 +- blog/announcing-vite4.md | 2 +- changes/ssr-using-modulerunner.md | 2 +- guide/api-environment-frameworks.md | 2 +- guide/api-environment-instances.md | 2 +- guide/api-environment-plugins.md | 8 ++++---- guide/api-environment-runtimes.md | 2 +- guide/api-environment.md | 2 +- guide/api-plugin.md | 6 +++--- guide/assets.md | 2 +- guide/backend-integration.md | 2 +- guide/dep-pre-bundling.md | 2 +- guide/env-and-mode.md | 2 +- guide/features.md | 2 +- guide/index.md | 2 +- guide/migration.md | 2 +- guide/ssr.md | 2 +- guide/troubleshooting.md | 2 +- plugins/index.md | 2 +- 19 files changed, 24 insertions(+), 24 deletions(-) diff --git a/blog/announcing-vite3.md b/blog/announcing-vite3.md index c10855eb..bc550e54 100644 --- a/blog/announcing-vite3.md +++ b/blog/announcing-vite3.md @@ -255,7 +255,7 @@ We have worked closely with projects in the ecosystem to ensure that frameworks Vite 3 is the result of the aggregate effort of members of the [Vite Team](/team) working together with ecosystem project maintainers and other collaborators to Vite core. -We want to thank everyone that have implemented features, and fixes, given feedback, and have been involved in Vite 3: +We want to thank everyone who has implemented features, and fixes, given feedback, and have been involved in Vite 3: - Vite team members [@youyuxi](https://twitter.com/youyuxi), [@patak_dev](https://twitter.com/patak_dev), [@antfu7](https://twitter.com/antfu7), [@bluwyoo](https://twitter.com/bluwyoo), [@sapphi_red](https://twitter.com/sapphi_red), [@haoqunjiang](https://twitter.com/haoqunjiang), [@poyoho](https://github.com/poyoho), [@Shini_92](https://twitter.com/Shini_92), and [@retropragma](https://twitter.com/retropragma). - [@benmccann](https://github.com/benmccann), [@danielcroe](https://twitter.com/danielcroe), [@brillout](https://twitter.com/brillout), [@sheremet_va](https://twitter.com/sheremet_va), [@userquin](https://twitter.com/userquin), [@enzoinnocenzi](https://twitter.com/enzoinnocenzi), [@maximomussini](https://twitter.com/maximomussini), [@IanVanSchooten](https://twitter.com/IanVanSchooten), the [Astro team](https://astro.build/), and all other maintainers of frameworks and plugins in the ecosystem in that helped shape v3. diff --git a/blog/announcing-vite4.md b/blog/announcing-vite4.md index dc1f428f..286d3f02 100644 --- a/blog/announcing-vite4.md +++ b/blog/announcing-vite4.md @@ -131,7 +131,7 @@ Vite cares about its footprint, to speed up installation, especially in the use Vite 4 wouldn't be possible without uncountable hours of work by Vite contributors, many of them maintainers of downstream projects and plugins, and the efforts of the [Vite Team](/team). All of us have worked together to improve Vite's DX once more, for every framework and app using it. We're grateful to be able to improve a common base for such a vibrant ecosystem. -We're also thankful to individuals and companies sponsoring the Vite team, and companies investing directly in Vite's future: [@antfu7](https://twitter.com/antfu7)'s work on Vite and the ecosystem is part of his job at [Nuxt Labs](https://nuxtlabs.com/), [Astro](https://astro.build) is funding [@bluwyoo](https://twitter.com/bluwyoo)'s' Vite core work, and [StackBlitz](https://stackblitz.com/) hires [@patak_dev](https://twitter.com/patak_dev) to work full time on Vite. +We're also thankful to individuals and companies sponsoring the Vite team, and companies investing directly in Vite's future: [@antfu7](https://twitter.com/antfu7)'s work on Vite and the ecosystem is part of his job at [Nuxt Labs](https://nuxtlabs.com/), [Astro](https://astro.build) is funding [@bluwyoo](https://twitter.com/bluwyoo)'s Vite core work, and [StackBlitz](https://stackblitz.com/) hires [@patak_dev](https://twitter.com/patak_dev) to work full time on Vite. ## Next steps diff --git a/changes/ssr-using-modulerunner.md b/changes/ssr-using-modulerunner.md index f1add2ca..05ca53f1 100644 --- a/changes/ssr-using-modulerunner.md +++ b/changes/ssr-using-modulerunner.md @@ -20,4 +20,4 @@ The `server.ssrLoadModule(url)` only allows importing modules in the `ssr` e Check out the [Environment API for Frameworks Guide](../guide/api-environment-frameworks.md). -`server.ssrFixStacktrace` and `server.ssrRewriteStacktrace` does not have to be called when using the Module Runner APIs. The stack traces will be updated unless `sourcemapInterceptor` is set to `false`. +`server.ssrFixStacktrace` and `server.ssrRewriteStacktrace` do not have to be called when using the Module Runner APIs. The stack traces will be updated unless `sourcemapInterceptor` is set to `false`. diff --git a/guide/api-environment-frameworks.md b/guide/api-environment-frameworks.md index 59fe4891..ee29e0d9 100644 --- a/guide/api-environment-frameworks.md +++ b/guide/api-environment-frameworks.md @@ -8,7 +8,7 @@ We plan to stabilize these new APIs (with potential breaking changes) in a futur Resources: - [Feedback discussion](https://github.com/vitejs/vite/discussions/16358) where we are gathering feedback about the new APIs. -- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new API were implemented and reviewed. +- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new APIs were implemented and reviewed. Please share your feedback with us. ::: diff --git a/guide/api-environment-instances.md b/guide/api-environment-instances.md index 9c459250..8f750d16 100644 --- a/guide/api-environment-instances.md +++ b/guide/api-environment-instances.md @@ -8,7 +8,7 @@ We plan to stabilize these new APIs (with potential breaking changes) in a futur Resources: - [Feedback discussion](https://github.com/vitejs/vite/discussions/16358) where we are gathering feedback about the new APIs. -- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new API were implemented and reviewed. +- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new APIs were implemented and reviewed. Please share your feedback with us. ::: diff --git a/guide/api-environment-plugins.md b/guide/api-environment-plugins.md index 5b196963..4de22056 100644 --- a/guide/api-environment-plugins.md +++ b/guide/api-environment-plugins.md @@ -8,7 +8,7 @@ We plan to stabilize these new APIs (with potential breaking changes) in a futur Resources: - [Feedback discussion](https://github.com/vitejs/vite/discussions/16358) where we are gathering feedback about the new APIs. -- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new API were implemented and reviewed. +- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new APIs were implemented and reviewed. Please share your feedback with us. ::: @@ -47,7 +47,7 @@ Plugins can add new environments in the `config` hook. For example, [RSC support } ``` -An empty object is enough to register the environment, default values from the root level environment config. +An empty object is enough to register the environment, using default values from the root level environment config. ## Configuring Environment Using Hooks @@ -233,13 +233,13 @@ The `applyToEnvironment` hook is called at config time, currently after `configR :::warning Note -Note that this feature is only available for environments that supports HMR. +Note that this feature is only available for environments that support HMR. ::: ### Managing the Application Instances -Be aware that there might be multiple application instances running in the same environment. For example, if you multiple tabs open in the browser, each tab is a separate application instance and have a separate connection to the server. +Be aware that there might be multiple application instances running in the same environment. For example, if you have multiple tabs open in the browser, each tab is a separate application instance and has a separate connection to the server. When a new connection is established, a `vite:client:connect` event is emitted on the environment's `hot` instance. When the connection is closed, a `vite:client:disconnect` event is emitted. diff --git a/guide/api-environment-runtimes.md b/guide/api-environment-runtimes.md index e09076a0..36bc4585 100644 --- a/guide/api-environment-runtimes.md +++ b/guide/api-environment-runtimes.md @@ -8,7 +8,7 @@ We plan to stabilize these new APIs (with potential breaking changes) in a futur Resources: - [Feedback discussion](https://github.com/vitejs/vite/discussions/16358) where we are gathering feedback about the new APIs. -- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new API were implemented and reviewed. +- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new APIs were implemented and reviewed. Please share your feedback with us. ::: diff --git a/guide/api-environment.md b/guide/api-environment.md index bfc0a7f1..cece410e 100644 --- a/guide/api-environment.md +++ b/guide/api-environment.md @@ -8,7 +8,7 @@ We plan to stabilize these new APIs (with potential breaking changes) in a futur Resources: - [Feedback discussion](https://github.com/vitejs/vite/discussions/16358) where we are gathering feedback about the new APIs. -- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new API were implemented and reviewed. +- [Environment API PR](https://github.com/vitejs/vite/pull/16471) where the new APIs were implemented and reviewed. Please share your feedback with us. ::: diff --git a/guide/api-plugin.md b/guide/api-plugin.md index e3715749..a6b88681 100644 --- a/guide/api-plugin.md +++ b/guide/api-plugin.md @@ -8,7 +8,7 @@ Vite plugins extends Rollup's well-designed plugin interface with a few extra Vi ## Authoring a Plugin -Vite strives to offer established patterns out of the box, so before creating a new plugin make sure that you check the [Features guide](/guide/features) to see if your need is covered. Also review available community plugins, both in the form of a [compatible Rollup plugin](https://github.com/rollup/awesome) and [Vite Specific plugins](https://github.com/vitejs/awesome-vite#plugins) +Vite strives to offer established patterns out of the box, so before creating a new plugin make sure that you check the [Features guide](/guide/features) to see if your need is covered. Also review available community plugins, both in the form of a [compatible Rollup plugin](https://github.com/rollup/awesome) and [Vite Specific plugins](https://github.com/vitejs/awesome-vite#plugins). When creating a plugin, you can inline it in your `vite.config.js`. There is no need to create a new package for it. Once you see that a plugin was useful in your projects, consider sharing it to help others [in the ecosystem](https://chat.vite.dev). @@ -24,7 +24,7 @@ If the plugin doesn't use Vite specific hooks and can be implemented as a [Compa - Rollup Plugins should have a clear name with `rollup-plugin-` prefix. - Include `rollup-plugin` and `vite-plugin` keywords in package.json. -This exposes the plugin to be also used in pure Rollup or WMR based projects +This exposes the plugin to be also used in pure Rollup or WMR based projects. For Vite only plugins @@ -32,7 +32,7 @@ For Vite only plugins - Include `vite-plugin` keyword in package.json. - Include a section in the plugin docs detailing why it is a Vite only plugin (for example, it uses Vite specific plugin hooks). -If your plugin is only going to work for a particular framework, its name should be included as part of the prefix +If your plugin is only going to work for a particular framework, its name should be included as part of the prefix. - `vite-plugin-vue-` prefix for Vue Plugins - `vite-plugin-react-` prefix for React Plugins diff --git a/guide/assets.md b/guide/assets.md index e6b4b676..5bb9c0c9 100644 --- a/guide/assets.md +++ b/guide/assets.md @@ -140,7 +140,7 @@ function getImageUrl(name) { } ``` -During the production build, Vite will perform necessary transforms so that the URLs still point to the correct location even after bundling and asset hashing. However, the URL string must be static so it can be analyzed, otherwise the code will be left as is, which can cause runtime errors if `build.target` does not support `import.meta.url` +During the production build, Vite will perform necessary transforms so that the URLs still point to the correct location even after bundling and asset hashing. However, the URL string must be static so it can be analyzed, otherwise the code will be left as is, which can cause runtime errors if `build.target` does not support `import.meta.url`. ```js // Vite will not transform this diff --git a/guide/backend-integration.md b/guide/backend-integration.md index c4419538..a5bf910e 100644 --- a/guide/backend-integration.md +++ b/guide/backend-integration.md @@ -3,7 +3,7 @@ :::tip Note If you want to serve the HTML using a traditional backend (e.g. Rails, Laravel) but use Vite for serving assets, check for existing integrations listed in [Awesome Vite](https://github.com/vitejs/awesome-vite#integrations-with-backends). -If you need a custom integration, you can follow the steps in this guide to configure it manually +If you need a custom integration, you can follow the steps in this guide to configure it manually. ::: 1. In your Vite config, configure the entry and enable build manifest: diff --git a/guide/dep-pre-bundling.md b/guide/dep-pre-bundling.md index ce5dac20..74918650 100644 --- a/guide/dep-pre-bundling.md +++ b/guide/dep-pre-bundling.md @@ -57,7 +57,7 @@ A typical use case for `optimizeDeps.include` or `optimizeDeps.exclude` is when Both `include` and `exclude` can be used to deal with this. If the dependency is large (with many internal modules) or is CommonJS, then you should include it; If the dependency is small and is already valid ESM, you can exclude it and let the browser load it directly. -You can further customize esbuild too with the [`optimizeDeps.rolldownOptions` option](/config/dep-optimization-options.md#optimizedeps-rolldownoptions). For example, adding an Rolldown plugin to handle special files in dependencies or changing the [build `target`](https://esbuild.github.io/api/#target). +You can further customize esbuild too with the [`optimizeDeps.rolldownOptions` option](/config/dep-optimization-options.md#optimizedeps-rolldownoptions). For example, adding a Rolldown plugin to handle special files in dependencies or changing the [build `target`](https://esbuild.github.io/api/#target). diff --git a/guide/env-and-mode.md b/guide/env-and-mode.md index 48cbfa29..07d15fc5 100644 --- a/guide/env-and-mode.md +++ b/guide/env-and-mode.md @@ -110,7 +110,7 @@ VITE_BAR=bar ``` This does not work in shell scripts and other tools like `docker compose`. -That said, Vite supports this behavior as this has been supported by `dotenv-expand` for a long time and other tools in JavaScript ecosystem uses older versions that supports this behavior. +That said, Vite supports this behavior as this has been supported by `dotenv-expand` for a long time and other tools in JavaScript ecosystem use older versions that support this behavior. To avoid interop issues, it is recommended to avoid relying on this behavior. Vite may start emitting warnings for this behavior in the future. diff --git a/guide/features.md b/guide/features.md index 0d258cff..1c8d2680 100644 --- a/guide/features.md +++ b/guide/features.md @@ -330,7 +330,7 @@ npm add -D stylus If using Vue single file components, this also automatically enables `