extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-25 01:44:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add automatic alias redirects for command pages

Browse Source
This commit is contained in:
albertony 2024-08-15 14:58:45 +02:00
parent aee2480fc4
commit 3e12612aae
1 changed files with 31 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
cmd/gendocs/gendocs.go
View File

@ -30,12 +30,19 @@ type frontmatter struct {
Title string Title string
Description string Description string
Source string Source string
Aliases []string
Annotations map[string]string Annotations map[string]string
} }
var frontmatterTemplate = template.Must(template.New("frontmatter").Parse(`--- var frontmatterTemplate = template.Must(template.New("frontmatter").Parse(`---
title: "{{ .Title }}" title: "{{ .Title }}"
description: "{{ .Description }}" description: "{{ .Description }}"
{{- if .Aliases }}
aliases:
{{- range $value := .Aliases }}
- {{ $value }}
{{- end }}
{{- end }}
{{- range $key, $value := .Annotations }} {{- range $key, $value := .Annotations }}
{{ $key }}: {{ $value }} {{ $key }}: {{ $value }}
{{- end }} {{- end }}
@ -82,23 +89,37 @@ rclone.org website.`,
// Look up name => details for prepender // Look up name => details for prepender
type commandDetails struct { type commandDetails struct {
Short string Short string
Aliases []string
Annotations map[string]string Annotations map[string]string
} }
var commands = map[string]commandDetails{} var commands = map[string]commandDetails{}
var aliases []string var addCommandDetails func(root *cobra.Command, parentAliases []string)
var addCommandDetails func(root *cobra.Command) addCommandDetails = func(root *cobra.Command, parentAliases []string) {
addCommandDetails = func(root *cobra.Command) {
name := strings.ReplaceAll(root.CommandPath(), " ", "_") + ".md" name := strings.ReplaceAll(root.CommandPath(), " ", "_") + ".md"
var aliases []string
for _, p := range parentAliases {
aliases = append(aliases, p+" "+root.Name())
for _, v := range root.Aliases {
aliases = append(aliases, p+" "+v)
}
}
for _, v := range root.Aliases {
if root.HasParent() {
aliases = append(aliases, root.Parent().CommandPath()+" "+v)
} else {
aliases = append(aliases, v)
}
}
commands[name] = commandDetails{ commands[name] = commandDetails{
Short: root.Short, Short: root.Short,
Aliases: aliases,
Annotations: root.Annotations, Annotations: root.Annotations,
} }
aliases = append(aliases, root.Aliases...)
for _, c := range root.Commands() { for _, c := range root.Commands() {
addCommandDetails(c) addCommandDetails(c, aliases)
} }
} }
addCommandDetails(cmd.Root) addCommandDetails(cmd.Root, []string{})
// markup for the docs files // markup for the docs files
prepender := func(filename string) string { prepender := func(filename string) string {
@ -109,8 +130,12 @@ rclone.org website.`,
Title: strings.ReplaceAll(base, "_", " "), Title: strings.ReplaceAll(base, "_", " "),
Description: commands[name].Short, Description: commands[name].Short,
Source: strings.ReplaceAll(strings.ReplaceAll(base, "rclone", "cmd"), "_", "/") + "/", Source: strings.ReplaceAll(strings.ReplaceAll(base, "rclone", "cmd"), "_", "/") + "/",
Aliases: []string{},
Annotations: map[string]string{}, Annotations: map[string]string{},
} }
for _, v := range commands[name].Aliases {
data.Aliases = append(data.Aliases, "/commands/"+strings.ReplaceAll(v, " ", "_")+"/")
}
// Filter out annotations that confuse hugo from the frontmatter // Filter out annotations that confuse hugo from the frontmatter
for k, v := range commands[name].Annotations { for k, v := range commands[name].Annotations {
if k != "groups" { if k != "groups" {
@ -145,12 +170,6 @@ rclone.org website.`,
name := filepath.Base(path) name := filepath.Base(path)
cmd, ok := commands[name] cmd, ok := commands[name]
if !ok { if !ok {
// Avoid man pages which are for aliases. This is a bit messy!
for _, alias := range aliases {
if strings.Contains(name, alias) {
return nil
}
}
return fmt.Errorf("didn't find command for %q", name) return fmt.Errorf("didn't find command for %q", name)
} }
b, err := os.ReadFile(path) b, err := os.ReadFile(path)