Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taptima/php-cs-fixer
New fixers for PHP-CS-Fixer
https://github.com/taptima/php-cs-fixer
codestyle doctrine-migrations php php-cs-fixer php-cs-fixer-custom-fixers php7 phpcsfixer
Last synced: 2 days ago
JSON representation
New fixers for PHP-CS-Fixer
- Host: GitHub
- URL: https://github.com/taptima/php-cs-fixer
- Owner: taptima
- License: mit
- Created: 2020-03-30T02:17:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-06T08:39:04.000Z (over 2 years ago)
- Last Synced: 2024-11-04T08:08:30.670Z (11 days ago)
- Topics: codestyle, doctrine-migrations, php, php-cs-fixer, php-cs-fixer-custom-fixers, php7, phpcsfixer
- Language: PHP
- Homepage: https://taptima.ru/
- Size: 58.6 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP-CS-Fixer
[](https://packagist.org/packages/taptima/php-cs-fixer)
[](https://packagist.org/packages/taptima/php-cs-fixer)
This repository appeared thanks to the [PedroTroller/PhpCSFixer-Custom-Fixers](https://github.com/PedroTroller/PhpCSFixer-Custom-Fixers) and the code from this repository is used here.
# Installation
```bash
composer require --dev taptima/php-cs-fixer dev-master
```
### Configuration
```php
// .php-cs-fixer.php
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](https://github.com/taptima/php-cs-fixer/blob/master/src/Taptima/CS/RuleSetFactory.php#L15).
```php
// .php-cs-fixer.php
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
// .php-cs-fixer.php
setRules([
// ...
'Taptima/doctrine_migrations' => true,
// ...
])
// ...
->registerCustomFixers(new Taptima\CS\Fixers())
;
return $config;
```
**OR** using my [rule list builder](doc/rule-set-factory.md).
```php
// .php-cs-fixer.php.dist
setRules(Taptima\CS\RuleSetFactory::create()
->enable('Taptima/doctrine_migrations')
->getRules()
])
// ...
->registerCustomFixers(new Taptima\CS\Fixers())
;
return $config;
```
### Fixes
```diff
--- 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
// .php-cs-fixer.php
setRules([
// ...
'Taptima/doctrine_migrations' => [ 'instanceof' => [ 'Doctrine\Migrations\AbstractMigration' ] ],
// ...
])
// ...
->registerCustomFixers(new Taptima\CS\Fixers())
;
return $config;
```
**OR** using my [rule list builder](doc/rule-set-factory.md).
```php
// .php-cs-fixer.php.dist
setRules(Taptima\CS\RuleSetFactory::create()
->enable('Taptima/doctrine_migrations', [ 'instanceof' => [ 'Doctrine\Migrations\AbstractMigration' ] ])
->getRules()
])
// ...
->registerCustomFixers(new Taptima\CS\Fixers())
;
return $config;
```
### Fixes
```diff
--- 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
// .php-cs-fixer.php
setRules([
// ...
'Taptima/ordered_setters_and_getters' => true,
// ...
])
// ...
->registerCustomFixers(new Taptima\CS\Fixers())
;
return $config;
```
**OR** using my [rule list builder](doc/rule-set-factory.md).
```php
// .php-cs-fixer.php.dist
setRules(Taptima\CS\RuleSetFactory::create()
->enable('Taptima/ordered_setters_and_getters')
->getRules()
])
// ...
->registerCustomFixers(new Taptima\CS\Fixers())
;
return $config;
```
### Fixes
```diff
--- 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
```bash
composer tests
```
## How to rebuild the documentation
```bash
tools/doc > README.md
```