Skip to content

ecosystem.md

Latest commit

 

History

History
32 lines (19 loc) · 2.38 KB

ecosystem.md

File metadata and controls

32 lines (19 loc) · 2.38 KB

Ecosystem — works well with other tools

Project Equilibrium is not a “do everything” mapping stack. It generates DTO-like types from your model. Many teams combine it with other libraries:

MapStruct

Use MapStruct @Mapper interfaces to map between domain (or API) types and Project Equilibrium–generated DTOs, records, or VOs. Generated code follows patterns MapStruct already supports (getters/setters, record components, builders where used, nested paths).

  • Build: Add the Project Equilibrium processor and mapstruct-processor on the annotation processor path, with generated sources on the compile classpath so both processors see each other’s output in one compilation.
  • Mappings: Align names or use @Mapping where they differ. For types built with builders, enable MapStruct’s builder support when needed.
  • VOs: Default VOs are immutable (no setters). MapStruct can still map to them via the generated constructor. Use @GenerateVo(setters=true) only if you intentionally want a mutable VO and setter-based mapping.

When to combine

  • Project Equilibrium — keep transport/value types in sync with the domain at compile time
  • MapStruct (or similar) — express field-to-field mappings between types that already exist

Different modules can standardize on different pieces: for example, generated DTOs in an API module and MapStruct mappers in an adapter layer.

Lombok version compatibility

Project Equilibrium has no runtime dependency on Lombok. When you enable @GenerateDto(builder = true), the processor emits @SuperBuilder and @Builder.Default annotations into generated source code. Your project's Lombok then expands these during its own annotation processing pass.

  • Minimum Lombok version for builders: 1.18.2 (@SuperBuilder was introduced in this release)
  • No maximum version constraint — Equilibrium emits standard Lombok annotations as string literals, so any newer Lombok version that supports @SuperBuilder will work
  • Without builders: Lombok is entirely optional; Equilibrium has no Lombok dependency

Related guides