craft-plugins について
craft-plugins は、Craft CMS 5 のプラグイン開発者向けに参照資料へ案内するスキルです。フロントエンド、バックエンド、移行、デプロイなどの作業に応じて、API、設定、実装上の注意点をまとめた資料を示します。
主な機能
- 01タスクに応じたプラグイン資料の案内
- 02フロントエンドとバックエンドの情報
- 03設定とAPIのガイダンス
- 04実装時の注意点
- 05併用するスキルの提示
活用シーン
- 01対象Craftプラグインの資料を探す
- 02プラグイン用テンプレートの実装を計画
- 03プラグインの移行やデプロイに対応
- 04作業に必要な併用スキルを選択
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ michtio/ craftcms-claude-skills --skill craft-pluginsインストール後、Claude Code で/craft-pluginsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/amazon-ses.mdblitz.mdcache-igniter.mdckeditor.mdcolour-swatches.mdelement-api.mdelements-panel.mdembedded-assets.mdfeed-me.mdformie.mdhyper.mdimage-optimize.mdimager-x.mdknock-knock.mdnavigation.mdpassword-policy.mdretour.mdseomatic.mdsherlock.mdsprig.mdtimeloop.mdtypogrify.mdvite.mdwarp.md詳細
Craft CMS 5 — プラグインリファレンス(インデックスとルーター)
このスキルはチュートリアルではなく、ルーターです。フロントエンド、バックエンドの PHP、コンテンツ移行、デプロイ、設定など、どのようなタスクの説明からでもプラグインごとのガイダンスを見つけやすくし、適切なリファレンスファイルを案内します。
各プラグインの厳選されたリファレンスは references/<plugin>.md にあり、設定、Twig および/または PHP API、実際に遭遇する落とし穴を解説しています。プラグイン固有の実装を始める前に、該当するリファレンスをお読みください。
このスキルの使い方
- タスクで指定されたプラグインを特定します(名前、パッケージ、機能のいずれかで確認します)。
- 以下の表から、該当する
references/<plugin>.mdを開きます。 - タスクがバックエンド(PHP、コンテンツ移行、イベント、デプロイ)に関するものなら、リファレンスのバックエンド/プログラムによる操作のセクションを特に確認します。いくつかのプラグイン(Formie、Feed Me、Element API、Amazon SES)は、歴史的にはフロントエンドのスキルに含まれていましたが、主に、または大部分がバックエンド向けです。
ルーティング表
| 参照 | プラグイン(ベンダー) | 主な対象領域 | 主な機能 |
|---|---|---|---|
references/formie.md | Formie (verbb) | フロントエンドおよびバックエンド | フォームのレンダリング(1行/詳細)、テーマ設定;コンテンツ移行でのプログラムによるフォーム作成、移行での既存フォームのフィールド編集、DB 要素としてのフォーム(プロジェクト設定ではない)、環境間デプロイ、マルチサイト/静的翻訳、Formie に同梱された文字列の上書き(サーバー+クライアントの window.FormieTranslations)、標準の最小/最大文字数バリデーションと2つのメッセージキー、required と min の相互作用、File Upload のボリュームとファイル名変更、通知の添付ファイル、CAPTCHA とキャッシュ |
references/seomatic.md | SEOmatic (nystudio107) | フロントエンド+設定 | メタデータのカスケード、Twig の取得/設定 API、JSON-LD、カスタム要素の SEO バンドル、サイトマップ、GraphQL |
references/blitz.md | Blitz (putyourlightson) | 混合(フロントエンド+運用) | 更新モード、Twig の動的コンテンツ、ドライバーアーキテクチャ(ストレージ/パージャー/デプロイヤー)、Nginx のリライトルール、Cloudflare 連携 |
references/feed-me.md | Feed Me (craftcms) | バックエンド/運用 | XML/JSON/CSV からのデータインポート、フィールドマッピング、重複処理、CLI 自動化、定期インポート |
references/imager-x.md | Imager X (spacecatninja) | フロントエンド+設定 | クイック構文、レスポンシブな srcset、名前付き変換、Power Pack のマークアップ(ppimg/pppicture)、自動生成、トランスフォーマー、エフェクト、オプティマイザー |
references/image-optimize.md | ImageOptimize (nystudio107) | フロントエンド+フィールド設定 | OptimizedImages フィールド、imgTag()/pictureTag() ビルダー、読み込み戦略、変換メソッド、コンソールコマンド |
references/ckeditor.md | CKEditor (craftcms) | 混合(フィールド設定+フロントエンド) | フィールド設定(ツールバー、見出し、画像モード)、チャンクレンダリングと値ヘルパーを使ったネストされたエントリ、リンク設定、GraphQL モード、ES モジュールのカスタムプラグイン、HTML Purifier、Redactor からの移行 |
references/sprig.md | Sprig (putyourlightson) | フロントエンド | リアクティブな Twig コンポーネント(htmx)、ライブ検索、追加読み込み、ページネーション、フィルタリング、JS を使わないフォーム送信 |
references/element-api.md | Element API (craftcms) | バックエンド/設定 | 設定ファイルによる JSON API、Fractal トランスフォーマー、エンドポイントのルーティング、ページネーション、キャッシュ |
references/retour.md | Retour (nystudio107) | 運用/設定 | リダイレクトの種類(完全一致/正規表現)、404 の追跡、CSV インポート、スラッグ変更時の自動リダイレクト、設定 |
references/navigation.md | Navigation (verbb) | フロントエンド | ノードのクエリ、カスタムレンダリング、アクティブ状態、ノードのカスタムフィールド、GraphQL |
references/hyper.md | Hyper (verbb) | フロントエンド+フィールド設定 | リンクの種類、getLinkAttributes()、getText()、単一/複数リンク、要素へのアクセス、ボタンアトムとの連携 |
references/colour-swatches.md | Colour Swatches (craftpulse) | 混合 | パレット設定、複数色のスウォッチ、Tailwind クラスのマッピング、Twig モデル API |
references/password-policy.md | Password Policy (craftpulse) | バックエンド/設定 | バリデーションルール、HIBP チェック、保持期間/有効期限、コンソールコマンド、推奨設定 |
references/typogrify.md | Typogrify (nystudio107) | フロントエンド | |typogrify、|widont、|truncateOnWord、スマートクォート、ウィドウ防止 |
references/cache-igniter.md | Cache Igniter (putyourlightson) | 運用 | GlobalPing ウォーマー、地理的位置、更新の遅延、Blitz との連携 |
references/knock-knock.md | Knock Knock (verbb) | 運用/設定 | ステージング環境のパスワード保護、環境に応じた設定、URL の除外 |
references/timeloop.md | Timeloop (craftpulse) | 混合 | 繰り返し日付フィールド、craft.timeloop 変数 API、recurringDates() 関数、GraphQL、期間の頻度 |
references/elements-panel.md | Elements Panel (putyourlightson) | 開発ツール | 要素の件数、重複検出、Eager Loading の機会を表示するデバッグツールバーのパネル |
references/sherlock.md | Sherlock (putyourlightson) | 運用/設定 | セキュリティスキャン、HTTP ヘッダー、CMS 設定チェック、定期スキャン、IP 制限、監視 |
references/embedded-assets.md | Embedded Assets (spicyweb) | 混合 | 第一級アセットとしての oEmbed、craft.embeddedAssets.get()、iframe のカスタマイズ、GraphQL |
references/amazon-ses.md | Amazon SES (putyourlightson) | バックエンド/設定 | SES メールトランスポートアダプター、AWS 認証情報の設定、SNS によるバウンス追跡(Twig API なし) |
references/warp.md | Warp (craftpulse) | フロントエンドおよびバックエンド | パスワードレスのメンバー認証:マジックリンク(mlToken を使用し、token は使用しません)、メールで送信するワンタイムコード+分割入力、パスキー/WebAuthn、パスワードレス登録、セッション/デバイス管理。craft.warp 変数、4つの流暢なレンダービルダー(クラスの蓄積+resetClass、キー単位の data マージ、renderCss)、@layer warp CSS エスケープ、10個のアクションルート(returnUrl と Craft の redirect の非対称性、列挙攻撃を防ぐ応答、最近の再認証を要求するパスキールート)、手書きマークアップの DOM コントラクト |
references/vite.md | Vite (nystudio107) | フロントエンド+ビルドチェーン | craft.vite.* Twig API(script、register、entry、asset、integrity、inline、includeCriticalCssTags、devServerRunning)、vite.php の設定キー。ビルドチェーン/vite.config.ts の詳細は craft-site スキルの references/vite-buildchain.md を参照 |
関連スキル
craftcms— プラグインのタスクが基盤として利用する Craft コア API(要素の保存、イベント、マイグレーション、キュージョブ、フィールド値の保存など)を扱います。プラグインの PHP/マイグレーション 作業では、このスキルと併せて読み込んでください。craft-site— プラグインの出力が組み込まれるフロントエンドのテンプレートアーキテクチャ(コンポーネント、レイアウト、画像プリセットなど)を扱います。プラグインの レンダリング/スタイリング 作業では、このスキルと併せて読み込んでください。craft-content-modeling— プラグインがセクション、フィールド、ボリューム、またはマルチサイトの伝播と連携する場合に使用します。craft-cloud/servd— プラグインのタスクにデプロイ、エッジキャッシュ、またはエフェメラルファイルシステムの制約が関わる場合に使用します。
コメント
Markdown 対応