mirror of
https://github.com/mikefarah/yq.git
synced 2026-07-03 02:51:40 +00:00
Compare commits
7 Commits
fbf92beaf5
...
1edfc409ea
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1edfc409ea | ||
|
|
e95bb7e472 | ||
|
|
2074319595 | ||
|
|
be992d8add | ||
|
|
637bb1fecd | ||
|
|
bc23b42789 | ||
|
|
249efaee46 |
@ -1,4 +1,4 @@
|
||||
FROM golang:1.26.4@sha256:11fd8f7f63db3b6fb198797042ba4c40a4a34dc83325d3328ca3bc4bb7726786 AS builder
|
||||
FROM golang:1.26.4@sha256:792443b89f65105abba56b9bd5e97f680a80074ac62fc844a584212f8c8102c3 AS builder
|
||||
|
||||
WORKDIR /go/src/mikefarah/yq
|
||||
|
||||
@ -10,7 +10,7 @@ RUN ./scripts/acceptance.sh
|
||||
|
||||
# Choose alpine as a base image to make this useful for CI, as many
|
||||
# CI tools expect an interactive shell inside the container
|
||||
FROM alpine:3@sha256:a2d49ea686c2adfe3c992e47dc3b5e7fa6e6b5055609400dc2acaeb241c829f4 AS production
|
||||
FROM alpine:3@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b AS production
|
||||
LABEL maintainer="Mike Farah <mikefarah@users.noreply.github.com>"
|
||||
|
||||
COPY --from=builder /go/src/mikefarah/yq/yq /usr/bin/yq
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
FROM golang:1.26.4@sha256:11fd8f7f63db3b6fb198797042ba4c40a4a34dc83325d3328ca3bc4bb7726786
|
||||
FROM golang:1.26.4@sha256:792443b89f65105abba56b9bd5e97f680a80074ac62fc844a584212f8c8102c3
|
||||
|
||||
COPY scripts/devtools.sh /opt/devtools.sh
|
||||
|
||||
|
||||
@ -433,6 +433,7 @@ Flags:
|
||||
--shell-key-separator string separator for shell variable key paths (default "_")
|
||||
-s, --split-exp string print each result (or doc) into a file named (exp). [exp] argument must return a string. You can use $index in the expression as the result counter. The necessary directories will be created.
|
||||
--split-exp-file string Use a file to specify the split-exp expression.
|
||||
--split-exp-no-overwrite When using --split-exp, fail if a target file already exists instead of overwriting it.
|
||||
--string-interpolation Toggles strings interpolation of \(exp) (default true)
|
||||
--tsv-auto-parse parse TSV YAML/JSON values (default true)
|
||||
-r, --unwrapScalar unwrap scalar, print the value with no quotes, colors or comments. Defaults to true for yaml (default true)
|
||||
|
||||
@ -31,6 +31,7 @@ var frontMatter = ""
|
||||
|
||||
var splitFileExp = ""
|
||||
var splitFileExpFile = ""
|
||||
var splitFileNoOverwrite = false
|
||||
|
||||
var completedSuccessfully = false
|
||||
|
||||
|
||||
@ -206,6 +206,7 @@ yq -P -oy sample.json
|
||||
if err = rootCmd.MarkPersistentFlagFilename("split-exp-file"); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
rootCmd.PersistentFlags().BoolVarP(&splitFileNoOverwrite, "split-exp-no-overwrite", "", false, "When using --split-exp, fail if a target file already exists instead of overwriting it.")
|
||||
|
||||
rootCmd.PersistentFlags().StringVarP(&expressionFile, "from-file", "", "", "Load expression from specified file.")
|
||||
if err = rootCmd.MarkPersistentFlagFilename("from-file"); err != nil {
|
||||
|
||||
@ -186,7 +186,7 @@ func configurePrinterWriter(format *yqlib.Format, out io.Writer) (yqlib.PrinterW
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("bad split document expression: %w", err)
|
||||
}
|
||||
printerWriter = yqlib.NewMultiPrinterWriter(splitExp, format)
|
||||
printerWriter = yqlib.NewMultiPrinterWriterWithOptions(splitExp, format, splitFileNoOverwrite)
|
||||
} else {
|
||||
printerWriter = yqlib.NewSinglePrinterWriter(out)
|
||||
}
|
||||
|
||||
8
go.mod
8
go.mod
@ -13,15 +13,15 @@ require (
|
||||
github.com/hashicorp/hcl/v2 v2.24.0
|
||||
github.com/jinzhu/copier v0.4.0
|
||||
github.com/magiconair/properties v1.8.10
|
||||
github.com/pelletier/go-toml/v2 v2.3.1
|
||||
github.com/pelletier/go-toml/v2 v2.4.0
|
||||
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e
|
||||
github.com/spf13/cobra v1.10.2
|
||||
github.com/spf13/pflag v1.0.10
|
||||
github.com/yuin/gopher-lua v1.1.2
|
||||
github.com/zclconf/go-cty v1.18.1
|
||||
go.yaml.in/yaml/v4 v4.0.0-rc.5
|
||||
golang.org/x/mod v0.36.0
|
||||
golang.org/x/net v0.55.0
|
||||
golang.org/x/mod v0.37.0
|
||||
golang.org/x/net v0.56.0
|
||||
golang.org/x/text v0.38.0
|
||||
)
|
||||
|
||||
@ -34,7 +34,7 @@ require (
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
github.com/mitchellh/go-wordwrap v1.0.1 // indirect
|
||||
golang.org/x/sync v0.21.0 // indirect
|
||||
golang.org/x/sys v0.45.0 // indirect
|
||||
golang.org/x/sys v0.46.0 // indirect
|
||||
golang.org/x/tools v0.45.0 // indirect
|
||||
)
|
||||
|
||||
|
||||
16
go.sum
16
go.sum
@ -46,8 +46,8 @@ github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWE
|
||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0=
|
||||
github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0=
|
||||
github.com/pelletier/go-toml/v2 v2.3.1 h1:MYEvvGnQjeNkRF1qUuGolNtNExTDwct51yp7olPtrEc=
|
||||
github.com/pelletier/go-toml/v2 v2.3.1/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
|
||||
github.com/pelletier/go-toml/v2 v2.4.0 h1:Mwu0mAkUKbittDs3/ADDWXqMmq3EOK2VHiuCkV00Row=
|
||||
github.com/pelletier/go-toml/v2 v2.4.0/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
|
||||
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e h1:aoZm08cpOy4WuID//EZDgcC4zIxODThtZNPirFr42+A=
|
||||
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
@ -70,15 +70,15 @@ github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940/go.mod h1:CmB
|
||||
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
||||
go.yaml.in/yaml/v4 v4.0.0-rc.5 h1:JVliQq9EGOYaTgMi+k8BhUJyqcGk4ZqeuiN1Cirba9c=
|
||||
go.yaml.in/yaml/v4 v4.0.0-rc.5/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
||||
golang.org/x/mod v0.36.0 h1:JJjpVx6myfUsUdAzZuOSTTmRE0PfZeNWzzvKrP7amb4=
|
||||
golang.org/x/mod v0.36.0/go.mod h1:moc6ELqsWcOw5Ef3xVprK5ul/MvtVvkIXLziUOICjUQ=
|
||||
golang.org/x/net v0.55.0 h1:bcvxaJn3e1U6InsFWt1JUq1aSjnRxLzT2rtD2KfkDF8=
|
||||
golang.org/x/net v0.55.0/go.mod h1:L5U2KuzuOe1lY7Z+aWVIKK6qEeJXnXV9yzGA+WCHJww=
|
||||
golang.org/x/mod v0.37.0 h1:vF1DjpVEshcIqoEaauuHebaLk1O1forxjxBaVn884JQ=
|
||||
golang.org/x/mod v0.37.0/go.mod h1:m8S8VeM9r4dzDwjrKO0a1sZP3YjeMamRRlD+fmR2Q/0=
|
||||
golang.org/x/net v0.56.0 h1:Rw8j/hFzGvJUZwNBXnAtf5sVDVt+65SK2C7IxCxZt5o=
|
||||
golang.org/x/net v0.56.0/go.mod h1:D3Ku6r+V6JROoZK144D2XfMHFcMq/0zSfLelVTCFKec=
|
||||
golang.org/x/sync v0.21.0 h1:HLII4xRRTtCRkxYp4HNFF0Js/Og6q2i++KXbg0gHCwM=
|
||||
golang.org/x/sync v0.21.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY=
|
||||
golang.org/x/sys v0.45.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/sys v0.46.0 h1:noSf2Fq6F8DBgS+LysIkx7rIExoNHJsxOAtPp4rthXw=
|
||||
golang.org/x/sys v0.46.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/text v0.38.0 h1:sXmwo9DwP3OK9EZ7PqAdaooSGozfl/3a6/xJcbzPRhE=
|
||||
golang.org/x/text v0.38.0/go.mod h1:YXZt3QhHUKYT53r2lLKFIVi6Ao1jdzrTR/KQ09qyxF4=
|
||||
golang.org/x/tools v0.45.0 h1:18qN3FAooORvApf5XjCXgsuayZOEtXf6JK18I3+ONa8=
|
||||
|
||||
@ -32,9 +32,17 @@ type multiPrintWriter struct {
|
||||
nameExpression *ExpressionNode
|
||||
extension string
|
||||
index int
|
||||
noOverwrite bool
|
||||
}
|
||||
|
||||
func NewMultiPrinterWriter(expression *ExpressionNode, format *Format) PrinterWriter {
|
||||
return NewMultiPrinterWriterWithOptions(expression, format, false)
|
||||
}
|
||||
|
||||
// NewMultiPrinterWriterWithOptions creates a multi-file printer writer.
|
||||
// When noOverwrite is true, attempting to write to a file that already
|
||||
// exists will fail with an error instead of silently overwriting it.
|
||||
func NewMultiPrinterWriterWithOptions(expression *ExpressionNode, format *Format, noOverwrite bool) PrinterWriter {
|
||||
extension := "yml"
|
||||
|
||||
switch format {
|
||||
@ -49,6 +57,7 @@ func NewMultiPrinterWriter(expression *ExpressionNode, format *Format) PrinterWr
|
||||
extension: extension,
|
||||
treeNavigator: NewDataTreeNavigator(),
|
||||
index: 0,
|
||||
noOverwrite: noOverwrite,
|
||||
}
|
||||
}
|
||||
|
||||
@ -75,10 +84,20 @@ func (sp *multiPrintWriter) GetWriter(node *CandidateNode) (*bufio.Writer, error
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
f, err := os.Create(name)
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
var f *os.File
|
||||
if sp.noOverwrite {
|
||||
f, err = os.OpenFile(name, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600)
|
||||
if err != nil {
|
||||
if os.IsExist(err) {
|
||||
return nil, fmt.Errorf("refusing to overwrite existing file %q (--no-overwrite is set)", name)
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
} else {
|
||||
f, err = os.Create(name)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
sp.index = sp.index + 1
|
||||
|
||||
|
||||
96
pkg/yqlib/printer_writer_test.go
Normal file
96
pkg/yqlib/printer_writer_test.go
Normal file
@ -0,0 +1,96 @@
|
||||
package yqlib
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// helper to build an ExpressionNode that just yields a fixed string for the file name
|
||||
func parseFilenameExp(t *testing.T, exp string) *ExpressionNode {
|
||||
t.Helper()
|
||||
InitExpressionParser()
|
||||
node, err := ExpressionParser.ParseExpression(exp)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to parse split-exp test expression %q: %v", exp, err)
|
||||
}
|
||||
return node
|
||||
}
|
||||
|
||||
func TestMultiPrinterWriterOverwriteDefault(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
target := filepath.Join(dir, "out.yml")
|
||||
if err := os.WriteFile(target, []byte("pre-existing\n"), 0600); err != nil {
|
||||
t.Fatalf("setup: %v", err)
|
||||
}
|
||||
|
||||
exp := parseFilenameExp(t, `"`+target+`"`)
|
||||
pw := NewMultiPrinterWriter(exp, YamlFormat)
|
||||
|
||||
node := &CandidateNode{Kind: ScalarNode, Tag: "!!str", Value: "hello"}
|
||||
w, err := pw.GetWriter(node)
|
||||
if err != nil {
|
||||
t.Fatalf("default behaviour should silently overwrite, got error: %v", err)
|
||||
}
|
||||
if w == nil {
|
||||
t.Fatalf("expected a writer, got nil")
|
||||
}
|
||||
// confirm the file was truncated/recreated by os.Create
|
||||
info, err := os.Stat(target)
|
||||
if err != nil {
|
||||
t.Fatalf("stat target: %v", err)
|
||||
}
|
||||
if info.Size() != 0 {
|
||||
t.Fatalf("expected file to be truncated (size 0) before writes, got %d bytes", info.Size())
|
||||
}
|
||||
}
|
||||
|
||||
func TestMultiPrinterWriterNoOverwriteRefusesExisting(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
target := filepath.Join(dir, "out.yml")
|
||||
if err := os.WriteFile(target, []byte("pre-existing\n"), 0600); err != nil {
|
||||
t.Fatalf("setup: %v", err)
|
||||
}
|
||||
|
||||
exp := parseFilenameExp(t, `"`+target+`"`)
|
||||
pw := NewMultiPrinterWriterWithOptions(exp, YamlFormat, true)
|
||||
|
||||
node := &CandidateNode{Kind: ScalarNode, Tag: "!!str", Value: "hello"}
|
||||
_, err := pw.GetWriter(node)
|
||||
if err == nil {
|
||||
t.Fatalf("expected error when --no-overwrite is set and target exists, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "refusing to overwrite") {
|
||||
t.Fatalf("expected refusing-to-overwrite error message, got: %v", err)
|
||||
}
|
||||
|
||||
// file must be untouched
|
||||
data, err := os.ReadFile(target)
|
||||
if err != nil {
|
||||
t.Fatalf("read target: %v", err)
|
||||
}
|
||||
if string(data) != "pre-existing\n" {
|
||||
t.Fatalf("file should be untouched, contents = %q", string(data))
|
||||
}
|
||||
}
|
||||
|
||||
func TestMultiPrinterWriterNoOverwriteCreatesNew(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
target := filepath.Join(dir, "new.yml")
|
||||
|
||||
exp := parseFilenameExp(t, `"`+target+`"`)
|
||||
pw := NewMultiPrinterWriterWithOptions(exp, YamlFormat, true)
|
||||
|
||||
node := &CandidateNode{Kind: ScalarNode, Tag: "!!str", Value: "hello"}
|
||||
w, err := pw.GetWriter(node)
|
||||
if err != nil {
|
||||
t.Fatalf("no-overwrite should still create new files, got: %v", err)
|
||||
}
|
||||
if w == nil {
|
||||
t.Fatalf("expected a writer, got nil")
|
||||
}
|
||||
if _, err := os.Stat(target); err != nil {
|
||||
t.Fatalf("expected new file to exist, stat err: %v", err)
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user