Get the FREE Ultimate OpenClaw Setup Guide →

typo3-conformance

npx machina-cli add skill netresearch/typo3-conformance-skill/typo3-conformance --openclaw
Files (1)
SKILL.md
4.1 KB

TYPO3 Extension Conformance Checker

Evaluate TYPO3 extensions for standards compliance, architecture patterns, and best practices.

When to Use

  • Assessing extension quality before production deployment
  • Generating conformance reports for code review
  • Planning modernization to TYPO3 v12/v13/v14 standards
  • Validating TER publishing readiness

Skill Delegation

  • Testing details: Delegate to typo3-testing skill
  • Documentation validation: Delegate to typo3-docs skill
  • OpenSSF Scorecard: Delegate to enterprise-readiness skill

Evaluation Workflow

Step 0: Understand Extension Context (always first)

Before checking files, understand: purpose, target TYPO3/PHP version, extension type (plugin, module, site package, library), criticality (production vs experimental), and codebase scope.

Steps 1-9: Conformance Checks

  1. Initial Assessment -- Extension key, target TYPO3 version, extension type
  2. File Structure -- composer.json, ext_emconf.php, required directories
  3. Coding Standards -- strict_types, type declarations, PSR-12
  4. Prohibited Patterns -- No $GLOBALS access, no GeneralUtility::makeInstance() for services
  5. PHP Architecture -- Constructor DI, Services.yaml, PSR-14 events
  6. Backend Modules -- ES6 modules, Modal API, CSRF protection (v13+)
  7. Testing -- PHPUnit setup, Playwright E2E, coverage >70%
  8. Best Practices -- DDEV setup, runTests.sh, quality tools, CI/CD
  9. TER Publishing -- Workflow, upload comment format, CI compatibility

Step 10: Verification Loop

After fixes, re-run conformance checks. Document score improvement (e.g., "58 -> 82"). Ensure no regressions.

Scoring System

Base Score (0-100): Architecture (20) + Guidelines (20) + PHP Patterns (20) + Testing (20) + Best Practices (20). Excellence bonus up to 22 additional points.

Score RangeInterpretationAction
90-100+ExcellentReady for production and TER
80-89GoodMinor improvements recommended
70-79AcceptableAddress before major releases
50-69Needs WorkSignificant improvements required
Below 50CriticalBlock deployment until resolved

Critical issues (security, data loss, core incompatibility) block deployment regardless of score.

Running Checks

# Full conformance check
scripts/check-conformance.sh /path/to/extension

# Individual checks
scripts/check-file-structure.sh /path/to/extension
scripts/check-coding-standards.sh /path/to/extension
scripts/check-architecture.sh /path/to/extension
scripts/check-testing.sh /path/to/extension
scripts/check-phpstan-baseline.sh /path/to/extension
scripts/generate-report.sh /path/to/extension

References

Detailed guidance for each evaluation area:

  • references/extension-architecture.md -- Directory structure, required files
  • references/coding-guidelines.md -- PSR-12, naming conventions, TYPO3 style
  • references/php-architecture.md -- DI, services, events, Extbase, middleware
  • references/testing-standards.md -- PHPUnit and Playwright requirements
  • references/composer-validation.md -- composer.json validation rules
  • references/ext-emconf-validation.md -- TER requirements, field specs
  • references/version-requirements.md -- TYPO3/PHP compatibility matrix
  • references/dual-version-compatibility.md -- v12+v13 patterns
  • references/v13-deprecations.md -- Deprecated APIs and migration paths
  • references/backend-module-v13.md -- ES6, Modal API, accessibility
  • references/ter-publishing.md -- TER publication requirements
  • references/report-template.md -- Standard report structure
  • references/excellence-indicators.md -- Bonus scoring criteria
  • references/best-practices.md -- Tea extension organizational patterns

Asset Templates

Quality tool configs in assets/Build/: PHPStan (phpstan/), PHP-CS-Fixer (php-cs-fixer/), Rector (rector/), ESLint (eslint/), Stylelint (stylelint/), TypoScript lint (typoscript-lint/).

Source

git clone https://github.com/netresearch/typo3-conformance-skill/blob/main/skills/typo3-conformance/SKILL.mdView on GitHub

Overview

Assesses TYPO3 extensions for standards compliance, architecture patterns, and best practices. It guides modernization to v12/v13/v14 and prepares conformance reports and TER readiness.

How This Skill Works

The skill analyzes extension context, file structure, coding standards, PHP architecture, backend modules, testing, and publishing readiness using a step-by-step workflow (Steps 0-9) and a verification loop. It relies on scripts like check-conformance.sh and individual checks to generate reports and score improvements for refactors and upgrades.

When to Use It

  • Assessing extension quality before production deployment
  • Generating conformance reports for code review
  • Planning modernization to TYPO3 v12/v13/v14 standards
  • Validating TER publishing readiness
  • Reassessing after fixes to track score improvements and prevent regressions

Quick Start

  1. Step 1: Run a full conformance check: scripts/check-conformance.sh /path/to/extension
  2. Step 2: Review results and address issues in steps 1-9 (structure, standards, architecture, tests, publishing)
  3. Step 3: Re-run checks and document improvement (e.g., 58 -> 82); ensure no critical issues

Best Practices

  • Define extension context first: purpose, target TYPO3/PHP version, extension type, and criticality
  • Follow the 1-9 conformance checks in order: file structure, coding standards, architecture, testing, and publishing
  • Run both the full conformance check and individual checks (structure, coding, architecture, testing, PHPStan, reports)
  • Integrate checks into CI/CD with runTests.sh and quality tools for ongoing assurance
  • Document score changes after the verification loop (e.g., 58 -> 82) and track regressions

Example Use Cases

  • Modernizing a plugin to TYPO3 v12+ with DI usage, Services.yaml, and PSR-14 events
  • Preparing a site package for TER publishing by aligning with TER workflow and CI compatibility
  • Generating a conformance report for a code review to justify refactors
  • Re-running conformance after fixes and showing measurable score improvement
  • Verifying backend modules with ES6 modules, Modal API usage, and CSRF protection (v13+)

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers