Skip to content

Unwrap scalars in shell output mode. #2548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikefarah merged 5 commits into from
Jan 1, 2026
Merged

Unwrap scalars in shell output mode. #2548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a84c2eb
feat: Add UnwrapScalar to ShellVariablesPreferences
flintwinters Dec 17, 2025
c859948
feat: Propagate unwrapScalar to ShellVariablesPreferences
flintwinters Dec 17, 2025
fe0ed2a
feat: Implement conditional quoting in shellVariablesEncoder
flintwinters Dec 17, 2025
3288300
test: Add tests for UnwrapScalar in shell encoder
flintwinters Dec 17, 2025
addb1bf
remove redundant test
flintwinters Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cmd/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ func configureEncoder() (yqlib.Encoder, error) {
yqlib.ConfiguredYamlPreferences.UnwrapScalar = unwrapScalar
yqlib.ConfiguredPropertiesPreferences.UnwrapScalar = unwrapScalar
yqlib.ConfiguredJSONPreferences.UnwrapScalar = unwrapScalar
yqlib.ConfiguredShellVariablesPreferences.UnwrapScalar = unwrapScalar

yqlib.ConfiguredYamlPreferences.ColorsEnabled = colorsEnabled
yqlib.ConfiguredJSONPreferences.ColorsEnabled = colorsEnabled
Expand Down
8 changes: 7 additions & 1 deletion pkg/yqlib/encoder_shellvariables.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,13 @@ func (pe *shellVariablesEncoder) doEncode(w *io.Writer, node *CandidateNode, pat
// let's just pick a fallback key to use if we are encoding a single scalar
nonemptyPath = "value"
}
_, err := io.WriteString(*w, nonemptyPath+"="+quoteValue(node.Value)+"\n")
var valueString string
if pe.prefs.UnwrapScalar {
valueString = node.Value
} else {
valueString = quoteValue(node.Value)
Copy link
Copy Markdown
Owner

@mikefarah mikefarah Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, looking at the quoteValue function, it only quotes if it determines that it needs to (non alpha numeric characters).

I think with this change yq could emit invalid shell script...

Copy link
Copy Markdown
Contributor Author

@flintwinters flintwinters Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Mike,
Thanks for your reply.

The original, unchanged code used quoteValue indiscriminately.
Is this an issue with my PR or with the original issue?
If the former, I am not understanding the intended behavior.

Cheers.

Copy link
Copy Markdown
Owner

@mikefarah mikefarah Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking at what quoteValue does; it only quotes if necessary :/

I'm now wondering if this is the right approach 🤔 There's also a "properties" file format that may be more suited - can you give a couple of examples that you need for your usecase?

Copy link
Copy Markdown
Contributor Author

@flintwinters flintwinters Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,
I am not the original opener of the issue, I was just implementing the change based on my understanding of it.

I would also be enlightened by some examples 😅
Maybe the issue should be closed if no examples are provided.

Best.

}
_, err := io.WriteString(*w, nonemptyPath+"="+valueString+"\n")
return err
case SequenceNode:
for index, child := range node.Content {
Expand Down
33 changes: 33 additions & 0 deletions pkg/yqlib/encoder_shellvariables_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,36 @@ func TestShellVariablesEncoderCustomSeparatorArray(t *testing.T) {
func TestShellVariablesEncoderCustomSeparatorSingleChar(t *testing.T) {
assertEncodesToWithSeparator(t, "a:\n b: value", "aXb=value", "X")
}

func assertEncodesToUnwrapped(t *testing.T, yaml string, shellvars string) {
var output bytes.Buffer
writer := bufio.NewWriter(&output)

originalUnwrapScalar := ConfiguredShellVariablesPreferences.UnwrapScalar
defer func() {
ConfiguredShellVariablesPreferences.UnwrapScalar = originalUnwrapScalar
}()

ConfiguredShellVariablesPreferences.UnwrapScalar = true

var encoder = NewShellVariablesEncoder()
inputs, err := readDocuments(strings.NewReader(yaml), "test.yml", 0, NewYamlDecoder(ConfiguredYamlPreferences))
if err != nil {
panic(err)
}
node := inputs.Front().Value.(*CandidateNode)
err = encoder.Encode(writer, node)
if err != nil {
panic(err)
}
writer.Flush()

test.AssertResult(t, shellvars, strings.TrimSuffix(output.String(), "\n"))
}

func TestShellVariablesEncoderUnwrapScalar(t *testing.T) {
assertEncodesToUnwrapped(t, "a: Lewis Carroll", "a=Lewis Carroll")
assertEncodesToUnwrapped(t, "b: 123", "b=123")
assertEncodesToUnwrapped(t, "c: true", "c=true")
assertEncodesToUnwrapped(t, "d: value with spaces", "d=value with spaces")
}
2 changes: 2 additions & 0 deletions pkg/yqlib/shellvariables.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ package yqlib

type ShellVariablesPreferences struct {
KeySeparator string
UnwrapScalar bool
}

func NewDefaultShellVariablesPreferences() ShellVariablesPreferences {
return ShellVariablesPreferences{
KeySeparator: "_",
UnwrapScalar: false,
}
}

Expand Down
Loading