この記事は元々 2022-07-08 に公開され、古いブログからここに移動されました。 編集:Hermes
FastAdmin プラグイン - パッケージ化・公開チュートリアル
FastAdmin プラグインの開発が完了したら、配布およびインストールのために ZIP ファイルにパッケージ化する必要があります。ここでは、FastAdmin プラグインを正しくパッケージ化する方法を紹介します。
📁 プラグインディレクトリ構造
標準的な FastAdmin プラグインのディレクトリ構造は以下の通りです:
plugin_name/
├── manifest.json # プラグマニフェストファイル(必須)
├── config.php # プラグイン設定ファイル(任意)
├── controller/ # コントローラーディレクトリ
├── model/ # モデルディレクトリ
├── view/ # ビューディレクトリ
├── public/ # 公共リソースディレクトリ
├── sql/ # データベーススクリプトディレクトリ
├── assets/ # フロントエンドリソース
├── README.md # 説明ドキュメント
└── LICENSE # ライセンス📄 manifest.json ファイル
これはプラグインの中核となる設定ファイルです:
{
"name": "plugin_name",
"title": "プラグイン名",
"version": "1.0.0",
"author": "作者名",
"description": "プラグインの説明",
"icon": "fa fa-plugin",
"admin": {
"name": "admin",
"title": "管理バックエンド"
},
"config": {
"key1": {
"title": "設定項目1",
"type": "string",
"value": "デフォルト値"
}
},
"dependencies": {
"fastadmin": ">=1.0.0"
}
}📦 パッケージ化の手順
方法その1:コマンドラインを使用する
CodeBlock Loading...
方法その2:圧縮ソフトウェアを使用する
- プラグインディレクトリを右クリック
- 「圧縮ファイルに追加」を選択
- 圧縮形式を ZIP に設定
- 以下のファイルを除外する:
.git/ディレクトリruntime/ディレクトリ.idea/ディレクトリnode_modules/ディレクトリ
✅ パッケージ化チェックリスト
| 確認項目 | 説明 |
|---|---|
| manifest.json | 存在し、フォーマットが正しいこと |
| 機密情報の欠如 | データベースパスワードや API キーなどが含まれていないこと |
| 開発ファイルの欠如 | .git、runtime、.idea などが除外されていること |
| ファイルの完全性 | 必要なすべてのファイルが含まれていること |
| 権限の適切さ | ファイル権限が適切に設定されていること |
📝 公開のアドバイス
- バージョン命名:セマンティックバージョニングを使用する(例:1.0.0)
- 変更履歴:README.md にバージョンの変更を記録する
- ドキュメントの完全性:詳細な使用方法を提供する
- テスト検証:クリーンな環境でインストールをテストする
💡 ベストプラクティス
.gitignoreを使用して無関係なファイルを除外するruntime/キャッシュを定期的にクリーンアップする- プラグインディレクトリ構造を規範的に保つ
- 詳細なインストール手順を提供する
編集:Hermes