mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-05 18:12:46 +00:00
fc3741365c
* Add Swagger spec test script * Fix Swagger spec errors not related to statuses with polls * Add API tests that post a status with a poll * Fix creating a status with a poll from form params * Fix Swagger spec errors related to statuses with polls (this is the last error) * Fix Swagger spec warnings not related to unused definitions * Suppress a duplicate list update params definition that was somehow causing wrong param names * Add Swagger test to CI - updates Drone config - vendorizes go-swagger - fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version * Put `Sample: ` on its own line everywhere * Remove unused id param from emojiCategoriesGet * Add 5 more pairs of profile fields to account update API Swagger * Remove Swagger prefix from dummy fields It makes the generated code look weird * Manually annotate params for statusCreate operation * Fix all remaining Swagger spec warnings - Change some models into operation parameters - Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields) * Documented that creating a status with scheduled_at isn't implemented yet * sign drone.yml * Fix filter API Swagger errors * fixup! Fix filter API Swagger errors --------- Co-authored-by: tobi <tobi.smethurst@protonmail.com>
224 lines
5.2 KiB
Go
224 lines
5.2 KiB
Go
package flags
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"runtime"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
func manQuoteLines(s string) string {
|
|
lines := strings.Split(s, "\n")
|
|
parts := []string{}
|
|
|
|
for _, line := range lines {
|
|
parts = append(parts, manQuote(line))
|
|
}
|
|
|
|
return strings.Join(parts, "\n")
|
|
}
|
|
|
|
func manQuote(s string) string {
|
|
return strings.Replace(s, "\\", "\\\\", -1)
|
|
}
|
|
|
|
func formatForMan(wr io.Writer, s string, quoter func(s string) string) {
|
|
for {
|
|
idx := strings.IndexRune(s, '`')
|
|
|
|
if idx < 0 {
|
|
fmt.Fprintf(wr, "%s", quoter(s))
|
|
break
|
|
}
|
|
|
|
fmt.Fprintf(wr, "%s", quoter(s[:idx]))
|
|
|
|
s = s[idx+1:]
|
|
idx = strings.IndexRune(s, '\'')
|
|
|
|
if idx < 0 {
|
|
fmt.Fprintf(wr, "%s", quoter(s))
|
|
break
|
|
}
|
|
|
|
fmt.Fprintf(wr, "\\fB%s\\fP", quoter(s[:idx]))
|
|
s = s[idx+1:]
|
|
}
|
|
}
|
|
|
|
func writeManPageOptions(wr io.Writer, grp *Group) {
|
|
grp.eachGroup(func(group *Group) {
|
|
if !group.showInHelp() {
|
|
return
|
|
}
|
|
|
|
// If the parent (grp) has any subgroups, display their descriptions as
|
|
// subsection headers similar to the output of --help.
|
|
if group.ShortDescription != "" && len(grp.groups) > 0 {
|
|
fmt.Fprintf(wr, ".SS %s\n", group.ShortDescription)
|
|
|
|
if group.LongDescription != "" {
|
|
formatForMan(wr, group.LongDescription, manQuoteLines)
|
|
fmt.Fprintln(wr, "")
|
|
}
|
|
}
|
|
|
|
for _, opt := range group.options {
|
|
if !opt.showInHelp() {
|
|
continue
|
|
}
|
|
|
|
fmt.Fprintln(wr, ".TP")
|
|
fmt.Fprintf(wr, "\\fB")
|
|
|
|
if opt.ShortName != 0 {
|
|
fmt.Fprintf(wr, "\\fB\\-%c\\fR", opt.ShortName)
|
|
}
|
|
|
|
if len(opt.LongName) != 0 {
|
|
if opt.ShortName != 0 {
|
|
fmt.Fprintf(wr, ", ")
|
|
}
|
|
|
|
fmt.Fprintf(wr, "\\fB\\-\\-%s\\fR", manQuote(opt.LongNameWithNamespace()))
|
|
}
|
|
|
|
if len(opt.ValueName) != 0 || opt.OptionalArgument {
|
|
if opt.OptionalArgument {
|
|
fmt.Fprintf(wr, " [\\fI%s=%s\\fR]", manQuote(opt.ValueName), manQuote(strings.Join(quoteV(opt.OptionalValue), ", ")))
|
|
} else {
|
|
fmt.Fprintf(wr, " \\fI%s\\fR", manQuote(opt.ValueName))
|
|
}
|
|
}
|
|
|
|
if len(opt.Default) != 0 {
|
|
fmt.Fprintf(wr, " <default: \\fI%s\\fR>", manQuote(strings.Join(quoteV(opt.Default), ", ")))
|
|
} else if len(opt.EnvKeyWithNamespace()) != 0 {
|
|
if runtime.GOOS == "windows" {
|
|
fmt.Fprintf(wr, " <default: \\fI%%%s%%\\fR>", manQuote(opt.EnvKeyWithNamespace()))
|
|
} else {
|
|
fmt.Fprintf(wr, " <default: \\fI$%s\\fR>", manQuote(opt.EnvKeyWithNamespace()))
|
|
}
|
|
}
|
|
|
|
if opt.Required {
|
|
fmt.Fprintf(wr, " (\\fIrequired\\fR)")
|
|
}
|
|
|
|
fmt.Fprintln(wr, "\\fP")
|
|
|
|
if len(opt.Description) != 0 {
|
|
formatForMan(wr, opt.Description, manQuoteLines)
|
|
fmt.Fprintln(wr, "")
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
func writeManPageSubcommands(wr io.Writer, name string, usagePrefix string, root *Command) {
|
|
commands := root.sortedVisibleCommands()
|
|
|
|
for _, c := range commands {
|
|
var nn string
|
|
|
|
if c.Hidden {
|
|
continue
|
|
}
|
|
|
|
if len(name) != 0 {
|
|
nn = name + " " + c.Name
|
|
} else {
|
|
nn = c.Name
|
|
}
|
|
|
|
writeManPageCommand(wr, nn, usagePrefix, c)
|
|
}
|
|
}
|
|
|
|
func writeManPageCommand(wr io.Writer, name string, usagePrefix string, command *Command) {
|
|
fmt.Fprintf(wr, ".SS %s\n", name)
|
|
fmt.Fprintln(wr, command.ShortDescription)
|
|
|
|
if len(command.LongDescription) > 0 {
|
|
fmt.Fprintln(wr, "")
|
|
|
|
cmdstart := fmt.Sprintf("The %s command", manQuote(command.Name))
|
|
|
|
if strings.HasPrefix(command.LongDescription, cmdstart) {
|
|
fmt.Fprintf(wr, "The \\fI%s\\fP command", manQuote(command.Name))
|
|
|
|
formatForMan(wr, command.LongDescription[len(cmdstart):], manQuoteLines)
|
|
fmt.Fprintln(wr, "")
|
|
} else {
|
|
formatForMan(wr, command.LongDescription, manQuoteLines)
|
|
fmt.Fprintln(wr, "")
|
|
}
|
|
}
|
|
|
|
var pre = usagePrefix + " " + command.Name
|
|
|
|
var usage string
|
|
if us, ok := command.data.(Usage); ok {
|
|
usage = us.Usage()
|
|
} else if command.hasHelpOptions() {
|
|
usage = fmt.Sprintf("[%s-OPTIONS]", command.Name)
|
|
}
|
|
|
|
var nextPrefix = pre
|
|
if len(usage) > 0 {
|
|
fmt.Fprintf(wr, "\n\\fBUsage\\fP: %s %s\n.TP\n", manQuote(pre), manQuote(usage))
|
|
nextPrefix = pre + " " + usage
|
|
}
|
|
|
|
if len(command.Aliases) > 0 {
|
|
fmt.Fprintf(wr, "\n\\fBAliases\\fP: %s\n\n", manQuote(strings.Join(command.Aliases, ", ")))
|
|
}
|
|
|
|
writeManPageOptions(wr, command.Group)
|
|
writeManPageSubcommands(wr, name, nextPrefix, command)
|
|
}
|
|
|
|
// WriteManPage writes a basic man page in groff format to the specified
|
|
// writer.
|
|
func (p *Parser) WriteManPage(wr io.Writer) {
|
|
t := time.Now()
|
|
source_date_epoch := os.Getenv("SOURCE_DATE_EPOCH")
|
|
if source_date_epoch != "" {
|
|
sde, err := strconv.ParseInt(source_date_epoch, 10, 64)
|
|
if err != nil {
|
|
panic(fmt.Sprintf("Invalid SOURCE_DATE_EPOCH: %s", err))
|
|
}
|
|
t = time.Unix(sde, 0)
|
|
}
|
|
|
|
fmt.Fprintf(wr, ".TH %s 1 \"%s\"\n", manQuote(p.Name), t.Format("2 January 2006"))
|
|
fmt.Fprintln(wr, ".SH NAME")
|
|
fmt.Fprintf(wr, "%s \\- %s\n", manQuote(p.Name), manQuoteLines(p.ShortDescription))
|
|
fmt.Fprintln(wr, ".SH SYNOPSIS")
|
|
|
|
usage := p.Usage
|
|
|
|
if len(usage) == 0 {
|
|
usage = "[OPTIONS]"
|
|
}
|
|
|
|
fmt.Fprintf(wr, "\\fB%s\\fP %s\n", manQuote(p.Name), manQuote(usage))
|
|
fmt.Fprintln(wr, ".SH DESCRIPTION")
|
|
|
|
formatForMan(wr, p.LongDescription, manQuoteLines)
|
|
fmt.Fprintln(wr, "")
|
|
|
|
fmt.Fprintln(wr, ".SH OPTIONS")
|
|
|
|
writeManPageOptions(wr, p.Command.Group)
|
|
|
|
if len(p.visibleCommands()) > 0 {
|
|
fmt.Fprintln(wr, ".SH COMMANDS")
|
|
|
|
writeManPageSubcommands(wr, "", p.Name+" "+usage, p.Command)
|
|
}
|
|
}
|