From 6b3f15ae718b1d2eadc144915519644e37193d98 Mon Sep 17 00:00:00 2001 From: cce <51567+cce@users.noreply.github.com> Date: Fri, 14 Nov 2025 12:19:25 -0500 Subject: [PATCH 1/2] make happier generated code --- gen/maxsize.go | 4 ++-- printer/print.go | 10 +++++----- printer/print_test.go | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/gen/maxsize.go b/gen/maxsize.go index 10772b2..fa630b2 100644 --- a/gen/maxsize.go +++ b/gen/maxsize.go @@ -92,10 +92,9 @@ func (s *maxSizeGen) Execute(p Elem) ([]string, error) { // to not affect other code that will use p. p = p.Copy() - s.p.comment("MaxSize returns a maximum valid message size for this message type") - if IsDangling(p) { baseType := p.(*BaseElem).IdentName + s.p.comment(strings.TrimSuffix(getMaxSizeMethod(baseType), "()") + " returns a maximum valid message size for this message type") s.p.printf("\nfunc %s int{", getMaxSizeMethod(p.TypeName())) s.p.printf("\n return %s", getMaxSizeMethod(baseType)) s.p.printf("\n}") @@ -109,6 +108,7 @@ func (s *maxSizeGen) Execute(p Elem) ([]string, error) { s.halted = false // receiver := imutMethodReceiver(p) + s.p.comment(strings.TrimSuffix(getMaxSizeMethod(p.TypeName()), "()") + " returns a maximum valid message size for this message type") s.p.printf("\nfunc %s (s int) {", getMaxSizeMethod(p.TypeName())) s.state = assignM next(s, p) diff --git a/printer/print.go b/printer/print.go index fb45e1e..acf6bc8 100644 --- a/printer/print.go +++ b/printer/print.go @@ -140,13 +140,13 @@ func generate(f *parse.FileSet, mode gen.Method) (*bytes.Buffer, *bytes.Buffer, } func writePkgHeader(b *bytes.Buffer, name string) { - b.WriteString("package ") - b.WriteString(name) - b.WriteByte('\n') - // write generated code marker // https://github.com/tinylib/msgp/issues/229 // https://golang.org/s/generatedcode b.WriteString("// Code generated by github.com/algorand/msgp DO NOT EDIT.\n\n") + b.WriteString("package ") + b.WriteString(name) + b.WriteByte('\n') + b.WriteByte('\n') } func writeImportHeader(b *bytes.Buffer, imports ...string) { @@ -163,6 +163,6 @@ func writeImportHeader(b *bytes.Buffer, imports ...string) { } func writeBuildHeader(b *bytes.Buffer, buildHeaders []string) { - headers := fmt.Sprintf("//go:build %s\n// +build %s\n\n", strings.Join(buildHeaders, " "), strings.Join(buildHeaders, " ")) + headers := fmt.Sprintf("//go:build %s\n\n", strings.Join(buildHeaders, " ")) b.WriteString(headers) } diff --git a/printer/print_test.go b/printer/print_test.go index 112fa10..a2993cc 100644 --- a/printer/print_test.go +++ b/printer/print_test.go @@ -9,7 +9,7 @@ func TestWriteBuildHeader(t *testing.T) { testBuf := bytes.NewBuffer(make([]byte, 0, 4096)) buildHeaders := []string{"foobar"} expectedBuf := bytes.NewBuffer(make([]byte, 0, 4096)) - expectedBuf.WriteString("//go:build foobar\n// +build foobar\n\n") + expectedBuf.WriteString("//go:build foobar\n\n") writeBuildHeader(testBuf, buildHeaders) From c35b6427b3da03b75e2379f6189f894ce6973792 Mon Sep 17 00:00:00 2001 From: cce <51567+cce@users.noreply.github.com> Date: Fri, 14 Nov 2025 12:32:57 -0500 Subject: [PATCH 2/2] CR feedback --- printer/print.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/printer/print.go b/printer/print.go index acf6bc8..bbe2f98 100644 --- a/printer/print.go +++ b/printer/print.go @@ -142,11 +142,11 @@ func generate(f *parse.FileSet, mode gen.Method) (*bytes.Buffer, *bytes.Buffer, func writePkgHeader(b *bytes.Buffer, name string) { // https://github.com/tinylib/msgp/issues/229 // https://golang.org/s/generatedcode - b.WriteString("// Code generated by github.com/algorand/msgp DO NOT EDIT.\n\n") - b.WriteString("package ") - b.WriteString(name) - b.WriteByte('\n') - b.WriteByte('\n') + b.WriteString(`// Code generated by github.com/algorand/msgp DO NOT EDIT. + +package ` + name + ` + +`) } func writeImportHeader(b *bytes.Buffer, imports ...string) {