starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-04-25 01:38:34 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Change pkl format --write to exit 0 when formatting violations are found (#1340)

Browse Source
This commit is contained in:
Jen Basch
2025-12-05 16:01:09 -08:00
committed by GitHub
parent 2de1d5b9d2
commit 139f70bb79
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/modules/pkl-cli/pages/index.adoc
View File

@@ -741,9 +741,9 @@ pkl shell-completion zsh
This command formats or checks formatting of Pkl files. + This command formats or checks formatting of Pkl files. +
Exit codes: Exit codes:
* 0: No violations found. * 0: No violations found or files were updated.
* 1: An unexpected error happened (ex.: IO error) * 1: An unexpected error happened (ex.: IO error)
* 11: Violations were found. * 11: Violations were found (when running without `--write`).
If the path is a directory, recursively looks for files with a `.pkl` extension, or files named `PklProject`. If the path is a directory, recursively looks for files with a `.pkl` extension, or files named `PklProject`.

4
pkl-cli/src/main/kotlin/org/pkl/cli/CliFormatterCommand.kt
View File

@@ -110,7 +110,6 @@ constructor(
val formatted = format(contents) val formatted = format(contents)
if (contents != formatted) { if (contents != formatted) {
status.update(FORMATTING_VIOLATION)
if (diffNameOnly || overwrite) { if (diffNameOnly || overwrite) {
// if `--diff-name-only` or `-w` is specified, only write file names // if `--diff-name-only` or `-w` is specified, only write file names
writeLine(pathStr) writeLine(pathStr)
@@ -118,6 +117,9 @@ constructor(
if (overwrite) { if (overwrite) {
path.writeText(formatted, Charsets.UTF_8) path.writeText(formatted, Charsets.UTF_8)
} else {
// only exit on violation for "check" operations, not when overwriting
status.update(FORMATTING_VIOLATION)
} }
} }