taptima / php-cs-fixer
Taptima PHP-CS-Fixer fixers
Installs: 13 191
Dependents: 1
Suggesters: 0
Security: 0
Stars: 13
Watchers: 2
Forks: 3
Open Issues: 0
Requires
- php: ^8.1
- doctrine/inflector: ^2.0
- friendsofphp/php-cs-fixer: ^3.8
Requires (Dev)
- twig/twig: 3.3.*
- webmozart/assert: ^1.10
This package is auto-updated.
Last update: 2024-04-06 12:56:47 UTC
README
This repository appeared thanks to the PedroTroller/PhpCSFixer-Custom-Fixers and the code from this repository is used here.
Installation
composer require --dev taptima/php-cs-fixer dev-master
Configuration
// .php-cs-fixer.php <?php $config = PhpCsFixer\Config::create() // ... ->registerCustomFixers(new Taptima\CS\Fixers()) // ... ; return $config;
You can also include the ruleset used by the Taptima company. It includes the @Symfony, @PSR and other rules to get the best codestyle result. @Taptima rule set can be viewed here.
// .php-cs-fixer.php <?php $config = PhpCsFixer\Config::create() ->setRules( Taptima\CS\RuleSetFactory::create([ '@Taptima' => true, // other rules ]) ->taptima() ->getRules() ) ->registerCustomFixers( new Taptima\CS\Fixers() ) return $config;
Fixers
Taptima/doctrine_migrations
Remove useless getDescription(), up(), down() and comments from Doctrine\Migrations\AbstractMigration if needed.
Configuration
// .php-cs-fixer.php <?php $config = PhpCsFixer\Config::create() // ... ->setRules([ // ... 'Taptima/doctrine_migrations' => true, // ... ]) // ... ->registerCustomFixers(new Taptima\CS\Fixers()) ; return $config;
OR using my rule list builder.
// .php-cs-fixer.php.dist <?php $config = PhpCsFixer\Config::create() // ... ->setRules(Taptima\CS\RuleSetFactory::create() ->enable('Taptima/doctrine_migrations') ->getRules() ]) // ... ->registerCustomFixers(new Taptima\CS\Fixers()) ; return $config;
Fixes
--- Original // 80 chars +++ New // @@ @@ // use Doctrine\DBAL\Schema\Schema; // use Doctrine\Migrations\AbstractMigration; // // -/** // - * Auto-generated Migration: Please modify to your needs! // - */ // final class Version20190323095102 extends AbstractMigration // { // - public function getDescription() // - { // - return ''; // - } // // public function up(Schema $schema) // { // - // this up() migration is auto-generated, please modify it to your needs// $this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.'); // $this->addSql('CREATE TABLE admin (identifier CHAR(36) NOT NULL COMMENT \'(DC2Type:guid)\', PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB'); @@ @@ // // public function down(Schema $schema) // { // - // this down() migration is auto-generated, please modify it to your needs $this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.'); // $this->addSql('DROP TABLE admin'); // } // } // //
Configuration
// .php-cs-fixer.php <?php $config = PhpCsFixer\Config::create() // ... ->setRules([ // ... 'Taptima/doctrine_migrations' => [ 'instanceof' => [ 'Doctrine\Migrations\AbstractMigration' ] ], // ... ]) // ... ->registerCustomFixers(new Taptima\CS\Fixers()) ; return $config;
OR using my rule list builder.
// .php-cs-fixer.php.dist <?php $config = PhpCsFixer\Config::create() // ... ->setRules(Taptima\CS\RuleSetFactory::create() ->enable('Taptima/doctrine_migrations', [ 'instanceof' => [ 'Doctrine\Migrations\AbstractMigration' ] ]) ->getRules() ]) // ... ->registerCustomFixers(new Taptima\CS\Fixers()) ; return $config;
Fixes
--- Original // 80 chars +++ New // @@ @@ // use Doctrine\DBAL\Schema\Schema; // use Doctrine\Migrations\AbstractMigration; // // -/** // - * Auto-generated Migration: Please modify to your needs! // - */ // final class Version20190323095102 extends AbstractMigration // { // - public function getDescription() // - { // - return ''; // - } // // public function up(Schema $schema) // { // - // this up() migration is auto-generated, please modify it to your needs// $this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.'); // $this->addSql('CREATE TABLE admin (identifier CHAR(36) NOT NULL COMMENT \'(DC2Type:guid)\', PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB'); @@ @@ // // public function down(Schema $schema) // { // - // this down() migration is auto-generated, please modify it to your needs $this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.'); // $this->addSql('DROP TABLE admin'); // } // } // //
Taptima/ordered_setters_and_getters
Class/interface/trait setters and getters MUST BE ordered (order is setter, isser, hasser, adder, remover, getter).
Configuration
// .php-cs-fixer.php <?php $config = PhpCsFixer\Config::create() // ... ->setRules([ // ... 'Taptima/ordered_setters_and_getters' => true, // ... ]) // ... ->registerCustomFixers(new Taptima\CS\Fixers()) ; return $config;
OR using my rule list builder.
// .php-cs-fixer.php.dist <?php $config = PhpCsFixer\Config::create() // ... ->setRules(Taptima\CS\RuleSetFactory::create() ->enable('Taptima/ordered_setters_and_getters') ->getRules() ]) // ... ->registerCustomFixers(new Taptima\CS\Fixers()) ; return $config;
Fixes
--- Original // 80 chars +++ New // @@ @@ // $this->firstName = $firstName; // } // // - public function setName($name) // + public function getFirstName() // { // - $this->name = $name; // + return $this->firstName; // } // // - public function isEnabled() // + public function setName($name) // { // - return $this->enabled; // + $this->name = $name; // } // // public function getName() // @@ @@ // return $this->name; // } // // - public function getIdentifier() // + public function isEnabled() // { // - return $this->identifier; // + return $this->enabled; // } // // - public function getFirstName() // + public function getIdentifier() // { // - return $this->firstName; // + return $this->identifier; // } // // public function enable() // @@ @@ // } // // /** // - * @return Item // - */ // - public function getItems() // - { // - return $this->items; // - } // - // - /** // * @param Item $item // * @return User // */ // @@ @@ // $this->items->removeElement($item); // // return $this; // + } // + // + /** // + * @return Item // + */ // + public function getItems() // + { // + return $this->items; // } // } // //
Contributions
Before to create a pull request to submit your contributon, you must:
- run tests and be sure nothing is broken
- rebuilt the documentation
How to run tests
composer tests
How to rebuild the documentation
tools/doc > README.md