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.

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

[SYNC] refactor: deprecate polyfillDynamicImport (#4373) #31

Closed
github-actions bot opened this issue Jul 28, 2021 · 0 comments · Fixed by #34
Closed

[SYNC] refactor: deprecate polyfillDynamicImport (#4373) #31

github-actions bot opened this issue Jul 28, 2021 · 0 comments · Fixed by #34
Labels

Comments

@github-actions
Copy link
Contributor

refactor: deprecate polyfillDynamicImport (#4373) (318cb43)


+++ b/docs/config/index.md
@@ -55,7 +55,7 @@ Vite also directly supports TS config files. You can use `vite.config.ts` with t
If the config needs to conditional determine options based on the command (`serve` or `build`) or the [mode](/guide/env-and-mode) being used, it can export a function instead:
```js
-export default ({ command, mode }) => {
+export default defineConfig(({ command, mode }) => {
if (command === 'serve') {
return {
// serve specific config
@@ -65,7 +65,7 @@ export default ({ command, mode }) => {
// build specific config
}
}
-}
+})
```
### Async Config
@@ -73,7 +73,7 @@ export default ({ command, mode }) => {
If the config needs to call async function, it can export a async function instead:
```js
-export default async ({ command, mode }) => {
+export default defineConfig(async ({ command, mode }) => {
const data = await asyncFunction()
return {
// build specific config
@@ -242,7 +242,7 @@ export default async ({ command, mode }) => {
Specify options to pass to CSS pre-processors. Example:
```js
-  export default {
+  export default defineConfig({
css: {
preprocessorOptions: {
scss: {
@@ -250,7 +250,7 @@ export default async ({ command, mode }) => {
}
}
}
-  }
+  })
```
### json.namedExports
@@ -276,12 +276,12 @@ export default async ({ command, mode }) => {
`ESBuildOptions` extends [ESbuild's own transform options](https://esbuild.github.io/api/#transform-api). The most common use case is customizing JSX:
```js
-  export default {
+  export default defineConfig({
esbuild: {
jsxFactory: 'h',
jsxFragment: 'Fragment'
}
-  }
+  })
```
By default, ESBuild is applied to `ts`, `jsx` and `tsx` files. You can customize this with `esbuild.include` and `esbuild.exclude`, both of which expect type of `string | RegExp | (string | RegExp)[]`.
@@ -289,11 +289,11 @@ export default async ({ command, mode }) => {
In addition, you can also use `esbuild.jsxInject` to automatically inject JSX helper imports for every file transformed by ESBuild:
```js
-  export default {
+  export default defineConfig({
esbuild: {
jsxInject: `import React from 'react'`
}
-  }
+  })
```
Set to `false` to disable ESbuild transforms.
@@ -374,11 +374,11 @@ export default async ({ command, mode }) => {
**Example:**
```js
-  export default {
+  export default defineConfig({
server: {
open: '/docs/index.html'
}
-  }
+  })
```
### server.proxy
@@ -392,7 +392,7 @@ export default async ({ command, mode }) => {
**Example:**
```js
-  export default {
+  export default defineConfig({
server: {
proxy: {
// string shorthand
@@ -419,7 +419,7 @@ export default async ({ command, mode }) => {
}
}
}
-  }
+  })
```
### server.cors
@@ -514,14 +514,14 @@ createServer()
Accepts a path to specify the custom workspace root. Could be a absolute path or a path relative to [project root](/guide/#index-html-and-project-root). For example
```js
-  export default {
+  export default defineConfig({
server: {
fs: {
// Allow serving files from one level up to the project root
allow: ['..']
}
}
-  }
+  })
```
## Build Options
@@ -543,23 +543,6 @@ createServer()
Note the build will fail if the code contains features that cannot be safely transpiled by esbuild. See [esbuild docs](https://esbuild.github.io/content-types/#javascript) for more details.
-### build.polyfillDynamicImport
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-  Whether to automatically inject [dynamic import polyfill](https://github.com/GoogleChromeLabs/dynamic-import-polyfill).
-
-  If set to true, the polyfill is auto injected into the proxy module of each `index.html` entry. If the build is configured to use a non-html custom entry via `build.rollupOptions.input`, then it is necessary to manually import the polyfill in your custom entry:
-
-  ```js
-  import 'vite/dynamic-import-polyfill'
-  ```
-
-  When using [`@vitejs/plugin-legacy`](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy), the plugin sets this option to `true` automatically.
-
-  Note: the polyfill does **not** apply to [Library Mode](/guide/build#library-mode). If you need to support browsers without native dynamic import, you should probably avoid using it in your library.
-
### build.outDir
- **Type:** `string`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

0 participants