Platform baseline
Rules on this page 12
| ID | Level | Rule |
|---|---|---|
| PLAT-01 | MUST | The app builds on JDK 25 or newer. maven.compiler.release 25 is the floor, not the
ceiling: a newer JDK builds the app too. CI builds and bundles JDK 25, the current LTS, in every app
(REL-25); the family moves to the next LTS together, in an edition of Pauta.
|
| 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). The light and dark themes it carries are
ICON-15.
|
| 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 with build-wide floors of ≥ 0.90 lines and
≥ 0.90 methods. The branch floor and each package’s own floor are QUAL-03.
|
| 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: a newer JDK builds the app too. CI builds and bundles JDK 25, the current LTS, in every app (REL-25); the family moves to the next LTS together, in an edition of Pauta.- Check (code):
pom.xmlsetsmaven.compiler.releaseto 25 or later and the enforcer’srequireJavaVersionto the open-ended range[25,). - Command:
[ -f pom.xml ] || { echo 'not an app root: no pom.xml here'; exit 1; }; r=$(sed -n 's:.*<maven.compiler.release>\([0-9]*\)<.*:\1:p' pom.xml | head -n 1); [ "${r:-0}" -ge 25 ] && grep -qE '<version>\[2[5-9],\)</version>' pom.xml || { echo "maven.compiler.release ${r:-none}"; grep -nE 'requireJavaVersion|<version>\[' pom.xml; false; } - 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. - Command:
[ -f pom.xml ] || { echo 'not an app root: no pom.xml here'; exit 1; }; v=$(sed -n 's:.*<javafx.version>\([0-9]*\).*:\1:p' pom.xml | head -n 1); echo "javafx.version ${v:-none}"; [ "${v:-0}" -ge 27 ] - 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). The light and dark themes it carries are ICON-15.- Check (code):
pom.xmldepends onatlantafx-base3.x. - Reference: Editora
pom.xml,ui/Themes.java.
- Check (code):
- Colors come from AtlantaFX’s
-color-*tokens and the state tokens built on them, never a fixed hex in a component rule: ICON-08. - 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. - Command:
[ -f pom.xml ] || { echo 'not an app root: no pom.xml here'; exit 1; }; ! for f in mvnw mvnw.cmd .mvn/wrapper/maven-wrapper.properties; do test -f "$f" || echo "missing $f"; done | grep . - 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. - Command:
[ -f pom.xml ] || { echo 'not an app root: no pom.xml here'; exit 1; }; { grep -q 'NullAway:ERROR' pom.xml || { echo 'no -Xep:NullAway:ERROR in pom.xml'; false; }; } && ! find src/main/java -name '*.java' ! -name package-info.java ! -name module-info.java -exec dirname {} \; | sort -u | while read -r d; do grep -qs '@NullMarked' "$d/package-info.java" || echo "not @NullMarked: $d"; done | grep . - 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 CI runs its check: aspotless:checkstep, or the plugin’scheckgoal bound to a phase a workflow runs (./mvnw verify). - Command:
[ -f pom.xml ] || { echo 'not an app root: no pom.xml here'; exit 1; }; { grep -q palantirJavaFormat pom.xml || { echo 'pom.xml configures no palantirJavaFormat'; false; }; } && { grep -rq 'spotless:check' .github/workflows || { sed -n '/spotless-maven-plugin/,/<\/plugin>/p' pom.xml | grep -q '<goal>check</goal>' && grep -rqE 'mvnw.* (verify|install|deploy)' .github/workflows; } || { echo 'CI runs neither spotless:check nor a phase the check goal is bound to'; false; }; } - 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 in a step that runs tests (a release leg may use it to train the AOT cache, REL-10). - Reference: Editora
pom.xml(surefire),docs/testing.md,FxTestSupport.
- Check (code): surefire’s
- PLAT-12 MUST A JaCoCo
checkruns atmvn verifywith build-wide floors of ≥ 0.90 lines and ≥ 0.90 methods. The branch floor and each package’s own floor are QUAL-03.- 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. - Command:
[ -f pom.xml ] || { echo 'not an app root: no pom.xml here'; exit 1; }; ! grep -rnE '^import (static )?(org\.slf4j|org\.apache\.logging|org\.apache\.commons\.logging|ch\.qos\.logback|org\.jboss\.logging|org\.tinylog)\.' src/main/java - 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 5.0.0 · · Changelog · This page in the latest edition