From 18fb636e2f83fa93860b7896dc3b570b455d177e Mon Sep 17 00:00:00 2001 From: Talon Bowler Date: Thu, 13 Jun 2024 16:11:35 -0700 Subject: [PATCH] Add comment to document the purpose behind the non-standard handling of the error Signed-off-by: Talon Bowler (cherry picked from commit 366328ba6ad1f930fbef1d2a52a274e0644960a4) --- commands/build.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/commands/build.go b/commands/build.go index 09f500f7..9f85fa2f 100644 --- a/commands/build.go +++ b/commands/build.go @@ -878,6 +878,12 @@ func printResult(f *controllerapi.PrintFunc, res map[string]string) error { } } if lintResults.Error != nil { + // Print the error message and the source + // Normally, we would use `errdefs.WithSource` to attach the source to the + // error and let the error be printed by the handling that's already in place, + // but here we want to print the error in a way that's consistent with how + // the lint warnings are printed via the `lint.PrintLintViolations` function, + // which differs from the default error printing. fmt.Println() lintBuf := bytes.NewBuffer([]byte(lintResults.Error.Message + "\n")) sourceInfo := lintResults.Sources[lintResults.Error.Location.SourceIndex]