Gradle プラグイン

Gradle プラグイン

Java・Spring Boot 開発者は、自分の Java プロジェクトに bx-sites の サイトを追加するために CommandBox やシステム全体への BoxLang インストール を必要としません - io.boxlang.bxsites Gradle プラグインは、初回実行時 に必要なもの（BoxLang ランタイムと bx-sites 本体）をすべてローカルキャッシュ にダウンロードします。前提条件は JDK 21 だけです。

ステータス: バージョン1.0未満で、まだ Gradle Plugin Portal には 公開されていません - ソースコードと現時点のビルド/テスト手順は bx-sites リポジトリの gradle-plugin/ を参照してください。このページは公開後の動作を説明しています。以下の メカニズムはすでに実装され検証済みですが、まだ plugins { } の 1行依存として利用できるわけではありません。

クイックスタート

plugins {
    id("io.boxlang.bxsites") version "<version>"
}

./gradlew bxSitesNew    # docs/ + bxsites.yaml を生成
./gradlew bxSitesBuild   # docs/**.md を site/ にレンダリング
./gradlew bxSitesServe   # ビルドしてライブリロード付きでローカル配信

デフォルト設定であれば、これ以上の設定は不要です - プラグインが コンテンツディレクトリ（docs/、なければ src/ - ただし Java プラグインが 適用されているプロジェクトでは例外で、その場合 src/ は自分の Java ソースディレクトリであり、bx-sites のコンテンツとして使われることは ありません）と出力ディレクトリ（常に <projectRoot>/site/）を自動的に 検出します。サイト自体の見た目、 テーマ、ナビゲーション、その他すべての設定はプロジェクトルートの bxsites.yaml/.toml/.json で完全に制御されます。 設定 に記載されているとおりで、プラグインはこの スキーマを一切複製せず、bx-sites を自分のビルドからどのように・ いつ実行するかだけを担います。

タスク

bxSitesBuild は、明示的に有効化しない限り（下記の hookIntoAssemble を参照）assemble の一部として自動実行されることはありません - ドキュメント のビルドは、実際のコードのコンパイルとは別の、しばしばより時間の かかる関心事です。

設定

bxSites {
    projectRoot.set(layout.projectDirectory)
    boxlangMiniserverVersion.set("1.18.0-snapshot")   // 固定された BoxLang ランタイムバージョン
    bxSitesVersion.set("1.0.0-snapshot")               // 固定された bx-sites バージョン
    boxlangHomeDir.set(layout.buildDirectory.dir("bxsites/boxlang-home"))
    hookIntoAssemble.set(false)                        // オプトイン: bxSitesBuild を assemble の一部として実行する
    hookIntoCheck.set(true)                            // デフォルトで bxSitesLint を `check` に組み込む
}

どのプロパティにも適切なデフォルト値があります。出力ディレクトリは ここでは一切設定できません - bx-sites 自体が <projectRoot>/site/ に 固定しているため、実際には反映されない設定項目を用意する代わりに、 プラグインがそれを導出するだけです。

まだ実装されていないもの

• Spring Boot ドキュメント生成（OpenAPI、Javadoc、コントローラースキャン）- 計画中。
• bxSitesServe のライブ出力ストリーミング - 現在は出力をバッファリングし30分のタイムアウトを適用していますが、どちらも無期限に実行され続けるべきタスクとしては誤った挙動です。

Maven 側の対応物については Maven プラグイン のガイドを 参照してください - どちらのプラグインも同じ基盤ロジックをラップしている ため、verb のカバレッジと挙動は両方のビルドツールで同一に保たれます。

BoxLang ドキュメント生成

bxSitesDocBoxDoc は DocBox から BoxLang/CFML の API リファレンスを生成します。対象は .bx/.cfc クラスをソースに含む JVM プロジェクトです。Spring Boot 系のジェネレーターと異なり、JVM 内で動く ジェネレーターではなく docbox verb の薄いラッパーです。実装は BoxLang 側にあり、両方のビルドツールが同じ実装を呼ぶため、実装がずれることは ありません。実際に設定したオプションだけが渡され、それ以外は bxsites.yaml の内容に従います。 DocBox APIリファレンス を参照してください。用意された BoxLang ランタイムに bx-docbox モジュールが必要です。

ColdBox 用のタスクは意図的にありません。 ColdBox アプリケーションは CommandBox でビルド・実行するものであり、Gradle で扱うものではないため、 bxSites coldbox は bx-sites CLI の役割のままです。