99 lines
2.5 KiB
Go
99 lines
2.5 KiB
Go
package docs
|
|
|
|
import (
|
|
"fmt"
|
|
"sort"
|
|
)
|
|
|
|
type entryType string
|
|
|
|
const (
|
|
entryTypeModule entryType = "module"
|
|
entryTypeResource entryType = "resource"
|
|
entryTypeFunction entryType = "function"
|
|
)
|
|
|
|
// PackageTreeItem is a type for representing a package in a
|
|
// navigable tree format starting from the top-level/index/root
|
|
// of a package.
|
|
type PackageTreeItem struct {
|
|
Name string `json:"name"`
|
|
Type entryType `json:"type"`
|
|
Link string `json:"link"`
|
|
Children []PackageTreeItem `json:"children,omitempty"`
|
|
}
|
|
|
|
func generatePackageTree(rootMod modContext) ([]PackageTreeItem, error) {
|
|
numResources := len(rootMod.resources)
|
|
numFunctions := len(rootMod.functions)
|
|
// +1 to add the module itself as an entry.
|
|
size := numResources + numFunctions + 1
|
|
packageTree := make([]PackageTreeItem, 0, size)
|
|
|
|
for _, m := range rootMod.children {
|
|
modName := m.getModuleFileName()
|
|
displayName := modFilenameToDisplayName(modName)
|
|
|
|
children, err := generatePackageTree(*m)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("generating children for module %s (mod token: %s): %w", displayName, m.mod, err)
|
|
}
|
|
|
|
ti := PackageTreeItem{
|
|
Name: displayName,
|
|
Type: entryTypeModule,
|
|
Link: getModuleLink(displayName),
|
|
Children: children,
|
|
}
|
|
|
|
packageTree = append(packageTree, ti)
|
|
}
|
|
sort.Slice(packageTree, func(i, j int) bool {
|
|
return packageTree[i].Name < packageTree[j].Name
|
|
})
|
|
|
|
for _, r := range rootMod.resources {
|
|
name := resourceName(r)
|
|
ti := PackageTreeItem{
|
|
Name: name,
|
|
Type: entryTypeResource,
|
|
Link: getResourceLink(name),
|
|
Children: nil,
|
|
}
|
|
|
|
packageTree = append(packageTree, ti)
|
|
}
|
|
sort.SliceStable(packageTree, func(i, j int) bool {
|
|
pti, ptj := packageTree[i], packageTree[j]
|
|
switch {
|
|
case pti.Type != ptj.Type:
|
|
return pti.Type == entryTypeModule && ptj.Type != entryTypeModule
|
|
default:
|
|
return pti.Name < ptj.Name
|
|
}
|
|
})
|
|
|
|
for _, f := range rootMod.functions {
|
|
name := tokenToName(f.Token)
|
|
ti := PackageTreeItem{
|
|
Name: name,
|
|
Type: entryTypeFunction,
|
|
Link: getFunctionLink(name),
|
|
Children: nil,
|
|
}
|
|
|
|
packageTree = append(packageTree, ti)
|
|
}
|
|
sort.SliceStable(packageTree, func(i, j int) bool {
|
|
pti, ptj := packageTree[i], packageTree[j]
|
|
switch {
|
|
case pti.Type != ptj.Type:
|
|
return (pti.Type == entryTypeModule || pti.Type == entryTypeResource) &&
|
|
(ptj.Type != entryTypeModule && ptj.Type != entryTypeResource)
|
|
default:
|
|
return pti.Name < ptj.Name
|
|
}
|
|
})
|
|
return packageTree, nil
|
|
}
|