A set of coding guidelines for any TYPO3-related project or extension
Installs: 552 750
Open Issues: 5
- php: ^8.0
- ext-json: *
- friendsofphp/php-cs-fixer: ^3.11
- symfony/console: ^4.4.30 || ^5.3.7 || ^6.0
- symfony/filesystem: ^4.4 || ^5.0 || ^6.0
- composer/package-versions-deprecated: ^18.104.22.168
- ergebnis/composer-normalize: *
- keradus/cli-executor: ^1.5
- maglnet/composer-require-checker: *
- nikic/php-parser: ^4.13.1
- overtrue/phplint: ^3.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-strict-rules: ^1.0
- phpstan/phpstan-symfony: ^1.0
- phpunit/phpunit: ^9.5.18
- symfony/finder: >=4.4
- symfony/process: >=4.4
- dev-main / 0.8.x-dev
This package is auto-updated.
Last update: 2023-06-06 14:43:47 UTC
You know the feeling: You work on your own extension, and then contribute to TYPO3, and TYPO3 delivers all the nice things to check for proper coding standards.
Well, same happens to all of us! Luckily, TYPO3 has this configuration in Core, and it's now available separately - ready to plug-and-play for you!
It does not matter if you're an extension developer, or a TYPO3 contributor, or working on your TYPO3 project.
Since this is a Composer package, run
composer require --dev typo3/coding-standards
in your Composer project, which of course includes TYPO3 project or extension or
any other Composer project.
What's in the package?
The coding guidelines that are used in TYPO3 Core development. Instead of putting this information in our main repository, it should be helpful to apply certain rules to other projects as well. TYPO3 is more than just TYPO3 Core!
Ensures that your PHP files are subject to the same rules.
If you work on a team, and you use different IDE settings,
helps you to have the same settings across all editors. It does not matter if
it is VS-Code, vim or PhpStorm, almost every editor supports the
Setting up the TYPO3 rule sets as boilerplate
Our coding standards file can set this up for you. Run
composer exec typo3-coding-standards setup
or via the shortcut, which of course works for every command:
composer exec t3-cs s
extension is automatically detected. If the detection
does not work for you (please also tell us about your case at
https://github.com/TYPO3/coding-standards/issues), you can specify the
desired type as parameter like this:
composer exec typo3-coding-standards setup project
composer exec typo3-coding-standards setup extension
Have a look at the newly created files in your root folder:
For projects, the folder
src is configured by default, but you can
accommodate where your extensions or PHP code resides in. For extensions,
PHP-CS-Fixer scans the whole base directory.
In addition, you can configure your PHP-CS-Fixer cache file folder and other configurations just like with PHP-CS-Fixer.
You can decide to commit them to your Git repository, which is the recommended way.
Updating the TYPO3 rule sets
To update the rule sets, run
composer update typo3/coding-standards. An updated
PHP-CS-Fixer rule set is applied immediately, but changes to the
file must be applied manually by running
composer exec typo3-coding-standards update.
This will overwrite your changes in the
.editorconfig and reset it to the
TYPO3 default values. Please make sure that your file has been properly
committed to your repository before proceeding with the update.
You can also reset all files to the TYPO3 defaults by providing the
option to the
composer exec -- typo3-coding-standards setup --force
Don't forget to provide the two dashes after
exec if you use options.
Advanced usage examples
Show a command specific help e.g. with
composer exec typo3-coding-standards help setup.
It is possible to specify a destination folder for the files or to set up only a part of the TYPO3 coding standards, here are some examples.
composer exec -- typo3-coding-standards setup --rule-set=editorconfig
.php-cs-fixer.dist.php in the
composer exec -- typo3-coding-standards setup --target-dir=Build --rule-set=php-cs-fixer
Symfony comes with a great shortcut support for all commands e.g. this is the same like the last command above:
composer exec -- t3-cs s -d=Build -r=php-cs-fixer
composer exec t3-cs u
Running the script directly not using Composer:
Of course this assumes the binaries are installed by Composer at the default
vendor/bin. That's why we recommend using
composer exec in the
first place becaue Composer is aware of the correct location.
Executing the PHP-CS-Fixer
Once you've followed the step above, running PHP CS Fixer works like this:
composer exec php-cs-fixer
Have a look at our GitHub Actions Continuous Integration workflow to get an idea on how to automate your testing workflows using this package.
We'd love to ship out license headers for all PHP files, however there are certain limitations (namespace must be underneath the license headers), which why this option is not enabled by default.
A note about our standards
PHP Coding Guidelines
TYPO3's coding guidelines have evolved over time. And we are happy to have PHP-FIG and PSR-1/PSR-2 and PSR-12. That's why we're committed to following these guidelines.
However, there are some more rules that we think are good:
- Remove leading slashes in use clauses.
- PHP single-line arrays should not have trailing comma.
- Single-line whitespace before closing semicolon are prohibited.
- Remove unused use statements in the PHP source code
- Ensure Concatenation to have at least one whitespace around
- Remove trailing whitespace at the end of blank lines.
Maintaining and Development of this package
This package is not meant to be updated regularly, since talking about coding guidelines takes a lot of time, and is usual a matter of taste. Nonetheless, you can always open up an issue if you feel like we're missing out on something.
A GitHub action automatically synchronizes the files with the TYPO3 Core. Please do not open pull requests for these changes, but push your changes to the TYPO3 Core.
The source code comes with a DDEV Local configuration that makes using Composer and switching PHP versions very easy. For more information about DDEV, see the documentation.
composer.json many scripts are predefined to run the CI locally before
you push erroneous changes. Additionally some fix commands are integrated.
Manually update the files from the core
The synchronization job is scheduled once per night. It can also be started
manually on the
Actions tab on GitHub by selecting
Core Synchronization and
running the workflow on the main branch.
License & Thanks
This package is available under the MIT license, since it relies heavily on the PHP-CS-Fixer code.
In addition, I would like to thank the TYPO3 Core Team that kickstarted this set of rules in 2015, and to the creators and maintainers of PHP-CS-Fixer package.
Benni Mack, TYPO3 Project Lead