GitLabgitlab-org
cli
main
1package help
3import (
4 "fmt"
5 "io"
6 "strings"
8 "github.com/spf13/cobra"
10 "gitlab.com/gitlab-org/cli/internal/iostreams"
11 "gitlab.com/gitlab-org/cli/internal/utils"
12)
14// Section is a titled block of command help that comes from an annotation.
15type Section struct {
16 Title string
17 Body string
18}
20var helpAnnotations = []struct{ key, title string }{
21 {"help:arguments", "Arguments"},
22 {"help:environment", "Environment variables"},
23}
25// AnnotationSections returns the help:arguments and help:environment sections
26// of command, in display order. Annotations are not inherited, so a subcommand
27// does not repeat its parent's sections.
28func AnnotationSections(command *cobra.Command) []Section {
29 var sections []Section
30 for _, s := range helpAnnotations {
31 if body := strings.Trim(command.Annotations[s.key], "\r\n"); body != "" {
32 sections = append(sections, Section{Title: s.title, Body: body})
33 }
34 }
35 return sections
36}
38// AppendAnnotationSections makes help for every command under root end with
39// the command's annotation sections. fang.Execute replaces root's help func
40// with fang's renderer, which ignores annotations, so the wrapper goes on
41// root's direct children and every deeper command inherits it. Call it once
42// the command tree is complete, before fang.Execute. A command that sets its
43// own help func keeps the sections by calling its parent's help func.
44//
45// The wrapper replaces any help func already set on a direct child of root, so
46// those children must not set one; TestTopLevelCommandsInheritRootHelpFunc in
47// internal/commands enforces this. The sections are written to the command's
48// OutOrStdout, where fang writes the help body, and streams only picks colors.
49func AppendAnnotationSections(root *cobra.Command, streams *iostreams.IOStreams) {
50 for _, child := range root.Commands() {
51 child.SetHelpFunc(func(c *cobra.Command, args []string) {
52 c.Root().HelpFunc()(c, args)
53 writeAnnotationSections(c.OutOrStdout(), streams.Color(), c)
54 })
55 }
56}
58const (
59 fangTitleIndent = " "
60 fangBodyIndent = " "
61)
63func writeAnnotationSections(w io.Writer, color *iostreams.ColorPalette, command *cobra.Command) {
64 for _, s := range AnnotationSections(command) {
65 fmt.Fprintln(w, fangTitleIndent+color.Bold(strings.ToUpper(s.Title))) //nolint:forbidigo // w is the command's own writer, where fang writes the help body
66 fmt.Fprintln(w) //nolint:forbidigo // w is the command's own writer, where fang writes the help body
67 fmt.Fprintln(w, utils.Indent(s.Body, fangBodyIndent)) //nolint:forbidigo // w is the command's own writer, where fang writes the help body
68 fmt.Fprintln(w) //nolint:forbidigo // w is the command's own writer, where fang writes the help body
69 }
70}
Diagnostics7 git calls · 312 ms
CallStatusSizeTime0312 ms
discover200185 B4 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=185 git.server.agent=git/2.56.g1891de4-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=185 git.pkt.payload.max=35
ls-refs20058 KiB3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=59849 git.response.cache=UPDATING git.response.duration_ms=3 git.protocol.version=2 git.pkt.frames=731 git.pkt.data=730 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=59849 git.pkt.payload.max=143 git.ls_refs.count=730 git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=combine:blob:none+tree:2 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=1 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4273 git.pkt.payload.max=4173 git.sideband.band1.bytes=4173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=11 git.pack.bytes=4173 git.fetch.wide.objects=11 git.fetch.wide.extra_bytes=3930 git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=22 git.pkt.data=20 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=32926 git.pkt.payload.max=32046 git.sideband.band1.bytes=32046 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=80 git.pack.bytes=32046 git.pack.ofs_delta=36 git.pack.ref_delta=0 git.pack.chain.max=2 git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91 git.pack.full=44Open pack map
fetchtree:02001.8 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1857 git.pkt.payload.max=1830 git.sideband.band1.bytes=1830 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1830 git.pack.trailer=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200172 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=300 git.response.bytes=172 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=9cf14981aa55bb2b8bcfc2f2549219dc92956502 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=172 git.pkt.payload.max=145 git.sideband.band1.bytes=145 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=145 git.pack.trailer=aa21db2332923792c8da6536bfb011ad61d33c6cOpen pack map
fetch2001.1 KiB300 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1135 git.response.cache=MISS git.response.duration_ms=300 git.fetch.wants=7fa0312f1da2881ec08122a7df6b76947b0a3fac git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1135 git.pkt.payload.max=1108 git.sideband.band1.bytes=1108 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://gitlab.com/gitlab-org/cli
- Ref
- refs/heads/main
- Commit
- 0dd7574dce9e385c5c30540e6c15657adc6bdce9
- cf-ray
- a5e24147cc7dcf56
- Request
- 1deca58c…
- Protocol
- v2 · sha1
- Agent
- git/2.56.g1891de4-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format