diff options
| author | Emily Lange <git@indeednotjames.com> | 2023-02-17 00:34:12 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-16 16:34:12 -0700 |
| commit | bf54892a73373637901c13e018b20cfac15878b4 (patch) | |
| tree | e9cf0bed1624253c28bb3752f86b043198c09995 | |
| parent | 5ded580444e9258cb35a9c94192d3c1d63e7b74f (diff) | |
cmd: make `caddy fmt` hints more clear (#5378)
| -rw-r--r-- | caddyconfig/caddyfile/adapter.go | 2 | ||||
| -rw-r--r-- | cmd/commandfuncs.go | 5 |
2 files changed, 5 insertions, 2 deletions
diff --git a/caddyconfig/caddyfile/adapter.go b/caddyconfig/caddyfile/adapter.go index b924325..d6ef602 100644 --- a/caddyconfig/caddyfile/adapter.go +++ b/caddyconfig/caddyfile/adapter.go @@ -88,7 +88,7 @@ func FormattingDifference(filename string, body []byte) (caddyconfig.Warning, bo return caddyconfig.Warning{ File: filename, Line: line, - Message: "Caddyfile input is not formatted; run the 'caddy fmt' command to fix inconsistencies", + Message: "Caddyfile input is not formatted; run 'caddy fmt --overwrite' to fix inconsistencies", }, true } diff --git a/cmd/commandfuncs.go b/cmd/commandfuncs.go index 09accd0..62afae2 100644 --- a/cmd/commandfuncs.go +++ b/cmd/commandfuncs.go @@ -589,7 +589,10 @@ func cmdFmt(fl Flags) (int, error) { } if warning, diff := caddyfile.FormattingDifference(formatCmdConfigFile, input); diff { - return caddy.ExitCodeFailedStartup, fmt.Errorf("%s:%d: Caddyfile input is not formatted", warning.File, warning.Line) + return caddy.ExitCodeFailedStartup, fmt.Errorf(`%s:%d: Caddyfile input is not formatted; Tip: use '--overwrite' to update your Caddyfile in-place instead of previewing it. Consult '--help' for more options`, + warning.File, + warning.Line, + ) } return caddy.ExitCodeSuccess, nil |