CtrlK
BlogDocsLog inGet started
Tessl Logo

giuseppe-trisciuoglio/developer-kit

Comprehensive developer toolkit providing reusable skills for Java/Spring Boot, TypeScript/NestJS/React/Next.js, Python, PHP, AWS CloudFormation, AI/RAG, DevOps, and more.

90

Quality

90%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Risky

Do not use without reviewing

This version of the tile failed moderation
Moderation pipeline encountered an internal error
Overview
Quality
Evals
Security
Files

project-structure.mdplugins/developer-kit-java/rules/

paths:
**/*.java

Rule: Java Project Structure

Context

Enforce a consistent, domain-driven project structure for Java applications, particularly Spring Boot projects, to maintain separation of concerns and scalability.

Guidelines

Package Organization

Organize packages by domain module, then by layer within each module:

com.company.project/
├── config/                  # Application-level configuration
│   ├── SecurityConfig.java
│   └── WebConfig.java
├── common/                  # Shared utilities and base classes
│   ├── exception/
│   │   ├── BusinessException.java
│   │   └── GlobalExceptionHandler.java
│   └── util/
├── order/                   # Domain module: Order
│   ├── web/                 # Controllers / REST endpoints
│   │   ├── OrderController.java
│   │   └── dto/
│   │       ├── OrderRequest.java
│   │       └── OrderResponse.java
│   ├── service/             # Business logic
│   │   ├── OrderService.java
│   │   └── impl/
│   │       └── OrderServiceImpl.java
│   ├── repository/          # Data access
│   │   └── OrderRepository.java
│   └── domain/              # Entity / domain model
│       ├── Order.java
│       └── OrderStatus.java
└── user/                    # Domain module: User
    ├── web/
    ├── service/
    ├── repository/
    └── domain/

Layer Responsibilities

  • web/: REST controllers, request/response DTOs, input validation
  • service/: Business logic, transaction management, orchestration
  • repository/: Data access interfaces (Spring Data JPA repositories)
  • domain/: JPA entities, value objects, enums
  • config/: Spring @Configuration classes
  • exception/: Custom exceptions and global exception handlers

File Organization Rules

  • One public class per file
  • DTOs belong in web/dto/ or a shared dto/ package, never in domain/
  • Use Records for DTOs (Java 17+)
  • Keep controllers thin — delegate logic to services
  • Repository interfaces extend JpaRepository or CrudRepository
  • Configuration classes should be focused and single-purpose

Test Structure

Mirror the source package structure under src/test/java/:

src/test/java/com/company/project/order/
├── web/
│   └── OrderControllerTest.java
├── service/
│   └── OrderServiceTest.java
└── repository/
    └── OrderRepositoryTest.java

Examples

✅ Good

// src/main/java/com/acme/order/web/dto/OrderResponse.java
package com.acme.order.web.dto;

public record OrderResponse(Long id, String status, BigDecimal total) {}

❌ Bad

// Placing DTOs in domain package
package com.acme.order.domain;

public class OrderDTO { ... }  // Wrong package and not a Record

plugins

developer-kit-java

rules

error-handling.md

language-best-practices.md

naming-conventions.md

project-structure.md

README.md

CHANGELOG.md

context7.json

CONTRIBUTING.md

README_CN.md

README_ES.md

README_IT.md

README.md

tessl.json

tile.json