made Referenced table section a table not a list

majimaccho · majimaccho · commit 23b4ac7b2b43 · 2024-06-04T09:55:14.000+09:00
diff --git a/output/md/md.go b/output/md/md.go
@@ -701,20 +701,22 @@ func (m *Md) makeTableTemplateData(t *schema.Table) map[string]interface{} {
 	}
 
 	// Referenced Tables
-	referencedTables := []string{}
+	hasReferencedTableWithLabels := false
 	for _, rt := range t.ReferencedTables {
-		if rt.External {
-			referencedTables = append(referencedTables, rt.Name)
-			continue
+		if len(rt.Labels) > 0 {
+			hasReferencedTableWithLabels = true
+			break
 		}
-		referencedTables = append(referencedTables, fmt.Sprintf("[%s](%s%s.md)", rt.Name, m.config.BaseUrl, mdurl.Encode(rt.Name)))
 	}
 
+	referencedTables := m.tablesData(t.ReferencedTables, number, adjust, showOnlyFirstParagraph, hasReferencedTableWithLabels)
+
 	if number {
 		columnsData = m.addNumberToTable(columnsData)
 		constraintsData = m.addNumberToTable(constraintsData)
 		indexesData = m.addNumberToTable(indexesData)
 		triggersData = m.addNumberToTable(triggersData)
+		referencedTables = m.addNumberToTable(referencedTables)
 	}
 
 	if adjust {
@@ -725,7 +727,7 @@ func (m *Md) makeTableTemplateData(t *schema.Table) map[string]interface{} {
 			"Constraints":      adjustTable(constraintsData),
 			"Indexes":          adjustTable(indexesData),
 			"Triggers":         adjustTable(triggersData),
-			"ReferencedTables": referencedTables,
+			"ReferencedTables": adjustTable(referencedTables),
 		}
 	}
 
diff --git a/output/md/md_test.go b/output/md/md_test.go
@@ -32,7 +32,7 @@ var tests = []struct {
 	{"mermaid a.md", "mermaid", false, false, false, false, "b", "a.md", "md_test_a.md.mermaid"},
 	{"showOnlyFirstParagraph README.md", "png", false, false, false, true, "b", "README.md", "md_test_README.md.first_para"},
 	{"showOnlyFirstParagraph a.md", "png", false, false, false, true, "b", "a.md", "md_test_a.md.first_para"},
-
+	{"view.md", "png", false, false, true, false, "b", "view.md", "md_test_view.md"},
 	{"viewpoint-1.md", "png", false, false, false, false, "b", "viewpoint-1.md", "md_test_viewpoint-1.md"},
 	{"viewpoint-2.md", "png", false, false, false, false, "b", "viewpoint-2.md", "md_test_viewpoint-2.md"},
 	{"viewpoint-1.md", "mermaid", false, false, false, false, "b", "viewpoint-1.md", "md_test_viewpoint-1.md.mermaid"},
@@ -49,6 +49,7 @@ var testsTemplate = []struct {
 }{
 	{"README.md", false, false, true, false, "README.md", "md_template_test_README.md"},
 	{"a.md", false, false, true, false, "a.md", "md_template_test_a.md"},
+	{"view.md", false, false, true, false, "view.md", "md_template_test_view.md"},
 	{"--adjust option", true, false, true, false, "README.md", "md_template_test_README.md.adjust"},
 	{"number", false, true, true, false, "README.md", "md_template_test_README.md.number"},
 	{"showOnlyFirstParagraph", false, true, true, true, "README.md", "md_template_test_README.md.first_para"},
diff --git a/output/md/templates/table.md.tmpl b/output/md/templates/table.md.tmpl
@@ -15,11 +15,7 @@
 ```
 
 </details>
-{{- end }}{{ $len := len .ReferencedTables }}{{ if ne $len 0 }}
 
-## {{ "Referenced Tables" | lookup }}
-{{ range $rt := .ReferencedTables }}
-- {{ $rt }}{{ end }}
 {{- end }}
 {{- if ne (len .Table.Labels) 0 }}
 
@@ -34,6 +30,13 @@
 |{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}
 {{- end }}
 
+{{ $len := len .ReferencedTables }}{{ if ne $len 2 -}}
+## {{ "Referenced Tables" | lookup }}
+{{ range $l := .ReferencedTables }}
+|{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}
+{{- end }}
+
+{{ end -}}
 {{ $len := len .Viewpoints }}{{ if ne $len 2 -}}
 ## {{ "Viewpoints" | lookup }}
 {{ range $l := .Viewpoints }}
diff --git a/testdata/md_template_test_view.md.golden b/testdata/md_template_test_view.md.golden
@@ -0,0 +1,33 @@
+# view
+
+---
+
+## Description
+
+view
+
+<details>
+<summary><strong>Table Definition</strong></summary>
+
+```sql
+CREATE VIEW view AS SELECT a, b FROM a JOIN b ON a.a = b.b
+```
+
+</details>
+
+## Columns
+
+| Name | Type | Default | Nullable | Children | Parents | Comment |
+| ---- | ---- | ------- | -------- | -------- | ------- | ------- |
+| view_column | INTEGER |  | false |  |  | column of view |
+
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [a](a.md) | 2 | TABLE A<br><br>THIS IS TABLE A |  | `blue` `green` |
+| [b](b.md) | 2 | table b |  | `red` `green` |
+
+---
+
+> Generated by [tbls](https://github.com/k1LoW/tbls)
diff --git a/testdata/md_test_view.md.golden b/testdata/md_test_view.md.golden
@@ -0,0 +1,31 @@
+# view
+
+## Description
+
+view
+
+<details>
+<summary><strong>Table Definition</strong></summary>
+
+```sql
+CREATE VIEW view AS SELECT a, b FROM a JOIN b ON a.a = b.b
+```
+
+</details>
+
+## Columns
+
+| Name | Type | Default | Nullable | Children | Parents | Comment |
+| ---- | ---- | ------- | -------- | -------- | ------- | ------- |
+| view_column | INTEGER |  | false |  |  | column of view |
+
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [a](a.md) | 2 | TABLE A |  | `blue` `green` |
+| [b](b.md) | 2 | table b |  | `red` `green` |
+
+---
+
+> Generated by [tbls](https://github.com/k1LoW/tbls)
diff --git a/testdata/templates/table.md.tmpl b/testdata/templates/table.md.tmpl
@@ -31,7 +31,14 @@
 |{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}
 {{- end }}
 
-{{ $len := len .Viewpoints }}{{ if ne $len 2 -}}
+{{ $len := len .ReferencedTables -}}{{ if ne $len 2 -}}
+## {{ "Referenced Tables" | lookup }}
+{{ range $l := .ReferencedTables }}
+|{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}
+{{- end }}
+
+{{ end -}}
+{{ $len := len .Viewpoints -}}{{ if ne $len 2 -}}
 ## {{ "Viewpoints" | lookup }}
 {{ range $l := .Viewpoints }}
 |{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}

Original file line number	Diff line number	Diff line change
`@@ -701,20 +701,22 @@ func (m Md) makeTableTemplateData(t schema.Table) map[string]interface{} {`
`701`	`701`	`}`
`702`	`702`
`703`	`703`	`// Referenced Tables`
`704`		`- referencedTables := []string{}`
	`704`	`+ hasReferencedTableWithLabels := false`
`705`	`705`	`for _, rt := range t.ReferencedTables {`
`706`		`- if rt.External {`
`707`		`- referencedTables = append(referencedTables, rt.Name)`
`708`		`- continue`
	`706`	`+ if len(rt.Labels) > 0 {`
	`707`	`+ hasReferencedTableWithLabels = true`
	`708`	`+ break`
`709`	`709`	`}`
`710`		`- referencedTables = append(referencedTables, fmt.Sprintf("[%s](%s%s.md)", rt.Name, m.config.BaseUrl, mdurl.Encode(rt.Name)))`
`711`	`710`	`}`
`712`	`711`
	`712`	`+ referencedTables := m.tablesData(t.ReferencedTables, number, adjust, showOnlyFirstParagraph, hasReferencedTableWithLabels)`
	`713`	`+`
`713`	`714`	`if number {`
`714`	`715`	`columnsData = m.addNumberToTable(columnsData)`
`715`	`716`	`constraintsData = m.addNumberToTable(constraintsData)`
`716`	`717`	`indexesData = m.addNumberToTable(indexesData)`
`717`	`718`	`triggersData = m.addNumberToTable(triggersData)`
	`719`	`+ referencedTables = m.addNumberToTable(referencedTables)`
`718`	`720`	`}`
`719`	`721`
`720`	`722`	`if adjust {`
`@@ -725,7 +727,7 @@ func (m Md) makeTableTemplateData(t schema.Table) map[string]interface{} {`
`725`	`727`	`"Constraints": adjustTable(constraintsData),`
`726`	`728`	`"Indexes": adjustTable(indexesData),`
`727`	`729`	`"Triggers": adjustTable(triggersData),`
`728`		`- "ReferencedTables": referencedTables,`
	`730`	`+ "ReferencedTables": adjustTable(referencedTables),`
`729`	`731`	`}`
`730`	`732`	`}`
`731`	`733`