mediatis/typo3-coding-standards

Mediatis - TYPO3 Coding Standards

2.1.7 2024-09-25 12:41 UTC

Requires

• php: ^8.1
• helmich/typo3-typoscript-lint: ^3.1.0
• mediatis/coding-standards: ^1.1.3
• php-coveralls/php-coveralls: ^2.6.0
• phpstan/extension-installer: ^1.3.1
• phpstan/phpstan-strict-rules: ^1.5.1
• saschaegerer/phpstan-typo3: ^1.9.0
• seld/jsonlint: ^1.10.0
• ssch/typo3-rector: ^1.8.1
• symfony/yaml: ^5.3.6 || ^6.2.0
• typo3/cms-core: ^11.5 || ^12.4
• typo3/cms-fluid-styled-content: ^11.5.4 || ^12.4.0
• typo3/coding-standards: ^0.6.1
• typo3/testing-framework: ^7.0.4

Conflicts

• typo3/class-alias-loader: < 1.1.0

GPL-2.0-or-later

• Mediatis AG

• php
• standards
• typo3
• coding

README

Installation

Make sure that you removed old code quality and pipeline configuration files or folders, e.g. rector.php, .php-cs-fixer.php, .phpstan.

Make sure, your composer.json does not have any dev-requirements on explicit code-quality packages (like phpunit/phpunit, rector/rector, typo3/coding-standards and so on).

Make sure your .gitignore file includes the folder .Build and the file composer.lock.

.Build
composer.lock

Install the TYPO3 coding-standards package.

composer require --dev --with-all-dependencies mediatis/typo3-coding-standards

Run the kickstart script to install configuration files. Pass the lowest TYPO3 major version number that your extension supports.

./.Build/bin/mediatis-typo3-coding-standards-setup

Start ddev in the extension folder

ddev start

Usage - Check

Run all checks:

ddev composer ci

Run group checks:

# run all code quality checks
ddev composer ci:static

# all php tests and code quality checks
ddev composer ci:php
ddev composer ci:composer
ddev composer ci:yaml
ddev composer ci:json

Run specific checks:

ddev composer ci:composer:normalize
ddev composer ci:composer:psr-verify
ddev composer ci:composer:validate
ddev composer ci:php:lint
ddev composer ci:php:rector
ddev composer ci:php:cs-fixer
ddev composer ci:php:stan
ddev composer ci:php:tests:unit
ddev composer ci:php:tests:functional
ddev composer ci:yaml:lint
ddev composer ci:json:lint

Usage - Fix

Run all fixes:

ddev composer fix

Run group fixes:

ddev composer fix:composer
ddev composer fix:php

Run specific fixes:

ddev composer fix:php:rector
ddev composer fix:php:cs
ddev composer fix:composer:normalize