ssch/typo3-rector

Instant fixes for your TYPO3 code by using Rector.

Fund package maintenance!
sabbelasichon

Installs: 210 502

Dependents: 2

Suggesters: 0

Security: 0

Stars: 138

Watchers: 7

Forks: 40

Open Issues: 39

Type:rector-extension

v0.11.31 2021-11-16 09:00 UTC

README

Donate

Caution

Never run this tool on production, only on development environment where code is under version control (e.g. git). Always review and test automatic changes before releasing to production.

Rector for TYPO3

This repository (ssch/typo3-rector) is for development TYPO3 Rector only. Head to rectorphp/rector for installation.

Apply automatic fixes on your TYPO3 code.

Downloads

Rector aims to provide instant upgrades and instant refactoring of any PHP 5.3+ code. This project adds rectors specific to TYPO3 to help you migrate between TYPO3 releases or keep your code deprecation free.

Table of Contents

  1. Examples in action
  2. Overview of all rules
  3. Installation
  4. Configuration and Processing
  5. Best practice guide
  6. Beyond PHP - Entering the realm of FileProcessors
  7. Limitations
  8. Contribution

Please also have a look at the documentation for Rector itself.

Support

Please post questions to TYPO3 Slack (https://typo3.slack.com) in the channel #ext-typo3-rector. Or feel free to open an issue or start a discussion on github.

Credits

Many thanks to Tomas Votruba for his on going support and Rector. Many thanks to every other contributor.

Oh, and if you've come down this far, you might as well follow me on twitter.

Known Drawbacks

How to Apply Coding Standards?

Rector uses nikic/php-parser, built on technology called an abstract syntax tree (AST). An AST doesn't know about spaces and when written to a file it produces poorly formatted code in both PHP and docblock annotations. That's why your project needs to have a coding standard tool and a set of formatting rules, so it can make Rector's output code nice and shiny again.

We're using ECS with this setup.