wayofdev/php-cs-fixer-config

Package adds custom rule-sets to php-cs-fixer.

PHP CS Fixer Config

Wrapper with pre-defined rules around the PHP-CS-Fixer package — A tool to automatically fix PHP Coding Standards issues.

If you like/use this package, please consider starring it. Thanks!

💿 Installation

→ Using composer

Require as dependency:

$ composer req wayofdev/cs-fixer-config

🛠 Configuration

1. Create PHP file and name it .php-cs-fixer.dist.php and place it inside root directory of project. It will be recognized by PHP CS Fixer automatically.

2. Example contents of .php-cs-fixer.dist.php file:

   <?php
   
   declare(strict_types=1);
   
   use WayOfDev\PhpCsFixer\Config\ConfigBuilder;
   use WayOfDev\PhpCsFixer\Config\RuleSets\DefaultSet;
   
   require_once 'vendor/autoload.php';
   
   return ConfigBuilder::createFromRuleSet(new DefaultSet())
       ->inDir(__DIR__ . '/src')
       ->inDir(__DIR__ . '/tests')
       ->addFiles([__FILE__])
       ->getConfig();

3. Place .php-cs-fixer.cache file into .gitignore

💻 Usage

→ Running

Fix coding standards by simply running console command:

$ php vendor/bin/php-cs-fixer fix -v

→ Using Makefile

To use with our Makefile:

1. Add scripts section to composer.json:

   {
       "scripts": {
           "cs-fix": "php vendor/bin/php-cs-fixer fix -v",
           "cs-diff": "php vendor/bin/php-cs-fixer fix --dry-run -v --diff"
       }
   }

2. Use Makefile code to run PHP-CS-Fixer tests:

   # Run inspections and fix code
   $ make cs-fix
   
   # Check coding standards without applying the fix
   $ make cs-diff

🧪 Running Tests

→ PHPUnit tests

To run tests, run the following command:

$ make test

→ Static Analysis

Code quality using PHPStan:

$ make stan

→ Coding Standards Fixing

Fix code using The PHP Coding Standards Fixer (PHP CS Fixer) to follow our standards:

$ make cs-fix

🤝 License

🙆🏼‍♂️ Author Information

Created in 2022 by lotyp / wayofdev

🧱 Resources

• Full documentation about all fixers are available here - PHP-CS-Fixer configuration UI

• The official PHP-CS-Fixer documentation

php-cs-fixer-config's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/checkout digest to b4ffde6
• chore(deps): update phpstan packages (phpstan/phpstan, phpstan/phpstan-phpunit, phpstan/phpstan-strict-rules)
• chore(deps): update dependency ergebnis/composer-normalize to v2.41.1
• chore(deps): update dependency phpunit/phpunit to v10.5.8
• fix(deps): update dependency friendsofphp/php-cs-fixer to v3.48.0
• chore(deps): update actions/cache action to v4
• chore(deps): update actions/labeler action to v5
• chore(deps): update google-github-actions/release-please-action action to v4
• chore(deps): update redhat-plumbers-in-action/differential-shellcheck action to v5
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

composer

composer.json

• php ^8.1
• friendsofphp/php-cs-fixer ^3.14.4
• ergebnis/composer-normalize ^2.30.2
• phpstan/extension-installer ^1.2.0
• phpstan/phpstan ^1.10.5
• phpstan/phpstan-deprecation-rules ^1.1.2
• phpstan/phpstan-phpunit ^1.3.10
• phpstan/phpstan-strict-rules ^1.5.0
• phpunit/phpunit ^10.0.14

github-actions

.github/workflows/auto-merge-release.yaml

• peter-evans/enable-pull-request-automerge v3

.github/workflows/ci.yml

• actions/checkout v4@3df4ab11eba7bda6032a0b82a6bb43b11571feac
• shivammathur/setup-php v2
• actions/cache v3
• codecov/codecov-action v4

.github/workflows/codesee-arch-diagram.yml

• Codesee-io/codesee-action v2

.github/workflows/create-release.yml

• google-github-actions/release-please-action v3

.github/workflows/label.yml

• actions/labeler v4

.github/workflows/shellcheck.yml

• actions/checkout v4@3df4ab11eba7bda6032a0b82a6bb43b11571feac
• redhat-plumbers-in-action/differential-shellcheck v4

npm

package.json

---

• Check this box to trigger a request for Renovate to run again on this repository