Skip to content

Beyond Fast

ViteConf 2023

Watch the replay!

依存関係の最適化オプション

optimizeDeps.entries

  • 型: string | string[]

デフォルトでは、Vite はすべての .html ファイルをクロールして、事前にバンドルする必要のある依存関係を検出します(node_modules, build.outDir, __tests__ および coverage は無視します)。build.rollupOptions.input が指定されている場合、Vite は代わりにそれらのエントリーポイントをクロールします。

これらのいずれもニーズに合わない場合、このオプションを使ってカスタムエントリーを指定することができます。値は Vite プロジェクトルートからの相対的な fast-glob パターン か、パターンの配列でなければいけません。これによりデフォルトのエントリーの推論が上書きされます。optimizeDeps.entries が明示的に定義されている場合、デフォルトでは node_modulesbuild.outDir フォルダーのみが無視されます。他のフォルダーを無視したい場合は、最初の ! でマークした無視パターンをエントリーリストの一部として使用できます。

optimizeDeps.exclude

  • 型: string[]

事前バンドルから除外する依存関係。

CommonJS

CommonJS の依存関係を最適化から除外してはいけません。ESM の依存関係が最適化から除外されているが、ネストされた CommonJS の依存関係がある場合は、CommonJS の依存関係を optimizeDeps.include に追加する必要があります。例:

js
export default defineConfig({
  optimizeDeps: {
    include: ['esm-dep > cjs-dep'],
  },
})
export default defineConfig({
  optimizeDeps: {
    include: ['esm-dep > cjs-dep'],
  },
})

optimizeDeps.include

  • 型: string[]

デフォルトでは、リンクされたパッケージのうち node_modules の外にあるものは事前バンドルされません。このオプションを使用してリンクされたパッケージを強制的に事前バンドルします。

実験的機能: 多くのディープインポートを持つライブラリーを使用している場合、末尾に glob パターンを指定して、すべてのディープインポートを一度に事前バンドルすることもできます。これにより、新たにディープインポートが使用されるたびに常に事前バンドルされることを避けることができます。フィードバックをしてください。例:

js
export default defineConfig({
  optimizeDeps: {
    include: ["my-lib/components/**/*.vue"],
  },
});
export default defineConfig({
  optimizeDeps: {
    include: ["my-lib/components/**/*.vue"],
  },
});

optimizeDeps.esbuildOptions

  • 型: Omit<EsbuildBuildOptions, | 'bundle' | 'entryPoints' | 'external' | 'write' | 'watch' | 'outdir' | 'outfile' | 'outbase' | 'outExtension' | 'metafile'>

依存関係のスキャンと最適化の際、 esbuild に渡すオプション。

いくつかのオプションは、変更すると Vite の依存関係の最適化と互換性がなくなるため、省略されています。

  • external も省略されています。Vite の optimizeDeps.exclude オプションを使用してください
  • plugins は Vite の依存関係プラグインとマージされます

optimizeDeps.force

  • 型: boolean

true に設定すると、前にキャッシュされた最適化された依存関係を無視して、依存関係の事前バンドルをするよう強制します。

optimizeDeps.holdUntilCrawlEnd

有効化すると、コールドスタート時にすべての静的インポートがクロールされるまで、最初に最適化された依存関係の結果を保持します。これにより、新しい依存関係が発見されて、それが新しい共通チャンクの生成をトリガーしたときに、ページ全体をリロードする必要がなくなります。もしすべての依存関係が include で明示的に定義されていて、それらがすべてスキャナーで検出された場合は、このオプションを無効化して、ブラウザープロセスがより多くのリクエストを並列に処理できるようにすることをおすすめします。

optimizeDeps.disabled

このオプションは非推奨です。Vite 5.1 時点で、ビルド中の依存関係の事前バンドルは削除されています。optimizeDeps.disabledtrue または 'dev' に設定するとオプティマイザーが無効になり、false または 'build' に設定すると開発中のオプティマイザーは有効のままになります。

オプティマイザーを完全に無効化するには、optimizeDeps.noDiscovery: true を使用して依存関係の自動検出を禁止し、optimizeDeps.include を undefined または空のままにしてください。

WARNING

ビルド時の依存関係の最適化は実験的な機能でした。この戦略を試したプロジェクトでは、build.commonjsOptions: { include: [] } を使用して @rollup/plugin-commonjs も削除しました。もし削除していた場合、バンドル中に CJS のみのパッケージをサポートするために、再び有効にするよう警告が表示されます。

optimizeDeps.needsInterop

  • 実験的機能
  • 型: string[]

依存関係をインポートする際に、ESM の相互作用を強制します。Vite は依存関係が相互作用を必要とする場合に適切に検出することができるため、このオプションは一般的には必要ありません。しかし、依存関係の組み合わせが異なると、いくつかのパッケージが異なる形で事前にバンドルされる可能性があります。これらのパッケージを needsInterop に追加すると、全ページの再読み込みを回避してコールドスタートを高速化することができます。依存関係のあるパッケージがそうである場合、警告が表示され、パッケージ名を設定内のこの配列に追加するよう提案されます。

Released under the MIT License. (f04c1689)