suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2024-12-19 20:19:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed remove comments example

Browse Source
This commit is contained in:
Mike Farah 2021-01-14 09:12:14 +11:00
parent 947ffb6986
commit c59209f041
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pkg/yqlib/doc/Comment Operators.md
View File

@ -78,17 +78,22 @@ b: dog # leave this
``` ```
## Remove all comments ## Remove all comments
Note the use of `...` to ensure key nodes are included.
Given a sample.yml file of: Given a sample.yml file of:
```yaml ```yaml
a: cat # comment a: cat # comment
# great
b: # key comment
``` ```
then then
```bash ```bash
yq eval '.. comments=""' sample.yml yq eval '... comments=""' sample.yml
``` ```
will output will output
```yaml ```yaml
a: cat a: cat
b:
``` ```
## Get line comment ## Get line comment

7
pkg/yqlib/operator_comments_test.go
View File

@ -72,10 +72,11 @@ var commentOperatorScenarios = []expressionScenario{
}, },
{ {
description: "Remove all comments", description: "Remove all comments",
document: "# hi\n\na: cat # comment\n\n# great\n", subdescription: "Note the use of `...` to ensure key nodes are included.",
expression: `.. comments=""`, document: "# hi\n\na: cat # comment\n\n# great\n\nb: # key comment",
expression: `... comments=""`,
expected: []string{ expected: []string{
"D0, P[], (!!map)::a: cat\n", "D0, P[], (!!map)::a: cat\nb:\n",
}, },
}, },
{ {