vite-pug-static-builder
Version:
Vite + Pugを使用した静的サイトビルダー - 複数のPugファイルを静的HTMLとしてビルドするViteプラグイン
358 lines (285 loc) • 8.81 kB
Markdown
# vite-pug-static-builder
[](./LICENSE)
[](https://www.typescriptlang.org/)
[](https://vitejs.dev/)
[](https://pugjs.org/)
[](https://vitest.dev/)
**[English](./README.md)** | **[中文](./README.zh-CN.md)**
**Vite 6 / 7 / 8 対応** — Vite + Pugを使用した高性能静的サイトビルダー
複数のPugファイルを効率的に静的HTMLファイルとしてビルドできる、最新のViteプラグインです。
Vite 6 / 7 / 8 をサポートしています。
## ✨ 主な特徴
- 🚀 **高速ビルド**: Vite のビルドシステムによる高速な開発体験
- 📝 **Pugサポート**: Pugテンプレートエンジンで効率的なHTML作成
- 🔄 **開発時リアルタイム更新**: HMR (Hot Module Replacement) 対応
- 📱 **静的サイト生成**: 本番環境向けに最適化された静的HTMLファイルを生成
- 🎨 **高度なカスタマイズ**: 豊富な設定オプションでプロジェクトに合わせた細かな調整
- 🛡️ **型安全**: TypeScript完全対応による開発時エラーの早期発見
## インストール
```bash
# npm
npm install vite-pug-static-builder
# yarn
yarn add vite-pug-static-builder
# pnpm
pnpm add vite-pug-static-builder
```
## 必要環境
- **Node.js**: 18.0.0以上
- **Vite**: ^6.0.0 || ^7.0.0 || ^8.0.0
- **Pug**: ^3.0.0
## 基本的な使用方法
### 1. Vite設定ファイル
```typescript
// vite.config.ts
import { defineConfig } from 'vite'
import pugPlugin from 'vite-pug-static-builder'
export default defineConfig({
plugins: [
pugPlugin({
build: {
options: {
basedir: './src'
},
locals: {
title: 'My Website',
env: 'production'
}
},
serve: {
options: {
basedir: './src'
},
locals: {
title: 'My Website (Dev)',
env: 'development'
}
}
})
]
})
```
### 2. プロジェクト構造例
```
src/
├── index.pug # → dist/index.html
├── about/
│ └── index.pug # → dist/about/index.html
├── blog/
│ ├── index.pug # → dist/blog/index.html
│ └── post1.pug # → dist/blog/post1.html
├── _layouts/
│ └── base.pug # レイアウトテンプレート
├── _includes/
│ └── header.pug # 部分テンプレート
└── assets/
├── style.css
└── script.js
```
### 3. Pugファイル例
```pug
//- src/index.pug
extends _layouts/base
block content
main
h1= title
p ようこそ、#{title}へ！
if env === 'development'
.dev-info 開発モードで実行中
include _includes/header
```
## 詳細設定オプション
### プラグイン設定
```typescript
interface Settings {
// ビルド時の設定
build?: {
// Pugコンパイルオプション
options?: Pug.Options
// Pugローカル変数
locals?: Pug.LocalsObject
}
// 開発サーバー時の設定
serve?: {
// Pugコンパイルオプション
options?: Pug.Options
// Pugローカル変数
locals?: Pug.LocalsObject
// 無視パターン（glob形式）
ignorePattern?: string | string[]
// ホットリロード設定（デフォルト: true）
reload?: boolean
}
}
```
### Pugオプションのデフォルト値
`build.options` と `serve.options` には、以下のデフォルト設定が適用されます。
- **`pretty`**: デフォルト `true`（Pug 3.xでは非推奨オプション）
ユーザーが `options` で指定した値はデフォルト値を上書きします。
### 高度な設定例
```typescript
pugPlugin({
build: {
options: {
basedir: './src',
compileDebug: false,
cache: true,
inlineRuntimeFunctions: false
},
locals: {
title: 'Production Site',
version: process.env.npm_package_version,
buildTime: new Date().toISOString(),
author: 'Your Name',
description: 'A modern static site built with Vite and Pug'
}
},
serve: {
options: {
basedir: './src',
compileDebug: true,
cache: false
},
locals: {
title: 'Development Site',
version: 'dev',
buildTime: 'dev-mode'
},
ignorePattern: [
'/_*/**', // アンダースコアで始まるディレクトリを無視
'/admin/**', // adminディレクトリを無視
'/**/*.draft.pug' // .draft.pugファイルを無視
],
reload: true
}
})
```
## 開発コマンド
```bash
# 開発サーバー起動
npm run dev
# 本番ビルド
npm run build
# ビルドのプレビュー
npm run preview
# 型チェック
npm run type-check
# テスト実行（Vite 8 環境）
npm test
# Vite 6 / 7 環境でテストを実行
npm run test:vite6
npm run test:vite7
# カバレッジ付きテスト
npm run coverage
# ウォッチモードでテスト
npm run test:watch
```
## TypeScript統合
完全なTypeScript対応により、設定ファイルやPugテンプレート内でも型安全性を確保できます：
```typescript
// types/pug.d.ts
declare module '*.pug' {
const content: string
export default content
}
// vite-env.d.ts
/// <reference types="vite/client" />
interface ImportMetaEnv {
readonly VITE_APP_TITLE: string
readonly VITE_API_URL: string
}
interface ImportMeta {
readonly env: ImportMetaEnv
}
```
## パフォーマンス最適化
```typescript
pugPlugin({
build: {
options: {
cache: true, // キャッシュ有効化
inlineRuntimeFunctions: false, // ランタイム関数の外部化
compileDebug: false // デバッグ情報削除
}
},
serve: {
options: {
cache: false, // 開発時はキャッシュ無効
compileDebug: true // 開発時はデバッグ有効
}
}
})
```
## トラブルシューティング
### よくある問題と解決法
**Q: Pugファイルが更新されてもブラウザが更新されない**
```typescript
pugPlugin({
serve: {
reload: true
}
})
```
**Q: ビルド時にPugの依存関係が正しく解決されない**
```typescript
pugPlugin({
build: {
options: {
basedir: path.resolve(__dirname, 'src')
}
}
})
```
**Q: 開発サーバーでのエラーハンドリング**
```pug
//- エラーを防ぐため、変数の存在チェックを行う
if typeof title !== 'undefined'
h1= title
else
h1 Default Title
```
## マイグレーションガイド
### 他のPugプラグインからの移行
```diff
- import { createPugPlugin } from 'vite-plugin-pug'
+ import pugPlugin from 'vite-pug-static-builder'
- createPugPlugin({
- pugOptions: { basedir: './src' }
- })
+ pugPlugin({
+ build: {
+ options: { basedir: './src' }
+ },
+ serve: {
+ options: { basedir: './src' }
+ }
+ })
```
## ライセンス
[MIT](./LICENSE) © 2025 maigo999
## 貢献
プルリクエストや Issue の報告を歓迎します！
1. このリポジトリをフォーク
2. フィーチャーブランチを作成 (`git checkout -b feature/amazing-feature`)
3. 変更をコミット (`git commit -m 'Add amazing feature'`)
4. ブランチにプッシュ (`git push origin feature/amazing-feature`)
5. プルリクエストを作成
## 変更履歴
### v1.1.5 (2026-03-13)
- 🌐 多言語README追加（英語・日本語・中国語）
### v1.1.4 (2026-03-13)
- 📝 READMEを実装のAPIに合わせて修正
### v1.1.3 (2026-03-13)
- 🚀 Vite 8 対応
- 📦 `@types/node` を devDependencies に追加
### v1.1.2
- 🚀 Vite 7 安定版対応
- 🧪 Vitest 3.2 対応
### v1.0.0
- 🚀 初回リリース
- ✨ Environment API 対応
- 🛡️ TypeScript 完全対応
## 関連リンク
- [Vite](https://vitejs.dev/)
- [Pug](https://pugjs.org/)
- [GitHub Repository](https://github.com/ozekimasaki/vite-pug-static-builder)