Enforce coding quality and style requirements using Spotless

[michaelhaaf]

---

title: Enforce coding quality and style requirements using Spotless milestone: Milestone 4b Requirements label: enhancement

Requirement

Your project code should enforce style and code quality before builds succeeds. This enforement should take place within ./gradlew build so that it is automatically used by your build workflow.

NOTE: you should not need to change your GitHub Actions workflow to meet this requirement.

NOTE: this change is required even if you already have "working" ktlint incorporated in your set up. spotlessCheck/apply uses ktlint but adds extra important functionality (enforces failure when there are issues using spotlessCheck, automatically included in ./gradlew build; corrects failures automatically when spotlessApply)

Priority

The sooner the better, but wait until after the "Fix build on main" and "Build workflow" issues I created are finished.

Resources

• Spotless Gradle Plugin documentation. In particular the Kotlin section is most relevant.
• The pull request in my KotlinWithCompose where I add spotlessCheck and a refactor using spotlessCheck

Before completing this ticket:

• [ ] ./gradlew build also runs spotlessCheck task, fails build if any spotlessCheck rules are broken
• [ ] ./gradlew spotlessApply applies fixes to issues raised by spotlessCheck
• [ ] A refactor commit is included which applies ./gradlew spotlessApply to your entire repository. See My repository refactor commit for an example.