Installer Laravel Package

Technical Evaluation

Architecture Fit

The laravel/installer package is a command-line tool designed to streamline Laravel project bootstrapping, aligning well with developer tooling and infrastructure-as-code (IaC) workflows. It abstracts the complexity of:

• Composer dependency resolution
• Environment configuration (.env, APP_URL, database drivers)
• Optional tooling (Node.js, Laravel Boost, Pest, Svelte, etc.)
• Cross-platform compatibility (Windows/Linux/macOS)

Key Fit Areas:

1. Standardized Onboarding: Reduces manual setup steps for new Laravel projects, improving consistency across teams.
2. Customization Hooks: Supports starter kits, database auto-configuration, and interactive prompts—useful for templatized deployments.
3. Integration with CI/CD: Can be embedded in pipelines (e.g., GitHub Actions) to automate project scaffolding.
4. Legacy Compatibility: Backward-compatible with Laravel 10–13, ensuring gradual adoption.

Misalignment Risks:

• Not a Runtime Dependency: This is a build-time tool, not a production library. Misuse (e.g., calling it dynamically in app logic) would introduce unnecessary overhead.
• Limited Post-Install Hooks: While it handles initial setup, it doesn’t manage runtime configurations (e.g., .env updates post-deploy).

Integration Feasibility

Key Dependencies:

• Composer (v2+ recommended)
• PHP (8.1–8.5, per Laravel 10–13 support)
• Optional: Node.js (for frontend tooling), Git (for custom kits)

Technical Risk

Critical Questions for TPM:

1. Use Case Clarity:
   • Is this for developer onboarding, CI/CD scaffolding, or custom templates?
   • Will it replace manual composer create-project or augment it?
2. Customization Needs:
   • Are custom starter kits required? If so, how will they be validated?
   • Will .env or APP_URL need post-install overrides?
3. CI/CD Impact:
   • How will interactive prompts (e.g., database selection) be handled in pipelines?
   • Will this run in parallel with other setup steps (e.g., Docker builds)?
4. Rollback Plan:
   • How will failed installs be recovered (e.g., partial composer.lock corruption)?
5. Long-Term Maintenance:
   • Who will update the installer version as Laravel evolves?
   • Will this be vendor-locked or centrally managed?

Integration Approach

Stack Fit

Migration Path

Option 1: Incremental Adoption (Recommended)

1. Phase 1: Developer Onboarding

   • Replace manual composer create-project with:

     composer require laravel/installer --dev
     laravel new project-name --preset=minimal
     

   • Document custom flags (e.g., --database=mysql, --no-boost).

2. Phase 2: CI/CD Integration

   • Add to pipeline (example GitHub Actions):

     - name: Scaffold Project
       run: |
         composer require laravel/installer --dev
         laravel new ./app --preset=minimal --no-interaction
     

3. Phase 3: Custom Templates

   • Package a Laravel-compatible starter kit (e.g., Git repo) and reference it:

     laravel new ./app --starter=git@github.com:org/custom-kit.git
     

Option 2: Full Replacement

• Update composer.json to alias create-project:

  "scripts": {
    "new": "laravel new"
  }
  

• Require laravel/installer globally or as a project dependency.

Compatibility

Sequencing

Recommended Execution Order:

1. Pre-Install:
   • Validate PHP/Composer versions.
   • Check for required tools (Node.js, Git, etc.).
2. Install:
   • Run laravel new with appropriate flags (e.g., --preset, --database).
3. Post-Install:
   • Run migrations (if --database was specified).
   • Configure CI/CD to avoid duplicate scaffolding.
4. Ongoing:
   • Update laravel/installer alongside Laravel core.

Anti-Patterns to Avoid:

• Running in production environments (this is a dev tool).
• Using interactive mode in CI (always use --no-interaction).
• Mixing with custom composer install scripts (may cause conflicts).

Operational Impact

Maintenance

Maintenance Tasks:

• Quarterly: Audit laravel/installer for breaking changes.
• Annual: Review custom starter kits for compatibility.
• As Needed: Update Node.js/PHP versions in CI templates.

Support

| Issue Type | Likelihood | **Resolution Path