Laravel Project Rules

laravelphpbackend

Enforces Laravel conventions including Eloquent ORM patterns, middleware, service provider organization, queue usage, and Blade templating best practices.

Целевые файлы

Файл	Формат
.cursorrules	plaintext
CLAUDE.md	markdown

Содержимое

## Laravel Project Rules ### Project Structure - Controllers live in `app/Http/Controllers/`; group by domain using subdirectories - Business logic lives in `app/Services/` — one service class per domain - Data access lives in `app/Repositories/` when using the repository pattern - Form request validation classes live in `app/Http/Requests/` - Events in `app/Events/`, listeners in `app/Listeners/`, jobs in `app/Jobs/` ### Eloquent Models - Define `$fillable` or `$guarded` on every model — never use `$guarded = []` in production - Define relationships as explicit methods with return type hints: `public function posts(): HasMany` - Use model scopes for reusable query logic: `public function scopeActive(Builder $query): void` - Use `$casts` array to cast JSON columns, booleans, and dates automatically - Override `$table`, `$primaryKey`, `$timestamps` when deviating from conventions - Use `withDefault()` on nullable relationships to avoid null checks downstream ### Query Building - Use Eloquent relationships and eager loading (`with()`) to prevent N+1 queries - Use `chunk()` or `lazy()` for processing large datasets — never `->get()` on millions of records - Use `whereHas()` and `doesntHave()` for relationship-based filtering - Use `firstOrCreate()`, `updateOrCreate()` for upsert operations - Index all foreign key columns and columns used in `where()` clauses ### Controllers - Use single-action controllers (`__invoke`) for complex standalone actions - Use resource controllers (`php artisan make:controller --resource`) for CRUD endpoints - Validate all input using Form Request classes — never validate in the controller body - Inject dependencies via the constructor or method injection — never use facades inside logic - Return `JsonResource` or `ResourceCollection` from API controllers — never raw models ### Form Requests & Validation - Every mutating controller action must use a `FormRequest` class - Define `authorize()` to check permissions; return `false` to send a 403 - Define `rules()` with full validation rule arrays; use custom messages in `messages()` - Use custom rule classes (`php artisan make:rule`) for reusable validation logic ### Middleware - Apply middleware at the route or route group level — avoid applying globally unless truly global - Custom middleware must implement `handle(Request $request, Closure $next): Response` - Use `$request->route()->getName()` to identify routes inside middleware - Terminate middleware (for logging) implement `terminate()` method ### Queues & Jobs - All time-consuming tasks (emails, API calls, file processing) must be dispatched as queued jobs - Jobs must implement `ShouldQueue` and define `$tries` and `$timeout` properties - Use `$this->release(30)` to retry a job after a delay when a recoverable error occurs - Use `$this->fail($exception)` to mark a job as permanently failed - Group related jobs in a chain with `Bus::chain([...])` for sequential processing ### Events & Listeners - Dispatch events for significant domain occurrences: `UserRegistered`, `OrderPlaced` - Register event-listener mappings in `EventServiceProvider::$listen` - Use `ShouldQueue` on listeners for non-critical side effects (sending emails, logging) - Keep events as simple data containers — no logic in event classes ### Caching - Use `Cache::remember()` and `Cache::rememberForever()` for computed values - Tag caches with `Cache::tags(['users'])->put(...)` to invalidate groups at once - Always define cache keys as constants to avoid typo-based cache misses - Invalidate caches in model observers or service methods after mutations ### Configuration & Environment - All configuration must go through `config/*.php` files — never call `env()` outside config files - Use `config('app.debug')` in application code, not `env('APP_DEBUG')` - Secrets must live in `.env` — never commit `.env` to version control ### Anti-patterns - Do not put business logic in Blade templates - Do not use `DB::table()` when an Eloquent model exists - Do not call `Auth::user()` deep in service classes — pass the user as a parameter - Do not use synchronous mail/notification sending in web requests — always queue them

CLI

npx mindaxis apply laravel-rules --target cursor --scope project

Используется в паках

Не используется ни в одном паке

← Правила