Code Style Config Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require --dev chameleon-system/code-style-config
   

   Add to composer.json under require-dev if not auto-detected.

2. First Use Case Integrate with PHP-CS-Fixer or PHPStan by extending their config files:

   // php-cs-fixer.dist.php
   $finder = PhpCsFixer\Finder::create()
       ->in(__DIR__.'/../src')
       ->exclude('vendor');
   
   return (new PhpCsFixer\Config())
       ->setRules(include __DIR__.'/vendor/chameleon-system/code-style-config/php-cs-fixer/rules.php')
       ->setFinder($finder);
   

3. Where to Look First

   • Check vendor/chameleon-system/code-style-config/php-cs-fixer/rules.php for default rules.
   • Review phpstan.neon.dist (if provided) for static analysis presets.

Implementation Patterns

Workflow Integration

1. Leverage as a Base Config Extend the package’s rules in your project’s config files:

   // Custom rules.php
   $rules = include __DIR__.'/vendor/chameleon-system/code-style-config/php-cs-fixer/rules.php';
   $rules['array_syntax'] = ['syntax' => 'short']; // Override specific rules
   

2. CI/CD Pipeline Add to GitHub Actions (example):

   - name: Run PHP-CS-Fixer
     run: vendor/bin/php-cs-fixer fix --rules-set=chameleon --dry-run
   

3. IDE Integration

   • Use php-cs-fixer as a PHPStorm inspection tool (via Settings > Tools > PHP > Code Sniffer).
   • Point to the package’s ruleset for real-time feedback.

4. Team Onboarding

   • Document the package as a mandatory dependency in CONTRIBUTING.md.
   • Example:

     "Run composer require chameleon-system/code-style-config to sync code style rules."

Gotchas and Tips

Pitfalls

1. Rule Conflicts

   • The package may enforce strict PSR-12 rules (e.g., no_unused_imports). Test locally before CI runs.
   • Fix: Override rules explicitly in your config.

2. Missing Documentation

   • No README or changelog found. Assume no backward compatibility guarantees.
   • Tip: Fork and document changes if critical to your project.

3. Static Analysis Gaps

   • If phpstan.neon is missing, rely on PHP-CS-Fixer for basic style checks.
   • Workaround: Use phpstan/extension-installer to add missing presets.

Debugging

• Rule Validation Run with --verbose to debug rule application:

  vendor/bin/php-cs-fixer fix --verbose --rules-set=chameleon
  

• Isolated Testing Test a single file:

  vendor/bin/php-cs-fixer fix path/to/File.php
  

Extension Points

1. Custom Rulesets Merge with existing rules:

   $rules = array_merge(
       include 'vendor/chameleon-system/code-style-config/php-cs-fixer/rules.php',
       ['bracket_line_break' => true]
   );
   

2. Dynamic Rule Loading Load rules from a config file (e.g., .php-cs-fixer-chameleon.php) for flexibility.

3. PHPStan Integration If phpstan.neon is provided, extend it:

   includes:
       - vendor/chameleon-system/code-style-config/phpstan/level-5.neon