GitLabgitlab-org
cli
main
1package confighelp
3import (
4 "fmt"
5 "regexp"
6 "slices"
7 "strings"
9 "github.com/spf13/cobra"
11 "gitlab.com/gitlab-org/cli/internal/config"
12)
14// Settings renders the documented config keys as a Markdown bullet list for
15// the `glab config` synopsis.
16func Settings() string {
17 var lines []string
18 for _, kd := range config.KeySchema {
19 if !kd.UserSettable || kd.HelpHidden {
20 continue
21 }
22 lines = append(lines, fmt.Sprintf("- %#q: %s", kd.Name, describe(kd)))
23 }
24 slices.Sort(lines)
25 return strings.Join(lines, "\n")
26}
28// KeyCompletions provides shell completions for config keys.
29func KeyCompletions(setting bool) []cobra.Completion {
30 completions := make([]cobra.Completion, 0, len(config.KeySchema)*2)
31 for _, kd := range config.KeySchema {
32 if kd.UserSettable && !kd.HelpHidden {
33 completions = append(completions, cobra.CompletionWithDesc(kd.Name, flatten(kd.Description)))
34 }
35 if !setting {
36 for _, alias := range kd.Aliases {
37 completions = append(completions, cobra.CompletionWithDesc(alias, fmt.Sprintf("Alias for '%s'.", kd.Name)))
38 }
39 }
40 }
41 return completions
42}
44// ValueCompletions provides shell completions for config values.
45func ValueCompletions(key string) ([]cobra.Completion, cobra.ShellCompDirective) {
46 key = config.ConfigKeyEquivalence(key) // aliases like prompt_disabled complete too
47 for _, kd := range config.KeySchema {
48 if kd.Name != key || !kd.UserSettable {
49 continue
50 }
51 if kd.Type == config.TypeBool {
52 return []cobra.Completion{"true", "false"}, cobra.ShellCompDirectiveNoFileComp
53 }
54 switch kd.Name {
55 case "ca_cert", "client_cert":
56 return []string{"pem", "crt", "cer", "cert"}, cobra.ShellCompDirectiveFilterFileExt
57 case "client_key":
58 return []cobra.Completion{"pem", "key"}, cobra.ShellCompDirectiveFilterFileExt
59 case "glamour_style":
60 return kd.Values, cobra.ShellCompDirectiveDefault
61 }
62 return kd.Values, cobra.ShellCompDirectiveNoFileComp
63 }
64 return nil, cobra.ShellCompDirectiveNoFileComp
65}
67// quotedLiteral matches a 'single-quoted' span, the convention KeyDef
68// descriptions use because they are also rendered as YAML comments. The
69// leading and trailing delimiters keep possessive apostrophes out.
70var quotedLiteral = regexp.MustCompile(`(^|[\s(])'([^']+?)'([\s.,;:)]|$)`)
72func backtickLiterals(s string) string {
73 return quotedLiteral.ReplaceAllString(s, "${1}`${2}`${3}")
74}
76func describe(kd config.KeyDef) string {
77 desc := tidy(kd.Description)
78 if len(kd.Aliases) > 0 {
79 quoted := make([]string, 0, len(kd.Aliases))
80 for _, a := range kd.Aliases {
81 quoted = append(quoted, "`"+a+"`")
82 }
83 desc += " Also accepted as: " + strings.Join(quoted, ", ") + "."
84 }
85 if kd.Scope == config.ScopePerHost {
86 desc += " Scoped per host; set it with `--host`."
87 }
88 if envVars := config.EnvVarsForKey(kd); len(envVars) > 0 {
89 desc += " " + envVarSentence(envVars)
90 }
91 return desc
92}
94// tidy renders a schema description as a single Markdown sentence.
95func tidy(desc string) string {
96 out := backtickLiterals(flatten(desc))
97 if !strings.HasSuffix(out, ".") {
98 out += "."
99 }
100 return out
101}
103// EnvVarsByGroup returns the environment variable reference, grouped, with
104// each description flattened onto one line and its quoted literals marked up
105// as code.
106func EnvVarsByGroup() []config.EnvVarSection {
107 out := slices.Clone(config.EnvVarsByGroup())
108 for i := range out {
109 out[i].Vars = slices.Clone(out[i].Vars)
110 for j := range out[i].Vars {
111 out[i].Vars[j].Description = tidy(out[i].Vars[j].Description)
112 }
113 }
114 return out
115}
117// EnvironmentHelp renders the environment variable reference as the plain
118// "NAME: description" blocks the help:environment annotation uses.
119func EnvironmentHelp() string {
120 var b strings.Builder
121 for i, ev := range config.EnvVars() {
122 if i > 0 {
123 b.WriteString("\n\n")
124 }
125 fmt.Fprintf(&b, "%s: %s", ev.Name, flatten(ev.Description))
126 }
127 return b.String()
128}
130func envVarSentence(envVars []string) string {
131 quoted := make([]string, 0, len(envVars))
132 for _, v := range envVars {
133 quoted = append(quoted, "`"+v+"`")
134 }
135 if len(quoted) == 1 {
136 return "Environment variable: " + quoted[0] + "."
137 }
138 return "Environment variables, first one set wins: " + strings.Join(quoted, ", ") + "."
139}
141// flatten collapses a KeyDef description onto one line, dropping any trailing
142// indented example block so it renders as a single bullet.
143func flatten(desc string) string {
144 var out []string
145 for line := range strings.SplitSeq(desc, "\n") {
146 if strings.HasPrefix(line, "- ") || strings.HasPrefix(line, " ") {
147 break
148 }
149 if t := strings.TrimSpace(line); t != "" {
150 out = append(out, t)
151 }
152 }
153 return strings.Join(out, " ")
154}
Diagnostics7 git calls · 302 ms
CallStatusSizeTime0302 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 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 KiB · hit3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=59849 git.response.cache=HIT 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
fetchtree:0 · deepen 1020032 KiB · hit2 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=2 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
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit3 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=3 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:02001.4 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=1391 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=e9da9edfdcf44933ee5fa121d411de326220161c 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=1391 git.pkt.payload.max=1364 git.sideband.band1.bytes=1364 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1364 git.pack.trailer=bf750bd385ed98d15e1fea1289d3b00caa61d64cOpen pack map
fetchtree:0200173 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=290 git.response.bytes=173 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=f860011cdd6fe8a88a9cc6792ffc502d0b6ca9fe 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=173 git.pkt.payload.max=146 git.sideband.band1.bytes=146 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=146 git.pack.trailer=d7f67c360ca68279160946809fffa2e4e79af9a2Open pack map
fetch2001.8 KiB290 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1826 git.response.cache=MISS git.response.duration_ms=290 git.fetch.wants=8e9036bd89443404d5fdf3a0feeabf849405a454 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=1826 git.pkt.payload.max=1799 git.sideband.band1.bytes=1799 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
- a5e28ac04f07bd4a
- Request
- 305b83a3…
- 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