feat: added support for generics to doc generation

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>

Author: fredbi

codegen/internal/generator/funcmaps/funcmaps.go

@@ -58,6 +58,7 @@ func FuncMap() template.FuncMap {
 		"returns":          PrintReturns,
 		"sourceLink":       sourceLink,
 		"titleize":         titleize,
+		"slugize":          slugize,
 	}
 }
 
@@ -345,3 +346,20 @@ func printDebug(in any) string {
 func printDate() string {
 	return time.Now().Format(time.DateOnly)
 }
+
+// slugize converts a name into a markdown ref inside a document.
+func slugize(in string) string {
+	return strings.ToLower(
+		strings.Map(func(r rune) rune {
+			switch r {
+			case '.', '_', ' ', '\t', ':':
+				return '-'
+			case '[', ']', ',':
+				return -1
+			default:
+				return r
+			}
+		},
+			in,
+		))
+}

codegen/internal/generator/templates/doc_page.md.gotmpl

@@ -31,14 +31,30 @@ keywords:
 _All links point to <{{ $godoc }}>_
 
 This domain exposes {{ .RefCount }} functionalities.
+{{- if .HasGenerics }}
+Generic assertions are marked with a {{ print "{{" }}% icon icon="star" color=orange %{{ print "}}" }}
+{{- end }}
 
+```tree
 {{- with .Package }}
   {{- $enableGenerics := .EnableGenerics }}
   {{- range .Functions }}{{/* functions in internal/assertions annotated with "domain:" */}}
     {{- if or (not .IsGeneric) ($enableGenerics) }}
       {{- if and (not .IsHelper) (not .IsConstructor) }}
+- [{{ .GenericName }}](#{{ slugize .GenericName }}) | {{ if .IsGeneric}}star | orange {{ else }}angles-right{{ end }}
+      {{- end }}
+    {{- end }}
+  {{- end }}
+{{- end }}
+```
 
-### {{ .Name }}
+{{- with .Package }}
+  {{- $enableGenerics := .EnableGenerics }}
+  {{- range .Functions }}{{/* functions in internal/assertions annotated with "domain:" */}}
+    {{- if or (not .IsGeneric) ($enableGenerics) }}
+      {{- if and (not .IsHelper) (not .IsConstructor) }}
+
+### {{ .GenericName }}{{ if .IsGeneric }} {{ print "{{" }}% icon icon="star" color=orange %{{ print "}}" }}{{ end }}{#{{ slugize .GenericName }}}
         {{- if .IsDeprecated }}
 
 {{ print "{{" }}% expand title="{{ .Name }} [DEPRECATED]" %{{ print "}}" }}
@@ -55,14 +71,14 @@ This domain exposes {{ .RefCount }} functionalities.
 {{ print "{{" }}% tab title="{{ .Package }}" style="secondary" %{{ print "}}" }}
 | Signature | Usage |
 |--|--|
-| [`{{.Package }}.{{ .Name }}({{ params .AllParams }}) {{ returns .Returns }}`]({{ $godoc }}/{{ .Package }}#{{ .Name }}) | package-level function |
+| [`{{.Package }}.{{ .GenericName }}({{ params .AllParams }}) {{ returns .Returns }}`]({{ $godoc }}/{{ .Package }}#{{ .Name }}) | package-level function |
             {{- if .EnableFormat }}
-| [`{{ .Package }}.{{ .Name }}f(t T, {{ params .Params }}, msg string, args ...any) {{ returns .Returns }}`]({{ $godoc }}/{{ .Package }}#{{ .Name }}f) | formatted variant |
+| [`{{ .Package }}.{{ .GenericName "f" }}(t T, {{ params .Params }}, msg string, args ...any) {{ returns .Returns }}`]({{ $godoc }}/{{ .Package }}#{{ .Name }}f) | formatted variant |
             {{- end }}
-            {{- if .EnableForward }}
+            {{- if and .EnableForward (not .IsGeneric) }}
 | [`{{ .Package}}.(*{{ .Receiver }}).{{ .Name }}({{ params .Params }}) {{ returns .Returns }}`]({{ $godoc }}/{{ .Package }}#{{ .Receiver }}.{{ .Name }}) | method variant |
             {{- end }}
-            {{- if and .EnableForward .EnableFormat }}
+            {{- if and .EnableForward .EnableFormat (not .IsGeneric) }}
 | [`{{ .Package }}.(*{{ .Receiver }}).{{ .Name }}f({{ params .Params }}, msg string, args ..any)`]({{ $godoc }}/{{ .Package }}#{{ .Receiver }}.{{ .Name }}f) | method formatted variant |
             {{- end }}
 {{ print "{{" }}% /tab %{{ print "}}" }}

codegen/internal/model/documentation.go

@@ -84,6 +84,20 @@ type Document struct {
 	Weight        int
 }
 
+func (d Document) HasGenerics() bool {
+	if d.Package == nil {
+		return false
+	}
+
+	for _, fn := range d.Package.Functions {
+		if fn.IsGeneric {
+			return true
+		}
+	}
+
+	return false
+}
+
 type ExtraPackages []*AssertionPackage
 
 func (pkgs ExtraPackages) LookupFunction(name string) []FunctionWithContext {

internal/assertions/boolean.go

@@ -29,16 +29,17 @@ func True(t T, value bool, msgAndArgs ...any) bool {
 //
 // # Usage
 //
-//	 type B bool
-//	 var b B = true
+//	type B bool
+//	var b B = true
 //
-//		assertions.True(t, b)
+//	assertions.True(t, b)
 //
 // # Examples
 //
 //	success: 1 == 1
 //	failure: 1 == 0
 func TrueT[B Boolean](t T, value B, msgAndArgs ...any) bool {
+	// Domain: boolean
 	if !bool(value) {
 		if h, ok := t.(H); ok {
 			h.Helper()