Composer Helper Laravel Package

Getting Started

Minimal Steps

1. Installation Add the package to your project via Composer:

   composer require bitandblack/composer-helper
   

   No additional configuration is required unless you need custom behavior.

2. First Use Case The package provides utility functions for Composer operations. Start by exploring the ComposerHelper facade:

   use BitAndBlack\ComposerHelper\Facades\ComposerHelper;
   
   // Example: Get installed packages
   $packages = ComposerHelper::getInstalledPackages();
   

3. Where to Look First

   • Facade: BitAndBlack\ComposerHelper\Facades\ComposerHelper
   • Service Provider: BitAndBlack\ComposerHelper\ComposerHelperServiceProvider
   • Documentation: Check the README.md in the repository for basic usage examples.

Implementation Patterns

Common Workflows

1. Package Management Use the helper to dynamically interact with Composer packages:

   // Check if a package is installed
   if (ComposerHelper::isInstalled('laravel/framework')) {
       // Perform action
   }
   
   // Get package version
   $version = ComposerHelper::getPackageVersion('laravel/framework');
   

2. Dependency Handling Programmatically check or modify dependencies:

   // Check if a package meets version requirements
   if (ComposerHelper::satisfies('monolog/monolog', '^2.0')) {
       // Use Monolog v2+ features
   }
   

3. Autoloading and Optimization Trigger Composer dump-autoload programmatically:

   ComposerHelper::dumpAutoload();
   

4. Custom Scripts Extend Composer scripts in composer.json using the helper:

   {
       "scripts": {
           "post-install-cmd": [
               "BitAndBlack\\ComposerHelper\\ComposerHelper::postInstall"
           ]
       }
   }
   

Integration Tips

• Laravel Service Providers: Register the facade in your AppServiceProvider if not auto-discovered.
• Artisan Commands: Use the helper in custom Artisan commands for package-related tasks.
• Testing: Mock ComposerHelper in unit tests to isolate Composer interactions.

Gotchas and Tips

Pitfalls

1. Composer Lock File Dependency Some methods (e.g., getInstalledPackages()) rely on the composer.lock file. Ensure it’s up-to-date:

   composer install --no-dev
   

2. Performance Overhead Avoid calling getInstalledPackages() or getPackageVersion() in tight loops. Cache results if needed:

   $packages = cache()->remember('composer.packages', now()->addHours(1), function () {
       return ComposerHelper::getInstalledPackages();
   });
   

3. Version Comparison Quirks Use satisfies() carefully—it follows Composer’s version constraints. Test edge cases like ^1.0.0 vs >=1.0.0.

4. Namespace Collisions If you have a class named ComposerHelper, the facade might conflict. Use the fully qualified class name:

   \BitAndBlack\ComposerHelper\Facades\ComposerHelper::method();
   

Debugging

• Log Composer Output: Enable verbose mode for debugging:

  ComposerHelper::setVerbose(true);
  

• Check Composer JSON: Validate composer.json syntax if methods return unexpected results.

Extension Points

1. Custom Methods Extend the helper by binding your own logic to the facade:

   ComposerHelper::extend(function ($helper) {
       $helper->customMethod = function () {
           // Your logic
       };
   });
   

2. Event Listeners Hook into Composer events (e.g., post-install) via Laravel’s event system:

   ComposerHelper::listen('post-install', function () {
       // Post-install logic
   });
   

3. Configuration Override default behavior by publishing the config (if available) or extending the service provider:

   $this->app->singleton('composer.helper', function ($app) {
       return new CustomComposerHelper();
   });