Skip to content

Commit 7884c74

Browse files
noahdietznoahdietz
authored
gapic: strip reference links in comments (#341)
* gapic: update markdown dep to newer location * chore: update bazel dependencies
1 parent a27612a commit 7884c74

File tree

6 files changed

+75
-59
lines changed

6 files changed

+75
-59
lines changed

‎go.mod‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,12 @@
11
module github.com/googleapis/gapic-generator-go
22

33
require (
4-
github.com/golang-commonmark/html v0.0.0-20180910111043-7d7c804e1d46 // indirect
5-
github.com/golang-commonmark/linkify v0.0.0-20180910111149-f05efb453a0e // indirect
6-
github.com/golang-commonmark/markdown v0.0.0-20180910011815-a8f139058164
7-
github.com/golang-commonmark/mdurl v0.0.0-20180910110917-8d018c6567d6 // indirect
8-
github.com/golang-commonmark/puny v0.0.0-20180910110745-050be392d8b8 // indirect
94
github.com/golang/protobuf v1.3.5
105
github.com/google/go-cmp v0.4.0
116
github.com/jhump/protoreflect v1.6.0
12-
github.com/opennota/wd v0.0.0-20180911144301-b446539ab1e7 // indirect
13-
github.com/russross/blackfriday v2.0.0+incompatible // indirect
14-
github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
157
google.golang.org/genproto v0.0.0-20200319113533-08878b785e9c
168
gopkg.in/yaml.v2 v2.2.8
9+
gitlab.com/golang-commonmark/markdown v0.0.0-20191127184510-91b5b3c99c19
1710
)
1811

1912
go 1.13

‎go.sum‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ github.com/russross/blackfriday v2.0.0+incompatible h1:cBXrhZNUf9C+La9/YpS+UHpUT
4040
github.com/russross/blackfriday v2.0.0+incompatible/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
4141
github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
4242
github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
43+
gitlab.com/golang-commonmark/html v0.0.0-20191124015941-a22733972181 h1:K+bMSIx9A7mLES1rtG+qKduLIXq40DAzYHtb0XuCukA=
44+
gitlab.com/golang-commonmark/html v0.0.0-20191124015941-a22733972181/go.mod h1:dzYhVIwWCtzPAa4QP98wfB9+mzt33MSmM8wsKiMi2ow=
45+
gitlab.com/golang-commonmark/linkify v0.0.0-20191026162114-a0c2df6c8f82 h1:oYrL81N608MLZhma3ruL8qTM4xcpYECGut8KSxRY59g=
46+
gitlab.com/golang-commonmark/linkify v0.0.0-20191026162114-a0c2df6c8f82/go.mod h1:Gn+LZmCrhPECMD3SOKlE+BOHwhOYD9j7WT9NUtkCrC8=
47+
gitlab.com/golang-commonmark/markdown v0.0.0-20191127184510-91b5b3c99c19 h1:HsZm6XaTpEgZiZqcXZkUbG6BNtSZE3XyCTfo52YBoDY=
48+
gitlab.com/golang-commonmark/markdown v0.0.0-20191127184510-91b5b3c99c19/go.mod h1:CRIzp0wh6PvKEAeEOtp9wEpNKJJ1VFTNfHO4+ToRgVA=
49+
gitlab.com/golang-commonmark/mdurl v0.0.0-20191124015652-932350d1cb84 h1:qqjvoVXdWIcZCLPMlzgA7P9FZWdPGPvP/l3ef8GzV6o=
50+
gitlab.com/golang-commonmark/mdurl v0.0.0-20191124015652-932350d1cb84/go.mod h1:IJZ+fdMvbW2qW6htJx7sLJ04FEs4Ldl/MDsJtMKywfw=
51+
gitlab.com/golang-commonmark/puny v0.0.0-20191124015043-9f83538fa04f h1:Wku8eEdeJqIOFHtrfkYUByc4bCaTeA6fL0UJgfEiFMI=
52+
gitlab.com/golang-commonmark/puny v0.0.0-20191124015043-9f83538fa04f/go.mod h1:Tiuhl+njh/JIg0uS/sOJVYi0x2HEa5rc1OAaVsb5tAs=
53+
gitlab.com/opennota/wd v0.0.0-20180912061657-c5d65f63c638/go.mod h1:EGRJaqe2eO9XGmFtQCvV3Lm9NLico3UhFwUpCG/+mVU=
4354
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
4455
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
4556
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
@@ -64,6 +75,9 @@ golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a h1:1BGLXjeY4akVXGgbC9HugT3Jv
6475
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
6576
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
6677
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
78+
golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs=
79+
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
80+
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
6781
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
6882
golang.org/x/tools v0.0.0-20190226205152-f727befe758c h1:vamGzbGri8IKo20MQncCuljcQ5uAO6kaCeawQPVblAI=
6983
golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=

‎internal/gengapic/BUILD.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ go_library(
2222
"//internal/license:go_default_library",
2323
"//internal/pbinfo:go_default_library",
2424
"//internal/printer:go_default_library",
25-
"@com_github_golang_commonmark_markdown//:go_default_library",
2625
"@com_github_golang_protobuf//jsonpb:go_default_library_gen",
2726
"@com_github_golang_protobuf//proto:go_default_library",
27+
"@com_gitlab_golang_commonmark_markdown//:go_default_library",
2828
"@go_googleapis//google/api:annotations_go_proto",
2929
"@go_googleapis//google/rpc:code_go_proto",
3030
"@go_googleapis//google/longrunning:longrunning_go_proto",

‎internal/gengapic/markdown.go‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ import (
2323
"regexp"
2424
"strings"
2525

26-
"github.com/golang-commonmark/markdown"
26+
"gitlab.com/golang-commonmark/markdown"
2727
)
2828

2929
var linkParser = regexp.MustCompile(`<a href=["'](.+)["']`)
30+
var referenceParser = regexp.MustCompile(`\[(.+)\]\[(.*)\]`)
3031

3132
func MDPlain(s string) string {
3233
var mdr mdRenderer
@@ -58,7 +59,11 @@ func (m *mdRenderer) plain(t markdown.Token) {
5859
m.plain(c)
5960
}
6061
case *markdown.Text:
61-
m.sb.WriteString(t.Content)
62+
// Strip reference links, like [Foo][bar.Foo], that are invalid markdown
63+
// in the context of individual protobuf comments, down to just the
64+
// link text, which in this case is "Foo".
65+
content := referenceParser.ReplaceAllString(t.Content, "$1")
66+
m.sb.WriteString(content)
6267
case *markdown.CodeInline:
6368
m.sb.WriteString(t.Content)
6469
case *markdown.Softbreak:

‎internal/gengapic/markdown_test.go‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ func TestMDPlain(t *testing.T) {
7373
in: "html <a href=\"/link/to/some#thing\">\n with a softbreak</a> <br> test",
7474
want: "html with a softbreak (at /link/to/some#thing) \n test",
7575
},
76+
{
77+
in: "link to [a search engine](https://www.google.com) with request type [Search][foo.bar.v1.Search].",
78+
want: "link to a search engine (at https://www.google.com) with request type Search.",
79+
},
7680
} {
7781
got := MDPlain(tst.in)
7882
if got != tst.want {

‎repositories.bzl‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -65,41 +65,6 @@ def com_googleapis_gapic_generator_go_repositories():
6565
sum = "h1:EQciDnbrYxy13PgWoY8AqoxGiPrpgBZ1R8UNe3ddc+A=",
6666
version = "v0.1.0",
6767
)
68-
_maybe(
69-
go_repository,
70-
name = "com_github_golang_commonmark_html",
71-
importpath = "github.com/golang-commonmark/html",
72-
sum = "h1:FeNEDxIy7XouGTJKiJ9Ze5vUbcAIW/FRhQbtKBNmEz8=",
73-
version = "v0.0.0-20180910111043-7d7c804e1d46",
74-
)
75-
_maybe(
76-
go_repository,
77-
name = "com_github_golang_commonmark_linkify",
78-
importpath = "github.com/golang-commonmark/linkify",
79-
sum = "h1:TkuRzcq232K5ytXtQ+BPicsjYWZgt/lS6gJ5HqcUifQ=",
80-
version = "v0.0.0-20180910111149-f05efb453a0e",
81-
)
82-
_maybe(
83-
go_repository,
84-
name = "com_github_golang_commonmark_markdown",
85-
importpath = "github.com/golang-commonmark/markdown",
86-
sum = "h1:YaQaotRjMcVth1VzHUEQlD2oeyQAglA7CXdxp9QLvKM=",
87-
version = "v0.0.0-20180910011815-a8f139058164",
88-
)
89-
_maybe(
90-
go_repository,
91-
name = "com_github_golang_commonmark_mdurl",
92-
importpath = "github.com/golang-commonmark/mdurl",
93-
sum = "h1:XkgfhPs5AotQfcu3EfDEjyAUx91KdtjrxHXYGnZJhoU=",
94-
version = "v0.0.0-20180910110917-8d018c6567d6",
95-
)
96-
_maybe(
97-
go_repository,
98-
name = "com_github_golang_commonmark_puny",
99-
importpath = "github.com/golang-commonmark/puny",
100-
sum = "h1:DUgQdQmDg4sk4SfNR+qOkXcopGz36BL02vp/V7WbPQI=",
101-
version = "v0.0.0-20180910110745-050be392d8b8",
102-
)
10368
_maybe(
10469
go_repository,
10570
name = "com_github_golang_glog",
@@ -118,8 +83,8 @@ def com_googleapis_gapic_generator_go_repositories():
11883
go_repository,
11984
name = "com_github_golang_protobuf",
12085
importpath = "github.com/golang/protobuf",
121-
sum = "h1:gyjaxf+svBWX08ZjK86iN9geUJF0H6gp2IRKX6Nf6/I=",
122-
version = "v1.3.3",
86+
sum = "h1:F768QJ1E9tib+q5Sc8MkdJi1RxLTbRcTf8LJV56aRls=",
87+
version = "v1.3.5",
12388
)
12489
_maybe(
12590
go_repository,
@@ -135,13 +100,6 @@ def com_googleapis_gapic_generator_go_repositories():
135100
sum = "h1:h5jfMVslIg6l29nsMs0D8Wj17RDVdNYti0vDN/PZZoE=",
136101
version = "v1.6.0",
137102
)
138-
_maybe(
139-
go_repository,
140-
name = "com_github_opennota_wd",
141-
importpath = "github.com/opennota/wd",
142-
sum = "h1:cVQhwfBgiKTMAdYPbVeuIiTkdY59qZ3sp5RpyO8CNtg=",
143-
version = "v0.0.0-20180911144301-b446539ab1e7",
144-
)
145103
_maybe(
146104
go_repository,
147105
name = "com_github_prometheus_client_model",
@@ -163,6 +121,48 @@ def com_googleapis_gapic_generator_go_repositories():
163121
sum = "h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=",
164122
version = "v1.0.0",
165123
)
124+
_maybe(
125+
go_repository,
126+
name = "com_gitlab_golang_commonmark_html",
127+
importpath = "gitlab.com/golang-commonmark/html",
128+
sum = "h1:K+bMSIx9A7mLES1rtG+qKduLIXq40DAzYHtb0XuCukA=",
129+
version = "v0.0.0-20191124015941-a22733972181",
130+
)
131+
_maybe(
132+
go_repository,
133+
name = "com_gitlab_golang_commonmark_linkify",
134+
importpath = "gitlab.com/golang-commonmark/linkify",
135+
sum = "h1:oYrL81N608MLZhma3ruL8qTM4xcpYECGut8KSxRY59g=",
136+
version = "v0.0.0-20191026162114-a0c2df6c8f82",
137+
)
138+
_maybe(
139+
go_repository,
140+
name = "com_gitlab_golang_commonmark_markdown",
141+
importpath = "gitlab.com/golang-commonmark/markdown",
142+
sum = "h1:HsZm6XaTpEgZiZqcXZkUbG6BNtSZE3XyCTfo52YBoDY=",
143+
version = "v0.0.0-20191127184510-91b5b3c99c19",
144+
)
145+
_maybe(
146+
go_repository,
147+
name = "com_gitlab_golang_commonmark_mdurl",
148+
importpath = "gitlab.com/golang-commonmark/mdurl",
149+
sum = "h1:qqjvoVXdWIcZCLPMlzgA7P9FZWdPGPvP/l3ef8GzV6o=",
150+
version = "v0.0.0-20191124015652-932350d1cb84",
151+
)
152+
_maybe(
153+
go_repository,
154+
name = "com_gitlab_golang_commonmark_puny",
155+
importpath = "gitlab.com/golang-commonmark/puny",
156+
sum = "h1:Wku8eEdeJqIOFHtrfkYUByc4bCaTeA6fL0UJgfEiFMI=",
157+
version = "v0.0.0-20191124015043-9f83538fa04f",
158+
)
159+
_maybe(
160+
go_repository,
161+
name = "com_gitlab_opennota_wd",
162+
importpath = "gitlab.com/opennota/wd",
163+
sum = "h1:uPZaMiz6Sz0PZs3IZJWpU5qHKGNy///1pacZC9txiUI=",
164+
version = "v0.0.0-20180912061657-c5d65f63c638",
165+
)
166166
_maybe(
167167
go_repository,
168168
name = "com_google_cloud_go",
@@ -195,8 +195,8 @@ def com_googleapis_gapic_generator_go_repositories():
195195
go_repository,
196196
name = "org_golang_google_genproto",
197197
importpath = "google.golang.org/genproto",
198-
sum = "h1:jB9+PJSvu5tBfmJHy/OVapFdjDF3WvpkqRhxqrmzoEU=",
199-
version = "v0.0.0-20200218151345-dad8c97a84f5",
198+
sum = "h1:5aI3/f/3eCZps9xwoEnmgfDJDhMbnJpfqeGpjVNgVEI=",
199+
version = "v0.0.0-20200319113533-08878b785e9c",
200200
)
201201
_maybe(
202202
go_repository,
@@ -258,8 +258,8 @@ def com_googleapis_gapic_generator_go_repositories():
258258
go_repository,
259259
name = "org_golang_x_text",
260260
importpath = "golang.org/x/text",
261-
sum = "h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=",
262-
version = "v0.3.0",
261+
sum = "h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs=",
262+
version = "v0.3.2",
263263
)
264264
_maybe(
265265
go_repository,

0 commit comments

Comments
 (0)