Skip to content
Orinuno

Code Style

Formatting is enforced by Spotless using Google Java Format in AOSP profile. SpotBugs is available for static analysis but is opt-in, not wired into CI.

Spotless

Section titled “Spotless”

Runs automatically on mvn verify. If the build fails on a formatting check, apply the fix locally:

Terminal window
mvn spotless:apply

The AOSP profile uses 4-space indentation and a 100-column limit. Wildcard imports are banned; IntelliJ users should set the “Class count to use import with *” and “Names count to use static import with *” to something unreachable (e.g., 999).

SpotBugs (opt-in)

Section titled “SpotBugs (opt-in)”

Not part of verify. Run manually:

Terminal window
mvn spotbugs:check

The exclusion filter lives in spotbugs-exclude.xml. Current baseline: zero findings.

Conventions we care about

Section titled “Conventions we care about”
  • No comments that narrate the code. Comments explain non-obvious intent, trade-offs, or constraints — not what a line does.
  • Records for DTOs where possible. ContentExportDto is a record; entities stay as Lombok @Data classes.
  • Lombok for boilerplate. @Data, @Builder, @RequiredArgsConstructor are the three we use most.
  • Reactive where it helps. Controllers return Mono<ResponseEntity<T>> when the call chain is non-trivial; otherwise plain ResponseEntity<T> is fine.
  • No ${...} in MyBatis for user input. Only whitelisted sortBy and order parameters use string interpolation, and the controller validates them before passing in.
Section titled “Related”