yq/cmd/evalute_sequence_command.go

145 lines
3.5 KiB
Go
Raw Normal View History

2020-11-06 03:37:01 +00:00
package cmd
import (
2020-11-30 05:35:21 +00:00
"errors"
2020-11-30 05:05:07 +00:00
"fmt"
2020-11-06 03:37:01 +00:00
"github.com/mikefarah/yq/v4/pkg/yqlib"
"github.com/spf13/cobra"
)
func createEvaluateSequenceCommand() *cobra.Command {
var cmdEvalSequence = &cobra.Command{
2020-11-13 03:07:11 +00:00
Use: "eval [expression] [yaml_file1]...",
Aliases: []string{"e"},
2022-01-27 01:07:41 +00:00
Short: "(default) Apply the expression to each document in each yaml file in sequence",
2020-11-06 03:37:01 +00:00
Example: `
# Reads field under the given path for each file
yq e '.a.b' f1.yml f2.yml
2020-12-01 05:16:20 +00:00
# Prints out the file
2020-12-01 05:16:20 +00:00
yq e sample.yaml
2021-09-19 23:57:41 +00:00
# Pipe from STDIN
## use '-' as a filename to pipe from STDIN
2021-04-19 00:26:58 +00:00
cat file2.yml | yq e '.a.b' file1.yml - file3.yml
# Creates a new yaml document
## Note that editing an empty file does not work.
2020-12-01 05:16:20 +00:00
yq e -n '.a.b.c = "cat"'
# Update a file inplace
2020-12-01 05:16:20 +00:00
yq e '.a.b = "cool"' -i file.yaml
2020-11-06 03:37:01 +00:00
`,
Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/)
See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.
## Evaluate Sequence ##
This command iterates over each yaml document from each given file, applies the
expression and prints the result in sequence.`,
2020-11-06 03:37:01 +00:00
RunE: evaluateSequence,
}
return cmdEvalSequence
}
2020-12-28 00:40:41 +00:00
func processExpression(expression string) string {
2020-12-28 00:40:41 +00:00
if prettyPrint && expression == "" {
return yqlib.PrettyPrintExp
2020-12-28 00:40:41 +00:00
} else if prettyPrint {
return fmt.Sprintf("%v | %v", expression, yqlib.PrettyPrintExp)
2020-12-28 00:40:41 +00:00
}
return expression
}
func evaluateSequence(cmd *cobra.Command, args []string) (cmdError error) {
2020-11-06 03:37:01 +00:00
// 0 args, read std in
// 1 arg, null input, process expression
// 1 arg, read file in sequence
// 2+ args, [0] = expression, file the rest
out := cmd.OutOrStdout()
2020-11-06 03:37:01 +00:00
var err error
expression, args, err := initCommand(cmd, args)
2021-10-30 02:04:05 +00:00
if err != nil {
return err
}
2020-11-30 05:05:07 +00:00
if writeInplace {
// only use colors if its forced
colorsEnabled = forceColor
writeInPlaceHandler := yqlib.NewWriteInPlaceHandler(args[0])
2020-11-30 05:05:07 +00:00
out, err = writeInPlaceHandler.CreateTempFile()
if err != nil {
return err
}
// need to indirectly call the function so that completedSuccessfully is
// passed when we finish execution as opposed to now
defer func() {
if cmdError == nil {
cmdError = writeInPlaceHandler.FinishWriteInPlace(completedSuccessfully)
}
}()
2020-11-30 05:05:07 +00:00
}
2021-07-25 08:08:33 +00:00
format, err := yqlib.OutputFormatFromString(outputFormat)
if err != nil {
return err
}
printerWriter, err := configurePrinterWriter(format, out)
if err != nil {
return err
}
encoder, err := configureEncoder()
if err != nil {
return err
}
2021-10-29 03:14:39 +00:00
printer := yqlib.NewPrinter(encoder, printerWriter)
2020-11-13 02:19:54 +00:00
decoder, err := configureDecoder(false)
2021-12-21 04:02:07 +00:00
if err != nil {
return err
}
2020-11-22 00:56:28 +00:00
streamEvaluator := yqlib.NewStreamEvaluator()
2021-07-18 02:28:46 +00:00
if frontMatter != "" {
yqlib.GetLogger().Debug("using front matter handler")
frontMatterHandler := yqlib.NewFrontMatterHandler(args[0])
2021-07-18 02:28:46 +00:00
err = frontMatterHandler.Split()
if err != nil {
return err
}
args[0] = frontMatterHandler.GetYamlFrontMatterFilename()
2021-07-18 02:28:46 +00:00
if frontMatter == "process" {
2021-07-20 00:38:42 +00:00
reader := frontMatterHandler.GetContentReader()
2021-07-18 02:28:46 +00:00
printer.SetAppendix(reader)
defer yqlib.SafelyCloseReader(reader)
}
defer frontMatterHandler.CleanUp()
}
2020-11-06 03:37:01 +00:00
switch len(args) {
case 0:
if nullInput {
err = streamEvaluator.EvaluateNew(processExpression(expression), printer)
2020-11-06 03:37:01 +00:00
} else {
cmd.Println(cmd.UsageString())
return nil
2020-11-06 03:37:01 +00:00
}
2020-11-13 02:19:54 +00:00
default:
err = streamEvaluator.EvaluateFiles(processExpression(expression), args, printer, decoder)
2020-11-06 03:37:01 +00:00
}
2020-11-30 05:05:07 +00:00
completedSuccessfully = err == nil
2020-11-30 05:35:21 +00:00
if err == nil && exitStatus && !printer.PrintedAnything() {
return errors.New("no matches found")
}
2020-11-13 02:19:54 +00:00
return err
2020-11-06 03:37:01 +00:00
}