KofTwentyTwo/standards

0 Fork 0

Files

T

History

james.maesandClaude Opus 5.5 d6fedc762b

feat(coding): adopt Kingsrook coding standard with IDE and CLI configs

Cross-language coding standard (K22-CODE-01..26) adopted from Kingsrook's QQQ
CODE_STYLE.md, with profiles for C#/.NET, Java, TypeScript, Python, Rust, Go,
Swift, Shell/PowerShell, and Terraform, and the files each IDE and tool imports:
IntelliJ scheme, copyright profile and live templates, Checkstyle, Eclipse
formatter, .editorconfig, Directory.Build.props, ESLint Stylistic, ruff,
rustfmt/clippy/cargo-deny, golangci-lint, swift-format/SwiftLint, ShellCheck,
PSScriptAnalyzer, TFLint, sqlfluff, VS Code. Kingsrook files keep their
Apache-2.0 notice (NOTICE).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: James Maes <james@kof22.com>

2026-10-09 07:53:21 -05:00

checkstyle

feat(coding): adopt Kingsrook coding standard with IDE and CLI configs

2026-10-09 07:53:21 -05:00

gradle-checkstyle.gradle.kts

feat(coding): adopt Kingsrook coding standard with IDE and CLI configs

2026-10-09 07:53:21 -05:00

license-header.txt

feat(coding): adopt Kingsrook coding standard with IDE and CLI configs

2026-10-09 07:53:21 -05:00

maven-checkstyle.xml

feat(coding): adopt Kingsrook coding standard with IDE and CLI configs

2026-10-09 07:53:21 -05:00

README.md

feat(coding): adopt Kingsrook coding standard with IDE and CLI configs

2026-10-09 07:53:21 -05:00

README.md

Java

Build-time enforcement of the Java profile.

File	Purpose
`checkstyle/checkstyle.xml`	The KofTwentyTwo Checkstyle config. Kingsrook rules plus the KofTwentyTwo SPDX header and a ban on `System.out`/`System.err`/`printStackTrace()`. Self-contained, so it also works from its URL
`checkstyle/kingsrook/`	Kingsrook's original config and QQQ license header, unmodified, for QQQ-derived projects
`maven-checkstyle.xml`	Maven plugin block: Checkstyle 14.3.0 in the `validate` phase, failing on any warning
`gradle-checkstyle.gradle.kts`	Gradle equivalent: `checkstyle` plugin, `maxWarnings = 0`
`license-header.txt`	The source header (`$YEAR` placeholder) for tools that insert headers (Spotless `licenseHeaderFile`, IDE templates)

Published URL (always the latest on main): https://raw.githubusercontent.com/KofTwentyTwo/standards/main/configs/java/checkstyle/checkstyle.xml

Maven

Copy checkstyle/checkstyle.xml to checkstyle/checkstyle.xml in the repository (a local copy keeps builds reproducible; update it when this repository releases).
Paste the <plugin> block from maven-checkstyle.xml into <build><plugins>.
./mvnw -B verify now fails on any violation, locally and in CI.

Gradle

Copy checkstyle/checkstyle.xml as above, then add the contents of gradle-checkstyle.gradle.kts to build.gradle.kts. ./gradlew check fails on any violation.

IDEs

IntelliJ: see ../intellij (code-style scheme + CheckStyle-IDEA).
Eclipse: import ../eclipse/eclipse-formatter.xml and install the Checkstyle plug-in pointed at the URL above.
VS Code: ../vscode/settings.json sets java.format.settings.url and java.checkstyle.configuration to the published files.

Verified

Checkstyle 14.3.0 (CLI and maven-checkstyle-plugin 3.6.0 on Maven 3.9.16, JDK 21): a Kingsrook-style file passes; a file with 4-space indentation, same-line braces, a star import, no banner Javadoc, System.out, printStackTrace(), and no SPDX header fails with 17 violations. The Gradle snippet follows Gradle's documented checkstyle plugin API and was not run here (no Gradle installation).