Skip to content

Commit 37ae2f5

Browse files
mfelipemfelipe
committed
Add custom tag support using $comment
1 parent ba09651 commit 37ae2f5

File tree

9 files changed

+72
-6
lines changed

9 files changed

+72
-6
lines changed

‎go.sum‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6N
44
github.com/davecgh/go-spew v0.0.0-20161028175848-04cdfd42973b/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
55
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
66
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
7-
github.com/goccy/go-yaml v1.17.1 h1:LI34wktB2xEE3ONG/2Ar54+/HJVBriAGJ55PHls4YuY=
8-
github.com/goccy/go-yaml v1.17.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
97
github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
108
github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
119
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=

‎go.work.sum‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
dario.cat/mergo v1.0.0/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk=
22
github.com/atombender/go-jsonschema/tests/data v0.0.0-20231003003002-2b73c089a581/go.mod h1:kLoRQLRVy+GT9/PG2e3u31DPvDmtFEn7pX6FItvbqlA=
3+
github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0=
34
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
45
github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
56
github.com/fatih/color v1.17.0/go.mod h1:YZ7TlrGPkiz6ku9fK3TLD/pl3CpsiFyu8N92HLgmosI=
@@ -13,7 +14,9 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk
1314
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
1415
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
1516
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
17+
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
1618
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
19+
github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
1720
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
1821
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
1922
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=

‎pkg/generator/schema_generator.go‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,10 @@ func (g *schemaGenerator) addStructField(
815815
}
816816
}
817817

818+
if strings.Contains(prop.Comment, "go-jsonschema-tags") {
819+
tags += extractTags(prop.Comment)
820+
}
821+
818822
structField.Tags = strings.TrimSpace(tags)
819823

820824
if structField.Comment == "" {

‎pkg/generator/utils.go‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
package generator
22

33
import (
4+
"regexp"
45
"sort"
6+
"strings"
57

68
"github.com/atombender/go-jsonschema/pkg/codegen"
79
"github.com/atombender/go-jsonschema/pkg/schemas"
@@ -51,3 +53,16 @@ func isMapType(t codegen.Type) bool {
5153

5254
return isMapType
5355
}
56+
57+
const regexTag = `.*go-jsonschema-tags=([[:alnum:]]+:"(?:[^"]|"")*"[[:space:]]*)`
58+
59+
var reg = regexp.MustCompile(regexTag)
60+
61+
func extractTags(comment string) (tags string) {
62+
matches := reg.FindStringSubmatch(comment)
63+
64+
if len(matches) > 1 {
65+
tags = strings.Join(matches[1:], " ")
66+
}
67+
return
68+
}

‎pkg/schemas/model.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,8 @@ type Type struct {
146146
// RFC draft-wright-json-schema-00.
147147
Version string `json:"$schema,omitempty"` // Section 6.1.
148148
Ref string `json:"$ref,omitempty"` // Section 7.
149+
// RFC draft-handrews-json-schema-01
150+
Comment string `json:"$comment,omitempty"` // Section 8.3.2
149151
// RFC draft-wright-json-schema-validation-00, section 5.
150152
MultipleOf *float64 `json:"multipleOf,omitempty"` // Section 5.1.
151153
Maximum *float64 `json:"maximum,omitempty"` // Section 5.2.

‎tests/data/misc/customTags/customTags.go‎

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/data/misc/customTags/customTags.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-09/schema#",
3+
"id": "https://example.com/customTags",
4+
"type": "object",
5+
"properties": {
6+
"url": {
7+
"type": "string",
8+
"$comment": "go-jsonschema-tags=fake:\"{url}\" json:\"url,ommitempty\""
9+
},
10+
"id": {
11+
"type": "string",
12+
"$comment": "just a comment to be ignored"
13+
},
14+
"lorenIpsun": {
15+
"type": "string",
16+
"$comment": "go-jsonschema-tags=fake:\"{loremipsumparagraph:3,5,12,`\\n`}\" json:\"lorenIpsun,ommitempty\""
17+
},
18+
"meta": {
19+
"type": "string",
20+
"$comment": "Regex testing go-jsonschema-tags=metadata:\"meta\" json:\"meta,ommitempty\" should work fine"
21+
}
22+
}
23+
}

‎tests/generation_test.go‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,13 @@ func TestTags(t *testing.T) {
153153
testExampleFile(t, cfg, "./data/misc/tags/tags.json")
154154
}
155155

156+
func TestCustomTags(t *testing.T) {
157+
t.Parallel()
158+
159+
cfg := basicConfig
160+
testExampleFile(t, cfg, "./data/misc/customTags/customTags.json")
161+
}
162+
156163
func TestStructNameFromTitle(t *testing.T) {
157164
t.Parallel()
158165

‎tests/go.sum‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,9 @@ dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA=
33
github.com/davecgh/go-spew v0.0.0-20161028175848-04cdfd42973b/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
44
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
55
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
6-
github.com/go-viper/mapstructure/v2 v2.1.0 h1:gHnMa2Y/pIxElCH2GlZZ1lZSsn6XMtufpGyP1XxdC/w=
7-
github.com/go-viper/mapstructure/v2 v2.1.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
86
github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=
97
github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
10-
github.com/goccy/go-yaml v1.17.1 h1:LI34wktB2xEE3ONG/2Ar54+/HJVBriAGJ55PHls4YuY=
11-
github.com/goccy/go-yaml v1.17.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
8+
github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
129
github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
1310
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
1411
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=

0 commit comments

Comments
 (0)