1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
|
// Package cli implements the gojq command.
package cli
import (
"errors"
"fmt"
"io"
"os"
"path/filepath"
"runtime"
"strings"
"github.com/mattn/go-isatty"
"github.com/wader/gojq"
)
const name = "gojq"
const version = "0.12.13"
var revision = "HEAD"
const (
exitCodeOK = iota
exitCodeFalsyErr
exitCodeFlagParseErr
exitCodeCompileErr
exitCodeNoValueErr
exitCodeDefaultErr
)
type cli struct {
inStream io.Reader
outStream io.Writer
errStream io.Writer
outputRaw bool
outputRaw0 bool
outputJoin bool
outputCompact bool
outputIndent *int
outputTab bool
outputYAML bool
inputRaw bool
inputStream bool
inputYAML bool
inputSlurp bool
argnames []string
argvalues []any
outputYAMLSeparator bool
exitCodeError error
}
type flagopts struct {
OutputRaw bool `short:"r" long:"raw-output" description:"output raw strings"`
OutputRaw0 bool `long:"raw-output0" description:"implies -r with NUL character delimiter"`
OutputJoin bool `short:"j" long:"join-output" description:"implies -r with no newline delimiter"`
OutputCompact bool `short:"c" long:"compact-output" description:"output without pretty-printing"`
OutputIndent *int `long:"indent" description:"number of spaces for indentation"`
OutputTab bool `long:"tab" description:"use tabs for indentation"`
OutputYAML bool `long:"yaml-output" description:"output in YAML format"`
OutputColor bool `short:"C" long:"color-output" description:"output with colors even if piped"`
OutputMono bool `short:"M" long:"monochrome-output" description:"output without colors"`
InputNull bool `short:"n" long:"null-input" description:"use null as input value"`
InputRaw bool `short:"R" long:"raw-input" description:"read input as raw strings"`
InputStream bool `long:"stream" description:"parse input in stream fashion"`
InputYAML bool `long:"yaml-input" description:"read input as YAML format"`
InputSlurp bool `short:"s" long:"slurp" description:"read all inputs into an array"`
FromFile string `short:"f" long:"from-file" description:"load query from file"`
ModulePaths []string `short:"L" description:"directory to search modules from"`
Arg map[string]string `long:"arg" description:"set a string value to a variable"`
ArgJSON map[string]string `long:"argjson" description:"set a JSON value to a variable"`
SlurpFile map[string]string `long:"slurpfile" description:"set the JSON contents of a file to a variable"`
RawFile map[string]string `long:"rawfile" description:"set the contents of a file to a variable"`
Args []any `long:"args" positional:"" description:"consume remaining arguments as positional string values"`
JSONArgs []any `long:"jsonargs" positional:"" description:"consume remaining arguments as positional JSON values"`
ExitStatus bool `short:"e" long:"exit-status" description:"exit 1 when the last value is false or null"`
Version bool `short:"v" long:"version" description:"display version information"`
Help bool `short:"h" long:"help" description:"display this help information"`
}
var addDefaultModulePaths = true
func (cli *cli) run(args []string) int {
if err := cli.runInternal(args); err != nil {
cli.printError(err)
if err, ok := err.(interface{ ExitCode() int }); ok {
return err.ExitCode()
}
return exitCodeDefaultErr
}
return exitCodeOK
}
func (cli *cli) runInternal(args []string) (err error) {
var opts flagopts
args, err = parseFlags(args, &opts)
if err != nil {
return &flagParseError{err}
}
if opts.Help {
fmt.Fprintf(cli.outStream, `%[1]s - Go implementation of jq
Version: %s (rev: %s/%s)
Synopsis:
%% echo '{"foo": 128}' | %[1]s '.foo'
Usage:
%[1]s [OPTIONS]
`,
name, version, revision, runtime.Version())
fmt.Fprintln(cli.outStream, formatFlags(&opts))
return nil
}
if opts.Version {
fmt.Fprintf(cli.outStream, "%s %s (rev: %s/%s)\n", name, version, revision, runtime.Version())
return nil
}
cli.outputRaw, cli.outputRaw0, cli.outputJoin,
cli.outputCompact, cli.outputIndent, cli.outputTab, cli.outputYAML =
opts.OutputRaw, opts.OutputRaw0, opts.OutputJoin,
opts.OutputCompact, opts.OutputIndent, opts.OutputTab, opts.OutputYAML
defer func(x bool) { noColor = x }(noColor)
if opts.OutputColor || opts.OutputMono {
noColor = opts.OutputMono
} else if os.Getenv("NO_COLOR") != "" || os.Getenv("TERM") == "dumb" {
noColor = true
} else {
f, ok := cli.outStream.(interface{ Fd() uintptr })
noColor = !(ok && (isatty.IsTerminal(f.Fd()) || isatty.IsCygwinTerminal(f.Fd())))
}
if !noColor {
if colors := os.Getenv("GOJQ_COLORS"); colors != "" {
if err := setColors(colors); err != nil {
return err
}
}
}
if i := cli.outputIndent; i != nil {
if *i > 9 {
return fmt.Errorf("too many indentation count: %d", *i)
} else if *i < 0 {
return fmt.Errorf("negative indentation count: %d", *i)
}
}
if opts.OutputYAML && opts.OutputTab {
return errors.New("cannot use tabs for YAML output")
}
cli.inputRaw, cli.inputStream, cli.inputYAML, cli.inputSlurp =
opts.InputRaw, opts.InputStream, opts.InputYAML, opts.InputSlurp
for k, v := range opts.Arg {
cli.argnames = append(cli.argnames, "$"+k)
cli.argvalues = append(cli.argvalues, v)
}
for k, v := range opts.ArgJSON {
val, _ := newJSONInputIter(strings.NewReader(v), "$"+k).Next()
if err, ok := val.(error); ok {
return err
}
cli.argnames = append(cli.argnames, "$"+k)
cli.argvalues = append(cli.argvalues, val)
}
for k, v := range opts.SlurpFile {
val, err := slurpFile(v)
if err != nil {
return err
}
cli.argnames = append(cli.argnames, "$"+k)
cli.argvalues = append(cli.argvalues, val)
}
for k, v := range opts.RawFile {
val, err := os.ReadFile(v)
if err != nil {
return err
}
cli.argnames = append(cli.argnames, "$"+k)
cli.argvalues = append(cli.argvalues, string(val))
}
named := make(map[string]any, len(cli.argnames))
for i, name := range cli.argnames {
named[name[1:]] = cli.argvalues[i]
}
positional := opts.Args
for i, v := range opts.JSONArgs {
if v != nil {
val, _ := newJSONInputIter(strings.NewReader(v.(string)), "--jsonargs").Next()
if err, ok := val.(error); ok {
return err
}
if i < len(positional) {
positional[i] = val
} else {
positional = append(positional, val)
}
}
}
cli.argnames = append(cli.argnames, "$ARGS")
cli.argvalues = append(cli.argvalues, map[string]any{
"named": named,
"positional": positional,
})
var arg, fname string
if opts.FromFile != "" {
src, err := os.ReadFile(opts.FromFile)
if err != nil {
return err
}
arg, fname = string(src), opts.FromFile
} else if len(args) == 0 {
arg = "."
} else {
arg, fname = strings.TrimSpace(args[0]), "<arg>"
args = args[1:]
}
if opts.ExitStatus {
cli.exitCodeError = &exitCodeError{exitCodeNoValueErr}
defer func() {
if _, ok := err.(interface{ ExitCode() int }); !ok {
err = cli.exitCodeError
}
}()
}
query, err := gojq.Parse(arg)
if err != nil {
return &queryParseError{fname, arg, err}
}
modulePaths := opts.ModulePaths
if len(modulePaths) == 0 && addDefaultModulePaths {
modulePaths = listDefaultModulePaths()
}
iter := cli.createInputIter(args)
defer iter.Close()
code, err := gojq.Compile(query,
gojq.WithModuleLoader(gojq.NewModuleLoader(modulePaths)),
gojq.WithEnvironLoader(os.Environ),
gojq.WithVariables(cli.argnames),
gojq.WithFunction("debug", 0, 0, cli.funcDebug),
gojq.WithFunction("stderr", 0, 0, cli.funcStderr),
gojq.WithFunction("input_filename", 0, 0,
func(iter inputIter) func(any, []any) any {
return func(any, []any) any {
if fname := iter.Name(); fname != "" && (len(args) > 0 || !opts.InputNull) {
return fname
}
return nil
}
}(iter),
),
gojq.WithInputIter(iter),
)
if err != nil {
if err, ok := err.(interface {
QueryParseError() (string, string, error)
}); ok {
name, query, err := err.QueryParseError()
return &queryParseError{name, query, err}
}
if err, ok := err.(interface {
JSONParseError() (string, string, error)
}); ok {
fname, contents, err := err.JSONParseError()
return &compileError{&jsonParseError{fname, contents, 0, err}}
}
return &compileError{err}
}
if opts.InputNull {
iter = newNullInputIter()
}
return cli.process(iter, code)
}
func listDefaultModulePaths() []string {
modulePaths := []string{"", "../lib/gojq", "../lib"}
if executable, err := os.Executable(); err == nil {
if executable, err := filepath.EvalSymlinks(executable); err == nil {
origin := filepath.Dir(executable)
modulePaths[1] = filepath.Join(origin, modulePaths[1])
modulePaths[2] = filepath.Join(origin, modulePaths[2])
}
}
if homeDir, err := os.UserHomeDir(); err == nil {
modulePaths[0] = filepath.Join(homeDir, ".jq")
} else {
modulePaths = modulePaths[1:]
}
return modulePaths
}
func slurpFile(name string) (any, error) {
iter := newSlurpInputIter(
newFilesInputIter(newJSONInputIter, []string{name}, nil),
)
defer iter.Close()
val, _ := iter.Next()
if err, ok := val.(error); ok {
return nil, err
}
return val, nil
}
func (cli *cli) createInputIter(args []string) (iter inputIter) {
var newIter func(io.Reader, string) inputIter
switch {
case cli.inputRaw:
if cli.inputSlurp {
newIter = newReadAllIter
} else {
newIter = newRawInputIter
}
case cli.inputStream:
newIter = newStreamInputIter
case cli.inputYAML:
newIter = newYAMLInputIter
default:
newIter = newJSONInputIter
}
if cli.inputSlurp {
defer func() {
if cli.inputRaw {
iter = newSlurpRawInputIter(iter)
} else {
iter = newSlurpInputIter(iter)
}
}()
}
if len(args) == 0 {
return newIter(cli.inStream, "<stdin>")
}
return newFilesInputIter(newIter, args, cli.inStream)
}
func (cli *cli) process(iter inputIter, code *gojq.Code) error {
var err error
for {
v, ok := iter.Next()
if !ok {
return err
}
if er, ok := v.(error); ok {
cli.printError(er)
err = &emptyError{er}
continue
}
if er := cli.printValues(code.Run(v, cli.argvalues...)); er != nil {
cli.printError(er)
err = &emptyError{er}
}
}
}
func (cli *cli) printValues(iter gojq.Iter) error {
m := cli.createMarshaler()
for {
v, ok := iter.Next()
if !ok {
break
}
if err, ok := v.(error); ok {
return err
}
if cli.outputYAMLSeparator {
cli.outStream.Write([]byte("---\n"))
} else {
cli.outputYAMLSeparator = cli.outputYAML
}
if err := m.marshal(v, cli.outStream); err != nil {
return err
}
if cli.exitCodeError != nil {
if v == nil || v == false {
cli.exitCodeError = &exitCodeError{exitCodeFalsyErr}
} else {
cli.exitCodeError = &exitCodeError{exitCodeOK}
}
}
if !cli.outputYAML {
if cli.outputRaw0 {
cli.outStream.Write([]byte{'\x00'})
} else if !cli.outputJoin {
cli.outStream.Write([]byte{'\n'})
}
}
}
return nil
}
func (cli *cli) createMarshaler() marshaler {
if cli.outputYAML {
return yamlFormatter(cli.outputIndent)
}
indent := 2
if cli.outputCompact {
indent = 0
} else if cli.outputTab {
indent = 1
} else if i := cli.outputIndent; i != nil {
indent = *i
}
f := newEncoder(cli.outputTab, indent)
if cli.outputRaw || cli.outputRaw0 || cli.outputJoin {
return &rawMarshaler{f, cli.outputRaw0}
}
return f
}
func (cli *cli) funcDebug(v any, _ []any) any {
if err := newEncoder(false, 0).
marshal([]any{"DEBUG:", v}, cli.errStream); err != nil {
return err
}
if _, err := cli.errStream.Write([]byte{'\n'}); err != nil {
return err
}
return v
}
func (cli *cli) funcStderr(v any, _ []any) any {
if err := (&rawMarshaler{m: newEncoder(false, 0)}).
marshal(v, cli.errStream); err != nil {
return err
}
return v
}
func (cli *cli) printError(err error) {
if er, ok := err.(interface{ IsEmptyError() bool }); !ok || !er.IsEmptyError() {
if er, ok := err.(interface{ IsHaltError() bool }); !ok || !er.IsHaltError() {
fmt.Fprintf(cli.errStream, "%s: %s\n", name, err)
} else if er, ok := err.(gojq.ValueError); ok {
v := er.Value()
if str, ok := v.(string); ok {
cli.errStream.Write([]byte(str))
} else {
bs, _ := gojq.Marshal(v)
cli.errStream.Write(bs)
cli.errStream.Write([]byte{'\n'})
}
}
}
}
|