Add support multiline comment for model field in go client (#24)

* Add support multiline comment for model field

* Don't compare first lines of files in tests

gen/gen.go

@@ -1,6 +1,6 @@
 package gen
 
-const version = "2.4.0"
+const version = "2.4.1"
 
 const DefinitionsPrefix = "#/definitions/"
 

golang/go_template.go

@@ -46,7 +46,7 @@ func NewClient(endpoint string, header http.Header, httpClient *http.Client) *Cl
 
 {{ range .Models }}
 type {{ .Name }} struct {
-	{{ range .Fields }}{{ if ne .Description "" }}// {{ .Description }}
+	{{ range .Fields }}{{ if ne .Description "" }} {{ .CommentDescription }}
 	{{ end }}{{ title .Name }} {{ if and .Optional (eq .ArrayItemType "")}}*{{ end }}{{ .GoType }} ` + "`json:\"{{ .Name }}{{if .Optional}},omitempty{{end}}\"`" + `
 {{ end }}
 }

golang/rpcgen_test.go

@@ -5,7 +5,6 @@ import (
 	"os"
 	"testing"
 
-	"github.com/vmkteam/rpcgen/v2/gen"
 	"github.com/vmkteam/zenrpc/v2"
 	"github.com/vmkteam/zenrpc/v2/testdata"
 )
@@ -28,11 +27,11 @@ func TestGenerateGoClient(t *testing.T) {
 		t.Fatalf("open test data file: %v", err)
 	}
 
-	// cut version from comparsion
-	generated = bytes.ReplaceAll(generated, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
-	testData = bytes.ReplaceAll(testData, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
+	// cut first line with version from comparsion
+	_, generatedBody, _ := bytes.Cut(generated, []byte{'\n'})
+	_, testDataBody, _ := bytes.Cut(testData, []byte{'\n'})
 
-	if !bytes.Equal(generated, testData) {
+	if !bytes.Equal(generatedBody, testDataBody) {
 		t.Fatalf("bad generator output")
 	}
 }

golang/schema.go

@@ -138,11 +138,7 @@ func (m Method) HasErrors() bool {
 
 // CommentDescription add to head of all lines two slashes
 func (m Method) CommentDescription() string {
-	if len(m.Description) == 0 {
-		return ""
-	}
-
-	return "// " + strings.ReplaceAll(m.Description, "\n", "\n// ")
+	return commentText(m.Description)
 }
 
 type Error struct {
@@ -187,6 +183,11 @@ func (v Value) LocalModelName() string {
 	return localModelName(v.ModelName)
 }
 
+// CommentDescription add to head of all lines two slashes
+func (v Value) CommentDescription() string {
+	return commentText(v.Description)
+}
+
 func localModelName(name string) string {
 	return strings.ReplaceAll(titleFirstLetter(name), ".", "")
 }
@@ -491,3 +492,12 @@ func convertDefinitionToModel(def smd.Definition, name string) Model {
 
 	return model
 }
+
+// commentText add to head of all lines two slashes
+func commentText(text string) string {
+	if text == "" {
+		return ""
+	}
+
+	return "// " + strings.ReplaceAll(text, "\n", "\n// ")
+}

php/php_client_test.go

@@ -5,7 +5,6 @@ import (
 	"os"
 	"testing"
 
-	"github.com/vmkteam/rpcgen/v2/gen"
 	"github.com/vmkteam/zenrpc/v2"
 	"github.com/vmkteam/zenrpc/v2/testdata"
 )
@@ -26,11 +25,14 @@ func TestGeneratePHPClient(t *testing.T) {
 		t.Fatalf("open test data file: %v", err)
 	}
 
-	// cut version from comparsion
-	generated = bytes.ReplaceAll(generated, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
-	testData = bytes.ReplaceAll(testData, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
+	// cut first two lines with version from comparsion
+	generated = bytes.TrimPrefix(generated, []byte("<?php\n"))
+	testData = bytes.TrimPrefix(testData, []byte("<?php\n"))
 
-	if !bytes.Equal(generated, testData) {
+	_, generatedBody, _ := bytes.Cut(generated, []byte{'\n'})
+	_, testDataBody, _ := bytes.Cut(testData, []byte{'\n'})
+
+	if !bytes.Equal(generatedBody, testDataBody) {
 		t.Fatalf("bad generator output")
 	}
 }

swift/swift_client_test.go

@@ -5,7 +5,6 @@ import (
 	"os"
 	"testing"
 
-	"github.com/vmkteam/rpcgen/v2/gen"
 	"github.com/vmkteam/zenrpc/v2"
 	"github.com/vmkteam/zenrpc/v2/testdata"
 )
@@ -26,11 +25,11 @@ func TestGenerateSwiftClient(t *testing.T) {
 		t.Fatalf("open test data file: %v", err)
 	}
 
-	// cut version from comparsion
-	generated = bytes.ReplaceAll(generated, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
-	testData = bytes.ReplaceAll(testData, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
+	// cut first line with version from comparsion
+	_, generatedBody, _ := bytes.Cut(generated, []byte{'\n'})
+	_, testDataBody, _ := bytes.Cut(testData, []byte{'\n'})
 
-	if !bytes.Equal(generated, testData) {
+	if !bytes.Equal(generatedBody, testDataBody) {
 		t.Fatalf("bad generator output")
 	}
 }

typescript/rpcgen_test.go

@@ -5,7 +5,6 @@ import (
 	"os"
 	"testing"
 
-	"github.com/vmkteam/rpcgen/v2/gen"
 	"github.com/vmkteam/zenrpc/v2"
 	"github.com/vmkteam/zenrpc/v2/testdata"
 )
@@ -26,11 +25,11 @@ func TestGenerateTypeScriptClient(t *testing.T) {
 		t.Fatalf("open test data file: %v", err)
 	}
 
-	// cut version from comparsion
-	generated = bytes.ReplaceAll(generated, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
-	testData = bytes.ReplaceAll(testData, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
+	// cut first line with version from comparsion
+	_, generatedBody, _ := bytes.Cut(generated, []byte{'\n'})
+	_, testDataBody, _ := bytes.Cut(testData, []byte{'\n'})
 
-	if !bytes.Equal(generated, testData) {
+	if !bytes.Equal(generatedBody, testDataBody) {
 		t.Fatalf("bad generator output")
 	}
 }
@@ -51,11 +50,11 @@ func TestGenerateTypeScriptClasses(t *testing.T) {
 		t.Fatalf("open test data file: %v", err)
 	}
 
-	// cut version from comparsion
-	generated = bytes.ReplaceAll(generated, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
-	testData = bytes.ReplaceAll(testData, []byte("v"+gen.DefaultGeneratorData().Version), []byte(""))
+	// cut first line with version from comparsion
+	_, generatedBody, _ := bytes.Cut(generated, []byte{'\n'})
+	_, testDataBody, _ := bytes.Cut(testData, []byte{'\n'})
 
-	if !bytes.Equal(generated, testData) {
+	if !bytes.Equal(generatedBody, testDataBody) {
 		t.Fatalf("bad generator output")
 	}
 }