Php Cs Fixer Config Laravel Package

Getting Started

1. Install the package via Composer:

   composer require --dev phootwork/php-cs-fixer-config
   

2. Create a .php-cs-fixer.dist.php config file in your project root that extends the provided config:

   <?php
   
   use Phootwork\CSFixer\Config;
   
   return Config::create()
       ->setRiskyAllowed(true)
       ->setFinder(Config::createFinder(__DIR__));
   

3. Run PHP CS Fixer to verify it works:

   vendor/bin/php-cs-fixer fix --dry-run
   

💡 Start with Config::create() — it loads the shared, opinionated ruleset from the package. You don’t need to copy rules manually.

Implementation Patterns

• Base config for monorepos/multi-project orgs: Include it as a dev dependency across repos to enforce uniform formatting. Update once in the package, pull into all projects via Composer.
• Project-specific overrides: Extend the base config and add, remove, or tweak rules:

  return Config::create()
      ->setRules([
          '@PSR12' => true,
          'single_import_per_statement' => false, // override base rule
          'ordered_imports' => ['sort_algorithm' => 'length'],
      ]);
  

• CI integration: Reference the config in your CI workflow to run checks consistently:

  - vendor/bin/php-cs-fixer check --config=.php-cs-fixer.dist.php
  

• IDE sync: Configure your IDE (e.g., PhpStorm, VS Code) to use the project’s .php-cs-fixer.dist.php as the source of truth for auto-formatting.

Gotchas and Tips

• ⚠️ Config::createFinder() only scans src/ and tests/ by default. Extend it if you have other directories:

  ->setFinder(Config::createFinder(__DIR__)->in(['src', 'tests', 'bin']));
  

• 🔁 Risky rules are disabled by default. Call setRiskyAllowed(true) if you want rules like @PHP80Migration or yoda_style. Ignoring this may cause "no fixes applied" surprises.
• 🧩 Overrides must be chained or merged carefully: PHP CS Fixer’s ruleset merges left-to-right, so later calls in setRules() override earlier ones. Always test overrides in dry-run mode first.
• 🔄 Update strategy: Pin the package version (e.g., ^2.0) to avoid unexpected formatting shifts on minor updates. Review changelogs before upgrading.
• 📁 Caching: Enable caching (->setCacheFile(__DIR__.'/.php-cs-fixer.cache)`) for faster repeated runs in local/dev environments.
• 🌐 PHP version support: The config targets modern PHP versions (7.4+). If supporting legacy PHP (e.g., 7.2), you’ll need to selectively relax rules (e.g., no_alias_functions, strict_comparison).