yq/cmd/evalute_sequence_command.go

157 lines
4.1 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
"os"
"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"},
Short: "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
# Read from STDIN
## use '-' as a filename to read 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 {
if prettyPrint && expression == "" {
return `... style=""`
} else if prettyPrint {
return fmt.Sprintf("%v | ... style= \"\"", expression)
}
return expression
}
2020-11-06 03:37:01 +00:00
func evaluateSequence(cmd *cobra.Command, args []string) error {
2020-11-30 05:35:21 +00:00
cmd.SilenceUsage = true
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
var err error
stat, _ := os.Stdin.Stat()
pipingStdIn := (stat.Mode() & os.ModeCharDevice) == 0
2020-11-13 02:19:54 +00:00
out := cmd.OutOrStdout()
fileInfo, _ := os.Stdout.Stat()
if forceColor || (!forceNoColor && (fileInfo.Mode()&os.ModeCharDevice) != 0) {
colorsEnabled = true
}
2020-11-30 05:05:07 +00:00
2021-02-10 06:06:16 +00:00
firstFileIndex := -1
if !nullInput && len(args) == 1 {
firstFileIndex = 0
} else if len(args) > 1 {
firstFileIndex = 1
}
if writeInplace && (firstFileIndex == -1) {
2020-11-30 05:05:07 +00:00
return fmt.Errorf("Write inplace flag only applicable when giving an expression and at least one file")
}
if writeInplace {
// only use colors if its forced
colorsEnabled = forceColor
2021-02-10 06:06:16 +00:00
writeInPlaceHandler := yqlib.NewWriteInPlaceHandler(args[firstFileIndex])
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() { writeInPlaceHandler.FinishWriteInPlace(completedSuccessfully) }()
}
2021-07-25 08:08:33 +00:00
// backwards compatibilty
if outputToJSON {
outputFormat = "json"
}
format, err := yqlib.OutputFormatFromString(outputFormat)
if err != nil {
return err
}
printer := yqlib.NewPrinter(out, format, unwrapScalar, colorsEnabled, indent, !noDocSeparators)
2020-11-13 02:19:54 +00:00
2020-11-22 00:56:28 +00:00
streamEvaluator := yqlib.NewStreamEvaluator()
if nullInput && len(args) > 1 {
return errors.New("Cannot pass files in when using null-input flag")
}
2021-07-18 02:28:46 +00:00
if frontMatter != "" {
frontMatterHandler := yqlib.NewFrontMatterHandler(args[firstFileIndex])
err = frontMatterHandler.Split()
if err != nil {
return err
}
args[firstFileIndex] = frontMatterHandler.GetYamlFrontMatterFilename()
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 pipingStdIn {
err = streamEvaluator.EvaluateFiles(processExpression(""), []string{"-"}, printer, leadingContentPreProcessing)
2020-11-06 03:37:01 +00:00
} else {
cmd.Println(cmd.UsageString())
return nil
}
case 1:
if nullInput {
2021-07-19 09:52:51 +00:00
err = streamEvaluator.EvaluateNew(processExpression(args[0]), printer, "")
2020-11-06 03:37:01 +00:00
} else {
err = streamEvaluator.EvaluateFiles(processExpression(""), []string{args[0]}, printer, leadingContentPreProcessing)
2020-11-06 03:37:01 +00:00
}
2020-11-13 02:19:54 +00:00
default:
err = streamEvaluator.EvaluateFiles(processExpression(args[0]), args[1:], printer, leadingContentPreProcessing)
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
}