Platform baseline
Rules on this page 13
| ID | Level | Rule |
|---|---|---|
| PLAT-01 | MUST | The app builds on JDK 25 or newer. maven.compiler.release 25 is the floor, not the
ceiling: build and bundle a current JDK.
|
| PLAT-02 | MUST | The installers carry a jlinked runtime; users never install Java.
|
| PLAT-03 | MUST | The app builds on JavaFX 27 or newer.
|
| PLAT-04 | MUST | The app is one named JPMS module, com.<app>, whose module-info.java opens only what
reflection, FXML and Jackson need.
|
| PLAT-05 | MUST | Controls use AtlantaFX 3.x ( atlantafx-base), with light and dark themes.
|
| PLAT-06 | MUST | App stylesheets take their colors from AtlantaFX -color-* tokens, or from state tokens
built on them; no component rule carries a fixed hex. See Icons and color.
|
| PLAT-08 | MUST | The build is Maven with the Maven Wrapper committed ( mvnw, mvnw.cmd,
.mvn/wrapper/), so ./mvnw works on a clean machine.
|
| PLAT-09 | MUST | Nullness is declared with JSpecify and checked by NullAway on Error Prone at
compile time. Every package is @NullMarked in its own package-info.java.
|
| PLAT-10 | MUST | Code is formatted by Spotless with Palantir Java Format, and CI fails an unformatted
change.
|
| PLAT-11 | MUST | Tests run on JUnit (Jupiter, 5 or newer) and TestFX over JavaFX’s built-in
Headless glass platform ( -Dglass.platform=Headless), so FX tests need no display, no xvfb and no Monocle.
|
| PLAT-12 | MUST | A JaCoCo check runs at mvn verify: ≥ 0.90 lines, ≥ 0.90 methods, ≥ 0.79
branches, plus per-package floors.
|
| PLAT-13 | SHOULD | The app logs through java.util.logging and no other logging API. The Debug Log captures
it: DIAG-02.
|
| PLAT-14 | SHOULD | Config files are JSON, read and written by Jackson as plain classes (POJOs). Their schema
versions and migrations are SET-09.
|
- PLAT-01 MUST The app builds on JDK 25 or newer.
maven.compiler.release25 is the floor, not the ceiling: build and bundle a current JDK.- Check (code):
pom.xmlsetsmaven.compiler.releaseto 25 and the enforcer’srequireJavaVersionto the open-ended range[25,). - Reference: Editora
pom.xml.
- Check (code):
- PLAT-02 MUST The installers carry a jlinked runtime; users never install Java.
- Check (code): the
distprofile’s jpackage step builds a jlinked app image (jLinkOptions) and wraps the installer around it. - Reference: Editora
pom.xml(distprofile).
- Check (code): the
- PLAT-03 MUST The app builds on JavaFX 27 or newer.
- Check (code):
pom.xmlsetsjavafx.versionto 27 or later. - Reference: Editora
pom.xml.
- Check (code):
- PLAT-04 MUST The app is one named JPMS module,
com.<app>, whosemodule-info.javaopens only what reflection, FXML and Jackson need.- Check (code):
src/main/java/module-info.javadeclaresmodule com.<app>; eachopensline serves FXML, Jackson or another reflective reader. - Reference: Editora
src/main/java/module-info.java.
- Check (code):
- PLAT-05 MUST Controls use AtlantaFX 3.x (
atlantafx-base), with light and dark themes.- Check (code):
pom.xmldepends onatlantafx-base3.x; the theme list offers at least one light and one dark theme. - Reference: Editora
pom.xml,ui/Themes.java.
- Check (code):
- PLAT-06 MUST App stylesheets take their colors from AtlantaFX
-color-*tokens, or from state tokens built on them; no component rule carries a fixed hex. See Icons and color.- Check (code):
grep -nE '#[0-9a-fA-F]{3,8}\b' app.cssfinds hexes only where a token is defined (aladder()of the ground, a scoped-color-*block), not in a component’s-fx-*-coloror-fx-fill. - Reference: Editora
app.css;StyleContrastTest.severityAndDebugColoursComeFromTheStateTokensholds the severity and debug colors. Editora’sapp.cssstill has fixed hexes in a few component rules (the breakpoint markers, the execution arrow, the editor area’s defaults).
- Check (code):
- PLAT-08 MUST The build is Maven with the Maven Wrapper committed (
mvnw,mvnw.cmd,.mvn/wrapper/), so./mvnwworks on a clean machine.- Check (code):
mvnw,mvnw.cmdand.mvn/wrapper/maven-wrapper.propertiesare in the repository. - Reference: Editora
mvnw,.mvn/wrapper/.
- Check (code):
- PLAT-09 MUST Nullness is declared with JSpecify and checked by NullAway on Error Prone at
compile time. Every package is
@NullMarkedin its ownpackage-info.java.- Check (code): the compiler arguments include
-Xep:NullAway:ERROR; every source package has apackage-info.javawith@NullMarked. - Reference: Editora
pom.xml,docs/conventions.md#null-annotations-jspecify-checked-by-nullaway.
- Check (code): the compiler arguments include
- PLAT-10 MUST Code is formatted by Spotless with Palantir Java Format, and CI fails an unformatted
change.
- Check (code): the spotless plugin configures
palantirJavaFormat, and a CI job runsspotless:check. - Reference: Editora
pom.xml(spotless plugin),.github/workflows/ci.yml(Format).
- Check (code): the spotless plugin configures
- PLAT-11 MUST Tests run on JUnit (Jupiter, 5 or newer) and TestFX over JavaFX’s built-in
Headless glass platform (
-Dglass.platform=Headless), so FX tests need no display, no xvfb and no Monocle.- Check (code): surefire’s
systemPropertyVariablessetglass.platformtoHeadless; no Monocle dependency and no xvfb step in CI. - Reference: Editora
pom.xml(surefire),docs/testing.md,FxTestSupport.
- Check (code): surefire’s
- PLAT-12 MUST A JaCoCo
checkruns atmvn verify: ≥ 0.90 lines, ≥ 0.90 methods, ≥ 0.79 branches, plus per-package floors.- Check (code): the
jacoco-checkexecution is bound toverifywithBUNDLElimits of 0.90LINEand 0.90METHOD. - Reference: Editora
pom.xmljacoco-check.
- Check (code): the
- PLAT-13 SHOULD The app logs through
java.util.loggingand no other logging API. The Debug Log captures it: DIAG-02.- Check (code): the app’s own code imports no logging API other than
java.util.logging. - Reference: Editora
ui/DebugLog.java.
- Check (code): the app’s own code imports no logging API other than
- PLAT-14 SHOULD Config files are JSON, read and written by Jackson as plain classes (POJOs). Their schema
versions and migrations are SET-09.
- Check (code): every class written to the config folder is read and written through Jackson’s
ObjectMapper; no store builds or parses its JSON by hand. - Reference: Editora
config/Settings,config/migration/ConfigSchema.java.
- Check (code): every class written to the config folder is read and written through Jackson’s
The app’s typeface is Inter, bundled and registered before any CSS and attached to every scene: ICON-01 and ICON-02.

Everyday commands (identical in every repo)
Section titled “Everyday commands (identical in every repo)”./mvnw javafx:run # run the app./mvnw test # unit + headless FX tests, writes the JaCoCo report./mvnw spotless:apply # format./mvnw verify # full gate: tests, coverage check, NullAway./mvnw -Pfatjar package # runnable fat jar for this OS./mvnw clean -Pdist package # native installer for this OS (clean is mandatory)The clean in every -Pdist build is mandatory: incremental compilation can leave synthetic enum-switch
classes out of target/classes, and jlink then ships an app whose keyboard fails on the first keypress.
Pauta 4.3.1 · · Changelog · This page in the latest edition