Skip to content

fix: report formatting errors with line numbers #2117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamietanna merged 1 commit into from
Nov 1, 2025
Merged

fix: report formatting errors with line numbers #2117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion pkg/codegen/codegen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ import (
"bytes"
"context"
"embed"
"errors"
"fmt"
"go/scanner"
"io"
"io/fs"
"net/http"
Expand Down Expand Up @@ -435,11 +437,36 @@ func Generate(spec *openapi3.T, opts Configuration) (string, error) {

outBytes, err := imports.Process(opts.PackageName+".go", []byte(goCode), nil)
if err != nil {
return "", fmt.Errorf("error formatting Go code %s: %w", goCode, err)
// if we don't get a line number
errLine := -1
var scanErr scanner.ErrorList
if errors.As(err, &scanErr) && scanErr.Len() > 0 {
// for now, only return the first error's information
errLine = scanErr[0].Pos.Line
}
return "", fmt.Errorf("error formatting Go code:\n%s\nerror was: %w", addLineNumbers(goCode, errLine), err)
}
return string(outBytes), nil
}

func addLineNumbers(goCode string, lineWithError int) string {
var out []string
lines := strings.Split(goCode, "\n")
for i, line := range lines {
// lines for humans start at 1
lineNumber := i + 1

errLine := " "
if lineNumber == lineWithError {
errLine = "❗"
}

out = append(out, fmt.Sprintf("%s%5d: %s", errLine, lineNumber, line))
}

return strings.Join(out, "\n")
}

func GenerateTypeDefinitions(t *template.Template, swagger *openapi3.T, ops []OperationDefinition, excludeSchemas []string) (string, error) {
var allTypes []TypeDefinition
if swagger.Components != nil {
Expand Down
Loading