mcpField
T
typo3-typoscript-ref

typo3-typoscript-ref

github.com/netresearch開発257 回インストール5 日前に更新
リポジトリ

typo3-typoscript-ref について

typo3-typoscript-ref は、TypoScript、TSconfig、Fluid を扱う TYPO3 開発者向けの、バージョン対応ローカルリファレンスです。ベストプラクティスを示し、コード作成、レビュー、非推奨項目の確認、問題の調査に対応します。

主な機能

  1. 01バージョン対応のローカル参照検索
  2. 02TypoScript・TSconfig・Fluid のガイド
  3. 03非推奨項目とベストプラクティスの確認
  4. 04レビュー用チェックリストと lint ルール
  5. 05レシピ検索とエラー調査

活用シーン

  1. 01TYPO3 のバージョンに合う設定の作成
  2. 02既存の TypoScript や Fluid のレビュー
  3. 03プロジェクトの非推奨項目やセキュリティ確認
  4. 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.json
references/
annotations.json
debugging.md
patterns.md
topic-index.md
version-map.json
references/recipes/
ajax-endpoint.md
breadcrumb.md
content-elements.md
custom-content-element.md
error-pages.md
extbase-plugin.md
image-rendering.md
menu-setup.md
multi-language.md
page-setup.md
rte-config.md
site-sets.md
sitemap.md
structured-data.md
trailing-slash.md
references/review/
common-mistakes.md
deprecations.md
linting.md
migration-v12-to-v13.md
migration-v13-to-v14.md
performance.md
review-checklist.md
security.md
scripts/
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

ルール

  1. TypoScript/TSconfig/Fluid のコードを記述またはレビューする前に、必ず lookup.sh を実行してください
  2. ベストプラクティスの注釈(必須/非推奨/推奨/ヒント)に必ず従ってください
  3. TypoScript を記述する前に、必ずプロジェクトの lint ルール(--lint-rules)を確認してください
  4. 新しいコードを記述する場合:検出されたバージョンに対応する最新のアプローチを使用してください
  5. 既存のコードをレビューする場合:非推奨のパターンを指摘し、プロジェクトのバージョンに応じた --deprecations を確認してください
  6. TypoScript と Fluid を組み合わせたタスクの場合:--with-fluid フラグを使用してください
  7. 本番環境のセットアップでは、config.no_cache = 1 を生成しないでください
  8. 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 のコードをレビューする際:

  1. ファイルの種類(typoscript、tsconfig、または fluid)に応じて --checklist を実行します
  2. プロジェクトのバージョンに絞り込んで --deprecations を実行します
  3. 既知の落とし穴について references/review/common-mistakes.md と照合します
  4. Fluid の XSS パターン(f:format.raw、f:sanitize.html)について references/review/security.md を確認します
  5. COA_INT/USER_INT の過剰使用について references/review/performance.md を確認します
  6. キーワード検索に --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

コメント