Function assertPipesAreInCodeBlocks

pkg/cmd/root/help_test.go:103–125

If not in a code block or a code span, kramdown treats pipes ("|") as table column separators, even if there's no table header, or left/right table row borders (i.e. lines starting and ending with a pipe). We need to assert there's no pipe in the text unless it's in a code-block or code-span. (See

(t *testing.T, cmd *cobra.Command)

//
// (See https://github.com/cli/cli/issues/10348)
func assertPipesAreInCodeBlocks(t *testing.T, cmd *cobra.Command) {
	md := goldmark.New()
	reader := text.NewReader([]byte(cmd.Long))
	doc := md.Parser().Parse(reader)

	var checkNode func(node ast.Node)
	checkNode = func(node ast.Node) {
		if node.Kind() == ast.KindCodeSpan || node.Kind() == ast.KindCodeBlock {
			return
		}

		if node.Kind() == ast.KindText {
			text := string(node.(*ast.Text).Segment.Value(reader.Source()))
			require.NotContains(t, text, "|", `found pipe ("|") in plain text in %q docs`, cmd.CommandPath())
		}

		for child := node.FirstChild(); child != nil; child = child.NextSibling() {
			checkNode(child)
		}
	}

	checkNode(doc)
}