Vite 連携機能
Vite（ヴィート）は、モダンなWeb開発のための高速ビルドツールです。本CMSのテンプレートには、Viteでビルドしたファイルを簡単に読み込むための補助機能が組み込まれています。
使い方
a-blog cms で Vite を利用してバンドルしたファイルを読み込むためには、バックエンドとの統合で記載されている仕様に合わせて、script タグや link タグを出力する必要があります。
Vite 連携機能を使用することで、Vite の仕様に合わせてタグを出力することができるようになり、a-blog cms のテンプレート内で簡単に Vite を利用することができます。
Vite の設定
Vite の設定は vite.config.js に記述します。詳細は Vite のドキュメント を参照してください。
build.manifest を true に設定し、rollupOptions.input でエントリーポイントとなるファイルを指定します。 以下のサンプルは、themes/利用テーマ/src/js/main.js をエントリーポイントとして指定しています。
import { defineConfig } from 'vite';
export default defineConfig({
// ...
build: {
manifest: true,
rollupOptions: {
input: {
bundle: resolve(__dirname, 'src/js/main.js'),
},
},
},
});この設定をすることで、manifest.json にビルドされたアセットのパスが出力されるようになります。
スクリプトとスタイルの読み込み
Vite の設定が完了したら、a-blog cms のテンプレート内にスクリプトとスタイルを読み込むための記述を追加します。 head タグ内 @vite() を追加します。
<!DOCTYPE html>
<head>
@vite('src/js/main.js')
</head>複数のエントリーポイントを指定する場合は、配列で指定します。
<!DOCTYPE html>
<head>
@vite(['src/js/main.js', 'src/js/main.css'])
</head>twig テンプレートを利用している場合は vite 関数を利用できます。
<!DOCTYPE html>
<head>
{{ vite('src/js/main.js') }}
</head>twig で vite 関数を利用している場合に複数のエントリーポイントを指定する場合は、配列で指定します。
<!DOCTYPE html>
<head>
{{ vite(['src/js/main.js', 'src/js/main.css']) }}
</head>最後に、a-blog cms 設置ディレクトリにある .env ファイルを編集します。
以下のように VITE_ENVIRONMENT に development を指定します。
# Vite
VITE_ENVIRONMENT=development # development | productionこれで、Vite の開発サーバーからビルドされたアセットが読み込まれるようになります。
本番環境での利用
Vite で本番環境用ビルドしたアセットを読み込めるようにするためには、a-blog cms 設置ディレクトリにある .env ファイルを編集します。
以下のように VITE_ENVIRONMENT に production を指定します。
# Vite
VITE_ENVIRONMENT=production # development | production
これで、Vite で本番環境用ビルドしたアセットが読み込まれるようになります。
設定
@vite() の第2引数にJSON形式でオプションを指定することができます。
出力ディレクトリの設定
例えば、Vite の設定で build.outDir を bundle に設定している場合、以下のように記述します。
import { defineConfig } from 'vite';
export default defineConfig({
// ...
build: {
outDir: 'bundle',
},
});@vite() の第2引数に出力ディレクトリを指定します。
<!DOCTYPE html>
<head>
@vite('src/js/main.js', {
"outDir": "bundle"
})
</head>twig テンプレートを利用している場合は以下のように記述します。
<!DOCTYPE html>
<head>
{{ vite('src/js/main.js', {
outDir: 'bundle'
}) }}
</head>タグの属性をカスタマイズする
タグの属性をカスタマイズすることができます。
以下の例では、エントリーポイントから出力された script タグに async 属性を追加しています。
<!DOCTYPE html>
<head>
@vite('src/js/main.js', {
"scriptTagAttributes": {
"async": true
}
})
</head>また、link タグの属性もカスタマイズすることができます。 以下の例では、エントリーポイントから出力された link タグに type="text/css" 属性を追加しています。
<!DOCTYPE html>
<head>
@vite('src/styles/main.css', {
"linkTagAttributes": {
"type": "text/css"
}
})
</head>twig テンプレートを利用している場合は、以下になります。
<!DOCTYPE html>
<head>
{{ vite('src/js/main.js', {
scriptTagAttributes: {
async: true
}
}) }}
</head><!DOCTYPE html>
<head>
{{ vite('src/styles/main.css', {
linkTagAttributes: {
type: "text/css"
}
}) }}
</head>React の利用
React と @vitejs/plugin-react を利用する場合、既存の @vite と一緒に、追加で @viteReactRefresh を追加する必要があります。
<!DOCTYPE html>
<head>
@viteReactRefresh
@vite('src/js/main.jsx')
</head>@viteReactRefresh は、React の Hot Module Replacement を有効にするためのスクリプトを出力します。
<script type="module">
import RefreshRuntime from 'http://localhost:5173/@react-refresh'
RefreshRuntime.injectIntoGlobalHook(window)
window.$RefreshReg$ = () => {}
window.$RefreshSig$ = () => (type) => type
window.__vite_plugin_react_preamble_installed__ = true
</script>twig テンプレートを利用している場合は、以下のように記述します。
<!DOCTYPE html>
<head>
{{ viteReactRefresh() }}
{{ vite('src/js/main.jsx') }}
</head>グローバル変数
Vite 連携時の状態については、グローバル変数を用いて確認できます。
グローバル変数名 | 説明 |
|---|---|
| 現在の Vite の動作モードの値を出力します（
|
| Vite の開発サーバーの URL を出力します。 |
高度なカスタマイズ
環境変数を利用して、Vite の設定をカスタマイズすることができます。
a-blog cms設置ディレクトリにある .env ファイルを編集することで環境変数を設定します。
# Vite
VITE_ENVIRONMENT=production # development | production
VITE_MANIFEST_PATH=dist/.vite/manifest.json
VITE_DEV_SERVER_URL=http://localhost:5173以下、環境変数の説明です。
変数名 | 説明 |
|---|---|
|
|
|
|
| Vite の開発サーバーの URL を指定します。 |
