All Tasks Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer:

   composer require phpcq/all-tasks --dev
   

   Ensure it’s listed under require-dev in composer.json.

2. First Use Case Run the predefined PHP Code Quality (PHP-CQ) tasks via Artisan:

   php artisan php-cq:run
   

   This executes all default tasks (e.g., static analysis, coding standards, tests).

3. Configuration Check config/php-cq.php (auto-generated if missing) for task overrides or custom rules. Example:

   'tasks' => [
       'phpstan' => [
           'level' => 'level:5',
       ],
       'psalm' => [
           'enabled' => true,
       ],
   ],
   

Implementation Patterns

Workflow Integration

1. CI/CD Pipeline Trigger tasks in GitHub Actions/GitLab CI:

   # Example GitHub Actions
   - name: Run PHP-CQ
     run: php artisan php-cq:run --ansi
   

   Use --ansi for colored output in CI logs.

2. Pre-Commit Hooks Integrate with laravel-pint or husky:

   composer require laravel-pint --dev
   php artisan php-cq:run --tasks=pint
   

3. Custom Task Groups Define reusable task sets in php-cq.php:

   'groups' => [
       'core' => ['phpstan', 'psalm', 'phpunit'],
       'pre-release' => ['phpstan', 'phpunit', 'pest'],
   ],
   

   Run via:

   php artisan php-cq:run --group=core
   

Artisan Command Usage

Task-Specific Patterns

• PHPStan/Psalm: Leverage Laravel’s service container to bind custom rules:

  // app/Providers/AppServiceProvider.php
  public function register()
  {
      $this->app->bind(\PHPStan\Rules\Rule::class, function () {
          return new CustomRule();
      });
  }
  

• PHPUnit: Extend Laravel’s testing config (phpunit.xml) to include:

  <env name="APP_ENV" value="testing"/>
  <env name="DB_CONNECTION" value="sqlite"/>
  

Gotchas and Tips

Common Pitfalls

1. Task Dependencies

   • Ensure phpstan/extension-installer and phpunit/phpunit are installed if using those tasks.
   • Fix: Run composer require --dev phpcq/all-tasks again or manually add missing packages.

2. Configuration Overrides

   • Custom php-cq.php may conflict with package defaults. Use php artisan php-cq:config to reset.
   • Tip: Merge configs explicitly:

     return [
         'tasks' => array_merge(
             require __DIR__.'/php-cq.php',
             ['phpstan' => ['level' => 'level:7']]
         ),
     ];
     

3. Performance

   • Parallelize tasks with --parallel (if supported):

     php artisan php-cq:run --parallel --tasks=phpstan,psalm
     

   • Warning: Not all tasks support parallel execution (e.g., PHPUnit).

4. Debugging

   • Enable verbose output:

     php artisan php-cq:run --verbose
     

   • Check task logs in storage/logs/php-cq.log.

Extension Points

1. Custom Tasks Extend the package by creating a service provider:

   // app/Providers/PHPcqServiceProvider.php
   public function boot()
   {
       \PHPcq\AllTasks::extend(function ($manager) {
           $manager->addTask(new CustomTask());
       });
   }
   

2. Hooks Listen to task events (e.g., phpcq.task.started):

   // app/Listeners/LogTaskEvents.php
   public function handle()
   {
       Log::info('Task started: '.$event->task);
   }
   

3. Environment-Specific Configs Use Laravel’s environment configs:

   // config/php-cq.php
   'tasks' => env('PHP_CQ_TASKS', ['phpstan', 'phpunit']),
   

Pro Tips

• Cache Task Results: Add --cache to skip unchanged files:

  php artisan php-cq:run --cache
  

• GitHub Actions: Cache Composer dependencies and task results:

  - uses: actions/cache@v3
    with:
      path: ~/.cache/php-cq
      key: ${{ runner.os }}-php-cq-${{ hashFiles('**/composer.lock') }}