alpTom/yq
1
0
Fork 0
mirror of https://gitee.com/mirrors_adrian-thurston/yq.git synced 2026-01-15 07:53:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updating with documentation

Browse Source
This commit is contained in:
Mike Farah
2021-09-16 10:55:26 +10:00
parent 2292f0ffb4
commit 43e40a6dda
3 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/yqlib/doc/With.md
View File

@@ -1,4 +1,4 @@
Use the `with` operator to conveniently make multiple updates to a deeply nested path, or to update array elements relatively to each other.
Use the `with` operator to conveniently make multiple updates to a deeply nested path, or to update array elements relatively to each other. The first argument expression sets the root context, and the second expression runs against that root context.
## Update and style
Given a sample.yml file of:
@@ -39,6 +39,8 @@ a:
```
## Update array elements relatively
The second expression runs with each element of the array as it's contextual root. This allows you to make updates relative to the element.
Given a sample.yml file of:
```yaml
myArray:

2
pkg/yqlib/doc/headers/With.md
View File

@@ -1 +1 @@
Use the `with` operator to conveniently make multiple updates to a deeply nested path, or to update array elements relatively to each other.
Use the `with` operator to conveniently make multiple updates to a deeply nested path, or to update array elements relatively to each other. The first argument expression sets the root context, and the second expression runs against that root context.

7
pkg/yqlib/operator_with_test.go
View File

@@ -20,9 +20,10 @@ var withOperatorScenarios = []expressionScenario{
},
},
{
description: "Update array elements relatively",
document: `myArray: [{a: apple},{a: banana}]`,
expression: `with(.myArray[]; .b = .a + " yum")`,
description: "Update array elements relatively",
subdescription: "The second expression runs with each element of the array as it's contextual root. This allows you to make updates relative to the element.",
document: `myArray: [{a: apple},{a: banana}]`,
expression: `with(.myArray[]; .b = .a + " yum")`,
expected: []string{
"D0, P[], (doc)::myArray: [{a: apple, b: apple yum}, {a: banana, b: banana yum}]\n",
},