Quarkus Java Best Practices: Essential Cursor Rules Checklist for Developers

- **Adopt Clean Code Standards**: Craft readable, performant Java code with full documentation, adhering to Quarkus guidelines, Jakarta EE, and MicroProfile for organized packages.
- **Organize Project Layout**: Arrange code logically into resources, services, repositories, entities, and config folders for maintainable structure.
- **Apply Naming Standards**: Use PascalCase for classes (e.g., UserService), camelCase for methods/variables (e.g., validateOrder), and UPPER_CASE for constants (e.g., MAX_TIMEOUT).
- **Harness Quarkus Features**: Activate Dev Mode for rapid iteration, employ annotations like @ApplicationScoped, @Inject, and @ConfigProperty, and integrate extensions for build-time enhancements.
- **Enable Native Compilation**: Set up GraalVM via quarkus-maven-plugin properties for low-memory, fast-startup executables.
- **Leverage Modern Java**: Incorporate Java 17+ elements such as records and sealed classes where beneficial.
- **Manage Dependencies**: Rely on Quarkus BOM to align versions seamlessly.
- **Incorporate MicroProfile Tools**: Add Config, Health, and Metrics for robust enterprise features.
- **Implement Reactive Flows**: Deploy Vert.x for event-driven or streaming scenarios.
- **Handle Configurations**: Define settings in application.properties/yaml, inject via @ConfigProperty, and use profiles (dev/test/prod).
- **Optimize Dependency Injection**: Favor CDI with @Inject, constructor/method injection, @Singleton for testable, modular designs.
- **Build Comprehensive Tests**: Employ JUnit 5, @QuarkusTest for integrations, RestAssured for APIs, and Testcontainers/in-memory DBs.
- **Boost Performance**: Tune quarkus.native.* for images, apply @CacheResult/@CacheInvalidate, use Mutiny/Vert.x for async I/O, and index DB queries.
- **Secure Applications**: Integrate Quarkus Security (OIDC/JWT), configure CORS, and add security headers via extensions.
- **Set Up Logging/Monitoring**: Configure Quarkus logging (JSON/SLF4J), MicroProfile Health/Metrics/OpenTracing, with structured logs at appropriate levels.
- **Document APIs**: Enable quarkus-smallrye-openapi with annotations for comprehensive OpenAPI specs.
- **Streamline Data Access**: Use Hibernate ORM + Panache for entities/repositories, manage relationships (OneToMany etc.), and add Flyway/Liquibase migrations.
- **Streamline Builds/Deployments**: Use Maven/Gradle plugins, multi-stage Dockerfiles, profiles/env vars, targeting GraalVM for containers.
- **Design RESTful APIs**: Follow HTTP methods/status codes strictly.
- **Embrace Microservices**: Exploit Quarkus for quick boots and low resource use.
- **Apply SOLID Principles**: Ensure tight cohesion, loose coupling in reactive/async processing with Vert.x/Mutiny.