typo3-typoscript-ref について
typo3-typoscript-ref は、TypoScript、TSconfig、Fluid を扱う TYPO3 開発者向けの、バージョン対応ローカルリファレンスです。ベストプラクティスを示し、コード作成、レビュー、非推奨項目の確認、問題の調査に対応します。
主な機能
- 01バージョン対応のローカル参照検索
- 02TypoScript・TSconfig・Fluid のガイド
- 03非推奨項目とベストプラクティスの確認
- 04レビュー用チェックリストと lint ルール
- 05レシピ検索とエラー調査
活用シーン
- 01TYPO3 のバージョンに合う設定の作成
- 02既存の TypoScript や Fluid のレビュー
- 03プロジェクトの非推奨項目やセキュリティ確認
- 04ページ設定エラーの調査
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ netresearch/ typo3-typoscript-ref-skill --skill typo3-typoscript-refインストール後、Claude Code で/typo3-typoscript-refを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
evals/evals.jsonreferences/annotations.jsondebugging.mdpatterns.mdtopic-index.mdversion-map.jsonreferences/recipes/ajax-endpoint.mdbreadcrumb.mdcontent-elements.mdcustom-content-element.mderror-pages.mdextbase-plugin.mdimage-rendering.mdmenu-setup.mdmulti-language.mdpage-setup.mdrte-config.mdsite-sets.mdsitemap.mdstructured-data.mdtrailing-slash.mdreferences/review/common-mistakes.mddeprecations.mdlinting.mdmigration-v12-to-v13.mdmigration-v13-to-v14.mdperformance.mdreview-checklist.mdsecurity.mdscripts/detect-version.sh詳細
TYPO3 TypoScript、TSconfig、Fluid リファレンス
常時適用されるベストプラクティスを備えた、バージョン対応のローカル参照。
使用方法
scripts/lookup.sh "stdWrap wrap" # Reference lookup
scripts/lookup.sh "PAGEVIEW" --with-fluid # With Fluid context
scripts/lookup.sh --recipe page-setup # Recipe for common tasks
scripts/lookup.sh "FLUIDTEMPLATE" --review # Adds deprecation warnings
scripts/lookup.sh --deprecations # Deprecation list
scripts/lookup.sh --checklist typoscript # Review checklist (typoscript|tsconfig|fluid)
scripts/lookup.sh --lint-rules # Project lint rules
scripts/lookup.sh --debug "The page is not configured" # Debug error
scripts/lookup.sh --update # Update cache
scripts/lookup.sh "TEXT" --version 12 # Override version
ルール
- TypoScript/TSconfig/Fluid のコードを記述またはレビューする前に、必ず
lookup.shを実行してください - ベストプラクティスの注釈(必須/非推奨/推奨/ヒント)に必ず従ってください
- TypoScript を記述する前に、必ずプロジェクトの lint ルール(
--lint-rules)を確認してください - 新しいコードを記述する場合:検出されたバージョンに対応する最新のアプローチを使用してください
- 既存のコードをレビューする場合:非推奨のパターンを指摘し、プロジェクトのバージョンに応じた
--deprecationsを確認してください - TypoScript と Fluid を組み合わせたタスクの場合:
--with-fluidフラグを使用してください - 本番環境のセットアップでは、
config.no_cache = 1を生成しないでください - Fluid ベースのテンプレートでは、CONTENT cObject より DataProcessors を優先してください
バージョンごとのガイダンス
- v12:FLUIDTEMPLATE、sys_template の静的インクルード、constants.typoscript を使用してください
- v13:新しいページテンプレートでは PAGEVIEW を優先し、Site Sets を導入して、settings.definitions.yaml を使用してください
- v14:Site Sets は必須です。PAGEVIEW はページレンダリングの標準です(FLUIDTEMPLATE はレガシーですが、公式には非推奨ではありません)。@import は必須です(INCLUDE_TYPOSCRIPT は削除済み)。getTSFE() 条件は削除済みです。リソースパスには EXT: より PKG: を優先してください
バージョン固有の質問に回答する際は、必ず references/review/deprecations.md と該当する移行ガイド(migration-v12-to-v13.md または migration-v13-to-v14.md)を参照してください。
レビューワークフロー
TypoScript/TSconfig/Fluid のコードをレビューする際:
- ファイルの種類(typoscript、tsconfig、または fluid)に応じて
--checklistを実行します - プロジェクトのバージョンに絞り込んで
--deprecationsを実行します - 既知の落とし穴について
references/review/common-mistakes.mdと照合します - Fluid の XSS パターン(f:format.raw、f:sanitize.html)について
references/review/security.mdを確認します - COA_INT/USER_INT の過剰使用について
references/review/performance.mdを確認します - キーワード検索に
--reviewフラグを使用して、非推奨に関する情報を追加します
リファレンス一覧
| 内容 | リファレンス |
|---|---|
| TypoScript のパターン、Fluid のベストプラクティス | references/patterns.md |
| エラーのデバッグ | references/debugging.md |
| 非推奨項目の一覧 | references/review/deprecations.md |
| セキュリティ(XSS、エスケープ) | references/review/security.md |
| パフォーマンス(キャッシュ、INT オブジェクト) | references/review/performance.md |
| よくある間違い | references/review/common-mistakes.md |
| v12-v13 の移行 | references/review/migration-v12-to-v13.md |
| v13-v14 の移行 | references/review/migration-v13-to-v14.md |
| 末尾のスラッシュ、PageTypeSuffix、重複コンテンツ | references/recipes/trailing-slash.md |
| トピック一覧(lookup.sh) | references/topic-index.md |
初回実行
scripts/lookup.sh --update
コメント
Markdown 対応