mirror of
https://github.com/go-gitea/gitea
synced 2024-11-05 10:17:07 +01:00
d0dbe52e76
Replace #10912 And there are many new tests to cover the CLI behavior There were some concerns about the "option order in hook scripts" (https://github.com/go-gitea/gitea/pull/10912#issuecomment-1137543314), it's not a problem now. Because the hook script uses `/gitea hook --config=/app.ini pre-receive` format. The "config" is a global option, it can appear anywhere. ---- ## ⚠️ BREAKING ⚠️ This PR does it best to avoid breaking anything. The major changes are: * `gitea` itself won't accept web's options: `--install-port` / `--pid` / `--port` / `--quiet` / `--verbose` .... They are `web` sub-command's options. * Use `./gitea web --pid ....` instead * `./gitea` can still run the `web` sub-command as shorthand, with default options * The sub-command's options must follow the sub-command * Before: `./gitea --sub-opt subcmd` might equal to `./gitea subcmd --sub-opt` (well, might not ...) * After: only `./gitea subcmd --sub-opt` could be used * The global options like `--config` are not affected
66 lines
1.4 KiB
Go
66 lines
1.4 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
// CmdDocs represents the available docs sub-command.
|
|
var CmdDocs = &cli.Command{
|
|
Name: "docs",
|
|
Usage: "Output CLI documentation",
|
|
Description: "A command to output Gitea's CLI documentation, optionally to a file.",
|
|
Action: runDocs,
|
|
Flags: []cli.Flag{
|
|
&cli.BoolFlag{
|
|
Name: "man",
|
|
Usage: "Output man pages instead",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "output",
|
|
Aliases: []string{"o"},
|
|
Usage: "Path to output to instead of stdout (will overwrite if exists)",
|
|
},
|
|
},
|
|
}
|
|
|
|
func runDocs(ctx *cli.Context) error {
|
|
docs, err := ctx.App.ToMarkdown()
|
|
if ctx.Bool("man") {
|
|
docs, err = ctx.App.ToMan()
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if !ctx.Bool("man") {
|
|
// Clean up markdown. The following bug was fixed in v2, but is present in v1.
|
|
// It affects markdown output (even though the issue is referring to man pages)
|
|
// https://github.com/urfave/cli/issues/1040
|
|
firstHashtagIndex := strings.Index(docs, "#")
|
|
|
|
if firstHashtagIndex > 0 {
|
|
docs = docs[firstHashtagIndex:]
|
|
}
|
|
}
|
|
|
|
out := os.Stdout
|
|
if ctx.String("output") != "" {
|
|
fi, err := os.Create(ctx.String("output"))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer fi.Close()
|
|
out = fi
|
|
}
|
|
|
|
_, err = fmt.Fprintln(out, docs)
|
|
return err
|
|
}
|