diff --git a/internal/dns/docs/generator.go b/internal/dns/docs/generator.go
index 30e543faa3..3ffdcc92c5 100644
--- a/internal/dns/docs/generator.go
+++ b/internal/dns/docs/generator.go
@@ -8,11 +8,11 @@ import (
"errors"
"fmt"
"go/format"
- "io"
+ html "html/template"
"log"
"os"
"path/filepath"
- "sort"
+ "slices"
"strings"
"text/template"
@@ -22,11 +22,12 @@ import (
const (
root = "../../../"
- mdTemplate = root + "internal/dns/docs/dns.md.tmpl"
- cliTemplate = root + "internal/dns/docs/dns.go.tmpl"
- cliOutput = root + "cmd/zz_gen_cmd_dnshelp.go"
- docOutput = root + "docs/content/dns"
- readmePath = root + "README.md"
+ mdTemplate = root + "internal/dns/docs/dns.md.tmpl"
+ cliTemplate = root + "internal/dns/docs/dns.go.tmpl"
+ cliOutput = root + "cmd/zz_gen_cmd_dnshelp.go"
+ docOutput = root + "docs/content/dns"
+ readmeTemplate = root + "internal/dns/docs/readme.md.tmpl"
+ readmePath = root + "README.md"
)
const (
@@ -109,7 +110,8 @@ func generateCLIHelp(models *descriptors.Providers) error {
}
func generateReadMe(models *descriptors.Providers) error {
- maximum, lines := extractTableData(models)
+ tpl := html.Must(html.New(filepath.Base(readmeTemplate)).ParseFiles(readmeTemplate))
+ providers := orderProviders(models)
file, err := os.Open(readmePath)
if err != nil {
@@ -128,8 +130,7 @@ func generateReadMe(models *descriptors.Providers) error {
if text == startLine {
_, _ = fmt.Fprintln(buffer, text)
- err = writeDNSTable(buffer, lines, maximum)
- if err != nil {
+ if err = tpl.Execute(buffer, providers); err != nil {
return err
}
skip = true
@@ -157,83 +158,45 @@ func generateReadMe(models *descriptors.Providers) error {
return os.WriteFile(readmePath, buffer.Bytes(), 0o666)
}
-func extractTableData(models *descriptors.Providers) (int, [][]string) {
- readmePattern := "[%s](https://go-acme.github.io/lego/dns/%s/)"
-
- items := []string{fmt.Sprintf(readmePattern, "Manual", "manual")}
-
- var maximum int
-
- for _, pvd := range models.Providers {
- item := fmt.Sprintf(readmePattern, strings.ReplaceAll(pvd.Name, "|", "/"), pvd.Code)
- items = append(items, item)
-
- if maximum < len(item) {
- maximum = len(item)
- }
- }
+func orderProviders(models *descriptors.Providers) [][]descriptors.Provider {
+ providers := append(models.Providers, descriptors.Provider{
+ Name: "Manual",
+ Code: "manual",
+ })
const nbCol = 4
- sort.Slice(items, func(i, j int) bool {
- return strings.ToLower(items[i]) < strings.ToLower(items[j])
+ slices.SortFunc(providers, func(a, b descriptors.Provider) int {
+ return strings.Compare(strings.ToLower(a.Name), strings.ToLower(b.Name))
})
- var lines [][]string
- var line []string
+ var matrix [][]descriptors.Provider
+ var row []descriptors.Provider
- for i, item := range items {
+ for i, p := range providers {
switch {
- case len(line) == nbCol:
- lines = append(lines, line)
- line = []string{item}
-
- case i == len(items)-1:
- line = append(line, item)
- for j := len(line); j < nbCol; j++ {
- line = append(line, "")
+ case len(row) == nbCol:
+ matrix = append(matrix, row)
+ row = []descriptors.Provider{p}
+
+ case i == len(providers)-1:
+ row = append(row, p)
+ for j := len(row); j < nbCol; j++ {
+ row = append(row, descriptors.Provider{})
}
- lines = append(lines, line)
+ matrix = append(matrix, row)
default:
- line = append(line, item)
+ row = append(row, p)
}
}
- if len(line) < nbCol {
- for j := len(line); j < nbCol; j++ {
- line = append(line, "")
- }
- lines = append(lines, line)
- }
-
- return maximum, lines
-}
-
-func writeDNSTable(w io.Writer, lines [][]string, size int) error {
- _, err := fmt.Fprintf(w, "\n")
- if err != nil {
- return err
- }
-
- _, err = fmt.Fprintf(w, "|%[1]s|%[1]s|%[1]s|%[1]s|\n", strings.Repeat(" ", size+2))
- if err != nil {
- return err
- }
-
- _, err = fmt.Fprintf(w, "|%[1]s|%[1]s|%[1]s|%[1]s|\n", strings.Repeat("-", size+2))
- if err != nil {
- return err
- }
-
- linePattern := fmt.Sprintf("| %%-%[1]ds | %%-%[1]ds | %%-%[1]ds | %%-%[1]ds |\n", size)
- for _, line := range lines {
- _, err = fmt.Fprintf(w, linePattern, line[0], line[1], line[2], line[3])
- if err != nil {
- return err
+ if len(row) < nbCol {
+ for j := len(row); j < nbCol; j++ {
+ row = append(row, descriptors.Provider{})
}
+ matrix = append(matrix, row)
}
- _, err = fmt.Fprintf(w, "\n")
- return err
+ return matrix
}
diff --git a/internal/dns/docs/readme.md.tmpl b/internal/dns/docs/readme.md.tmpl
new file mode 100644
index 0000000000..3e0140243a
--- /dev/null
+++ b/internal/dns/docs/readme.md.tmpl
@@ -0,0 +1,11 @@
+
+