GitLabgitlab-org
cli
main
1package cmdutils
3import (
4 "fmt"
6 "github.com/spf13/cobra"
7 "github.com/spf13/pflag"
9 "gitlab.com/gitlab-org/cli/internal/iostreams"
10)
12// AddJQFlag registers the --jq flag on a command that emits JSON via
13// IOStreams.PrintJSON. The flag's value is parsed (and the resulting jq
14// query compiled) by cobra at parse time, via the IOStreams.JQFilter
15// pflag.Value attached to io.JQ.
16//
17// In PreRun, the helper verifies that the command's output flag (looked
18// up by name: --output first, then --output-format) is set to "json".
19// Commands without either output flag always emit JSON and skip this
20// check. The verification fails the command before RunE
21// runs, so non-JSON output is never produced when --jq is active.
22func AddJQFlag(cmd *cobra.Command, io *iostreams.IOStreams) {
23 if io.JQ == nil {
24 io.JQ = &iostreams.JQFilter{}
25 }
26 cmd.Flags().Var(io.JQ, "jq", "Filter JSON output with a jq expression.")
27 cobra.CheckErr(cmd.RegisterFlagCompletionFunc("jq", cobra.NoFileCompletions))
29 origPreRunE := cmd.PreRunE
30 origPreRun := cmd.PreRun
31 cmd.PreRun = nil
32 cmd.PreRunE = func(c *cobra.Command, args []string) error {
33 if io.JQ.IsActive() {
34 if outFlag := lookupOutputFlag(c); outFlag != nil && outFlag.Value.String() != "json" {
35 return &FlagError{Err: fmt.Errorf("using --jq requires --%s=json (got %q)", outFlag.Name, outFlag.Value.String())}
36 }
37 }
39 if origPreRunE != nil {
40 return origPreRunE(c, args)
41 }
42 if origPreRun != nil {
43 origPreRun(c, args)
44 }
45 return nil
46 }
47}
49func lookupOutputFlag(c *cobra.Command) *pflag.Flag {
50 if f := c.Flag("output"); f != nil {
51 return f
52 }
53 return c.Flag("output-format")
54}
Diagnostics6 git calls · 26 ms
CallStatusSizeTime026 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 KiB2 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=UPDATING git.response.duration_ms=2 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 · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=1 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
fetchtree:02001.2 KiB · hit1 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=20 git.response.bytes=1238 git.response.cache=HIT git.response.duration_ms=1 git.fetch.filter=tree:0 git.fetch.wants=c10f4b8b760c3fec7ed8ca85e428d5bc523f8e17 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=1238 git.pkt.payload.max=1211 git.sideband.band1.bytes=1211 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1211 git.pack.trailer=7373aa350f2a611db7d4116eb1450c92f18a27caOpen pack map
fetch200871 B · hit20 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=871 git.response.cache=HIT git.response.duration_ms=20 git.fetch.wants=11fa1ad8cd4b777fe606438f13aecd374f641b95 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=871 git.pkt.payload.max=844 git.sideband.band1.bytes=844 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
- a5e235e6fc1ba594
- Request
- dd0ccde7…
- 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