feat: add escape handling for pipe characters in Asciidoctor rendering

Author: thbkrkr

renderer/asciidoctor.go

@@ -169,6 +169,7 @@ func (adr *AsciidoctorRenderer) RenderFieldDoc(text string) string {
 
 func (adr *AsciidoctorRenderer) RenderValidation(text string) string {
 	renderedText := escapeFirstAsterixInEachPair(text)
+	renderedText = escapePipe(renderedText)
 	return escapeCurlyBraces(renderedText)
 }
 
@@ -190,6 +191,12 @@ func escapeFirstAsterixInEachPair(text string) string {
 	return text
 }
 
+// escapePipe ensures sufficient escapes are added to pipe characters, so they are not mistaken
+// for asciidoctor table formatting.
+func escapePipe(text string) string {
+	return strings.Replace(text, "|", "\\|", -1)
+}
+
 // escapeCurlyBraces ensures sufficient escapes are added to curly braces, so they are not mistaken
 // for asciidoctor id attributes.
 func escapeCurlyBraces(text string) string {

test/expected.asciidoc

@@ -175,7 +175,7 @@ Now let's test a list: +
 
 Another isolated comment. +
 
-Looks good? + |  | Pattern: `0\*[a-z0-9]*[a-z]\*[0-9]*|\s` +
+Looks good? + |  | Pattern: `0\*[a-z0-9]*[a-z]\*[0-9]*\|\s` +
 
 | *`rating`* __xref:{anchor_prefix}-github-com-elastic-crd-ref-docs-api-v1-rating[$$Rating$$]__ | Rating provided by the guest + |  | Maximum: 5 +
 Minimum: 1 +