Tighten name search to avoid false positives

Author: iwahbe

pkg/tfgen/docs.go

@@ -928,7 +928,7 @@ func parseArgReferenceSection(subsection []string, ret *entityDocs) {
 			unbaked = map[docsPath]struct{}{}
 		case ast.KindListItem:
 			// We have entered a new item
-			if name := nodeItemName(src, node); name != "" {
+			if name := nodeItemName(src, node.(*ast.ListItem)); name != "" {
 				current = append(current, &namedNode{node, name, true})
 				key := keyOf(current)
 				setLatest()
@@ -1143,15 +1143,20 @@ func cleanDescription(path docsPath, desc string) string {
 	return strings.TrimRightFunc(desc, unicode.IsSpace)
 }
 
-func nodeItemName(src []byte, node ast.Node) string {
+var nodeItemNameRegex = regexp.MustCompile("^`[a-zA-Z0-9_]+?`")
+
+func nodeItemName(src []byte, node *ast.ListItem) string {
 	if node == nil {
 		return ""
 	}
 	var name string
 	contract.AssertNoErrorf(ast.Walk(node, func(node ast.Node, entering bool) (ast.WalkStatus, error) {
-		if node.Kind() == ast.KindCodeSpan {
+		switch node := node.(type) {
+		case *ast.CodeSpan:
 			name = string(node.Text(src))
 			return ast.WalkStop, nil
+		case *ast.Text:
+			return ast.WalkStop, nil
 		}
 		return ast.WalkContinue, nil
 	}), "We don't return an error")

pkg/tfgen/docs_test.go

@@ -106,6 +106,46 @@ type testcase struct {
 	Expected string
 }
 
+func TestNodeItemName(t *testing.T) {
+	t.Parallel()
+	tests := []struct{ listItem, expected string }{
+		{
+			listItem: "- <a name=\"schema\"></a>`schema` - (Optional) A JSON schema for the table.",
+			expected: "schema",
+		},
+		{
+			listItem: "* `reference_file_schema_uri` - (Optional) When creating an external table, the user can provide a reference file with",
+			expected: "reference_file_schema_uri",
+		},
+		{
+			listItem: "- foo `bar`",
+			expected: "",
+		},
+		{
+			listItem: " *   `fizz` buzz",
+			expected: "fizz",
+		},
+	}
+
+	for _, tt := range tests {
+		tt := tt
+		t.Run("", func(t *testing.T) {
+			t.Parallel()
+			src := []byte(tt.listItem)
+			node := goldmark.New().Parser().Parse(
+				text.NewReader(src))
+			assert.NoError(t, ast.Walk(node, func(node ast.Node, _ bool) (ast.WalkStatus, error) {
+				if node, ok := node.(*ast.ListItem); ok {
+					actual := nodeItemName(src, node)
+					assert.Equal(t, tt.expected, actual)
+					return ast.WalkStop, nil
+				}
+				return ast.WalkContinue, nil
+			}))
+		})
+	}
+}
+
 func TestURLRewrite(t *testing.T) {
 	tests := []testcase{
 		{

pkg/tfgen/test_data/resources/bigquery_table/docs.json

@@ -116,10 +116,7 @@
       "description": "The number of rows at the top of the sheet\nthat BigQuery will skip when reading the data. At least one of `range` or\n`skip_leading_rows` must be set."
     },
     "hive_partitioning_options.mode": {
-      "description": "When set, what mode of hive partitioning to use when\nreading data. The following modes are supported.\n\nAUTO: automatically infer partition key name(s) and type(s).\n\nSTRINGS: automatically infer partition key name(s). All types are\nNot all storage formats support hive partitioning. Requesting hive\npartitioning on an unsupported format will lead to an error.\nCurrently supported formats are: JSON, CSV, ORC, Avro and Parquet."
-    },
-    "hive_partitioning_options.mode.CUSTOM": {
-      "description": "CUSTOM: when set to `CUSTOM`, you must encode the partition key schema within the `source_uri_prefix` by setting `source_uri_prefix` to `gs://bucket/path_to_table/{key1:TYPE1}/{key2:TYPE2}/{key3:TYPE3}`."
+      "description": "When set, what mode of hive partitioning to use when\nreading data. The following modes are supported.\n\nAUTO: automatically infer partition key name(s) and type(s).\n\nSTRINGS: automatically infer partition key name(s). All types are\nNot all storage formats support hive partitioning. Requesting hive\npartitioning on an unsupported format will lead to an error.\nCurrently supported formats are: JSON, CSV, ORC, Avro and Parquet.\n\nCUSTOM: when set to `CUSTOM`, you must encode the partition key schema within the `source_uri_prefix` by setting `source_uri_prefix` to `gs://bucket/path_to_table/{key1:TYPE1}/{key2:TYPE2}/{key3:TYPE3}`."
     },
     "json_options.encoding": {
       "description": "The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8."