Skip to content

Feature Request: Add Laravel Breeze AI Guidelines #96

@thecyrilcril

Description

@thecyrilcril

Summary
Laravel Boost currently provides AI guidelines for many Laravel ecosystem packages, but Laravel Breeze is notably absent from the supported packages list. Given Breeze's popularity as the default authentication scaffolding solution in Laravel, adding AI guidelines for it would significantly benefit developers using Laravel Boost.
Current State
Looking at the current supported packages, Laravel Boost includes guidelines for:

Laravel Framework (core, 10.x, 11.x, 12.x)
Livewire, Inertia, Flux UI, Pest, PHPUnit, Pint, TailwindCSS, etc.

However, Laravel Breeze is missing from this list.
Motivation
Laravel Breeze is still one of the most commonly used authentication packages in the Laravel ecosystem because:

Official Laravel Package: It's(twas) maintained by the Laravel team as the recommended authentication scaffolding
Wide Adoption: Many Laravel projects use Breeze for authentication setup
Multiple Stacks: Breeze supports various frontend stacks (Blade, React, Vue, Alpine)
API Support: Includes API authentication via Laravel Sanctum

Without Breeze-specific AI guidelines, AI assistants may:

Generate authentication code that doesn't follow Breeze conventions
Miss Breeze-specific features and best practices
Provide generic authentication advice instead of Breeze-optimized solutions
Not leverage Breeze's built-in components and utilities effectively

Proposed Solution
Add AI guidelines for Laravel Breeze that would help AI assistants understand:
Core Guidelines

Breeze authentication flow and conventions
Proper usage of Breeze's authentication views and components
Integration patterns with Breeze's middleware and routes
Best practices for customizing Breeze scaffolding

Version-Specific Guidelines

Breeze 2.x: Current version with updated features and API authentication

Key Areas to Cover

Authentication Setup: Proper installation and configuration
View Customization: How to safely modify Breeze views and components
API Authentication: Integration with Laravel Sanctum for API tokens
Frontend Integration: Guidelines for React, Vue, and Alpine stacks
Testing: Best practices for testing Breeze authentication flows
Security: Following Breeze's security conventions and patterns

Example Use Cases
With Breeze guidelines, AI assistants could better help with:

"Add two-factor authentication to my Breeze setup"
"Customize the Breeze registration form to include additional fields"
"Set up API authentication with Breeze and Sanctum"
"Add social login to my Breeze authentication"
"Create custom middleware that works with Breeze's auth flow"

Implementation Suggestion
Similar to other packages in Laravel Boost, this would involve:

Creating core Breeze guidelines covering general best practices
Adding version-specific guidelines for major Breeze versions
Including documentation about Breeze's authentication patterns
Covering integration with other supported packages (like Sanctum, Inertia)

Benefits

Improved AI Accuracy: More accurate authentication-related code generation
Better Developer Experience: AI assistants that understand Breeze conventions
Consistent Code Quality: Generated code follows Laravel Breeze best practices
Faster Development: Reduced need to manually correct AI-generated auth code

Additional Context
Laravel Breeze is particularly important because authentication is often one of the first things developers implement in a new Laravel project, and having proper AI guidance for this critical foundation would be extremely valuable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions