mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
ab42f0d097
* HTML-ize code blocks inside a markdown table. Single line break. Add support for embedding markdown code blocks inside markdown tables Add support for single-line breaks: when the line ends with 2 spaces, place a single <br>. * Fix the testsuite, todo improve the escape code for document * Add the WithIndent testdata
116 lines
2.9 KiB
Go
116 lines
2.9 KiB
Go
package table
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
|
|
"github.com/segmentio/terraform-docs/internal/pkg/doc"
|
|
"github.com/segmentio/terraform-docs/internal/pkg/print"
|
|
"github.com/segmentio/terraform-docs/internal/pkg/print/markdown"
|
|
"github.com/segmentio/terraform-docs/internal/pkg/settings"
|
|
)
|
|
|
|
// Print prints a document as Markdown tables.
|
|
func Print(document *doc.Doc, settings *settings.Settings) (string, error) {
|
|
var buffer bytes.Buffer
|
|
|
|
if document.HasComment() {
|
|
printComment(&buffer, document.Comment, settings)
|
|
}
|
|
|
|
if document.HasInputs() {
|
|
if settings.SortByName {
|
|
if settings.SortInputsByRequired {
|
|
doc.SortInputsByRequired(document.Inputs)
|
|
} else {
|
|
doc.SortInputsByName(document.Inputs)
|
|
}
|
|
}
|
|
|
|
printInputs(&buffer, document.Inputs, settings)
|
|
}
|
|
|
|
if document.HasOutputs() {
|
|
if settings.SortByName {
|
|
doc.SortOutputsByName(document.Outputs)
|
|
}
|
|
|
|
if document.HasInputs() {
|
|
buffer.WriteString("\n")
|
|
}
|
|
|
|
printOutputs(&buffer, document.Outputs, settings)
|
|
}
|
|
|
|
return markdown.Sanitize(buffer.String()), nil
|
|
}
|
|
|
|
func getInputDefaultValue(input *doc.Input, settings *settings.Settings) string {
|
|
var result = "n/a"
|
|
|
|
if input.HasDefault() {
|
|
result = fmt.Sprintf("`%s`", print.GetPrintableValue(input.Default, settings, false))
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
func printComment(buffer *bytes.Buffer, comment string, settings *settings.Settings) {
|
|
buffer.WriteString(fmt.Sprintf("%s\n", comment))
|
|
}
|
|
|
|
func printInputs(buffer *bytes.Buffer, inputs []doc.Input, settings *settings.Settings) {
|
|
buffer.WriteString(fmt.Sprintf("%s Inputs\n\n", markdown.GenerateIndentation(0, settings)))
|
|
buffer.WriteString("| Name | Description | Type | Default |")
|
|
|
|
if settings.ShowRequired {
|
|
buffer.WriteString(" Required |\n")
|
|
} else {
|
|
buffer.WriteString("\n")
|
|
}
|
|
|
|
buffer.WriteString("|------|-------------|:----:|:-----:|")
|
|
|
|
if settings.ShowRequired {
|
|
buffer.WriteString(":-----:|\n")
|
|
} else {
|
|
buffer.WriteString("\n")
|
|
}
|
|
|
|
for _, input := range inputs {
|
|
buffer.WriteString(
|
|
fmt.Sprintf("| %s | %s | %s | %s |",
|
|
markdown.SanitizeName(input.Name, settings),
|
|
markdown.SanitizeDescriptionForTable(input.Description, settings),
|
|
input.Type,
|
|
getInputDefaultValue(&input, settings)))
|
|
|
|
if settings.ShowRequired {
|
|
buffer.WriteString(fmt.Sprintf(" %v |\n", printIsInputRequired(&input)))
|
|
} else {
|
|
buffer.WriteString("\n")
|
|
}
|
|
}
|
|
}
|
|
|
|
func printIsInputRequired(input *doc.Input) string {
|
|
if input.IsRequired() {
|
|
return "yes"
|
|
}
|
|
|
|
return "no"
|
|
}
|
|
|
|
func printOutputs(buffer *bytes.Buffer, outputs []doc.Output, settings *settings.Settings) {
|
|
buffer.WriteString(fmt.Sprintf("%s Outputs\n\n", markdown.GenerateIndentation(0, settings)))
|
|
buffer.WriteString("| Name | Description |\n")
|
|
buffer.WriteString("|------|-------------|\n")
|
|
|
|
for _, output := range outputs {
|
|
buffer.WriteString(
|
|
fmt.Sprintf("| %s | %s |\n",
|
|
markdown.SanitizeName(output.Name, settings),
|
|
markdown.SanitizeDescriptionForTable(output.Description, settings)))
|
|
}
|
|
}
|