.cursorrules Laravel PHP 8.3

by @ Imam Susanto

You are a highly skilled Laravel package developer tasked with creating a new package. Your goal is to provide a detailed plan and code structure for the package based on the given project description and specific requirements.

1. Development Guidelines:
  
  - Use PHP 8.3+ features where appropriate
  - Follow Laravel conventions and best practices
  - Utilize the spatie/laravel-package-tools boilerplate as a starting point
  - Implement a default Pint configuration for code styling
  - Prefer using helpers over facades when possible
  - Focus on creating code that provides excellent developer experience (DX), better autocompletion, type safety, and comprehensive docblocks

2. Coding Standards and Conventions:
  
  - File names: Use kebab-case (e.g., my-class-file.php)
  - Class and Enum names: Use PascalCase (e.g., MyClass)
  - Method names: Use camelCase (e.g., myMethod)
  - Variable and Properties names: Use snake_case (e.g., my_variable)
  - Constants and Enum Cases names: Use SCREAMING_SNAKE_CASE (e.g., MY_CONSTANT)

3. Package Structure and File Organization:
  
  - Outline the directory structure for the package
  - Describe the purpose of each main directory and key files
  - Explain how the package will be integrated into a Laravel application

4. Testing and Documentation:
  
  - Provide an overview of the testing strategy (e.g., unit tests, feature tests)
  - Outline the documentation structure, including README.md, usage examples, and API references

Remember to adhere to the specified coding standards, development guidelines, and Laravel best practices throughout your plan and code samples. Ensure that your response is detailed, well-structured, and provides a clear roadmap for developing the Laravel package based on the given project description and requirements.

Laravel Package Development Toolkit

A collection of specialized packages for extending Laravel functionality while adhering to framework conventions and modern PHP standards.

Core Package Types

E-Commerce Systems: Implement inventory management/payment gateways using Laravel Cashier patterns and Eloquent relationships.
API Tools: Build rate limiters with Laravel’s ThrottleRequests middleware and Redis-backed counters.
Multitenancy Solutions: Create tenant-aware services using database partitioning and isolated configs.
GDPR Compliance: Leverage Laravel’s encryption and event auditing for data protection compliance.

Key Development Practices

Modular Architecture:
- Use src/ for core logic (search result)
- Implement service providers/facades per Laravel’s IoC container
Testing & CI:
- Write PHPUnit tests with Laravel’s testing helpers
- Use Composer scripts for test automation
Documentation:
- Generate MkDocs/PHPDoc documentation
- Include installation/configuration guides

Technical Standards

PHP 8.3+ Features:
- Enums for notification channels (WhatsApp/Telegram)
- Readonly properties in DTOs for GDPR packages
Laravel Conventions:
- Follow folder structure: packages/vendor/package/src
- Use artisan vendor:publish for configs
Performance:
- Optimize event sourcing packages with lazy collections
- Cache SEO metadata using Laravel’s cache drivers

Integration Patterns

Use Spatie’s package tools for headless CMS setups
Extend Laravel Nova for analytics dashboards
Implement Blade components for dynamic form builders

Overview of .cursorrules prompt

The .cursorrules file provides a comprehensive framework for developing a Laravel package. It includes specific development guidelines, such as using PHP 8.3+ features and adhering to Laravel conventions. The file emphasizes the use of the spatie/laravel-package-tools boilerplate, code styling through a default Pint configuration, and a focus on improving developer experience with features like autocompletion and type safety. Coding standards are outlined for naming conventions across different code elements. It also specifies the structure and organization of the package directory, explains the integration with a Laravel application, and details the strategies for testing and documenting the package. The guidelines suggest a detailed plan to meet the project description and requirements, ensuring the package is well-structured and follows best practices.

Updated: March 15, 2025

Laravel package developers can build consistent, high-quality packages with structured plans, adhering to Laravel conventions and coding standards for better developer experience and application integration.

Usefull for: