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
0ca8a13e36
yq/pkg/yqlib/operator_comments_test.go

271 lines
7.9 KiB
Go
Raw Normal View History

comment ops!
2020-11-06 00:23:26 +00:00
package yqlib
import (
"testing"
)
Added comment operator examples
2022-09-30 01:22:58 +00:00
var expectedWhereIsMyCommentMapKey = `D0, P[], (!!seq)::- p: ""
isKey: false
hc: ""
lc: ""
fc: ""
- p: hello
isKey: true
hc: ""
lc: hello-world-comment
fc: ""
- p: hello
isKey: false
hc: ""
lc: ""
fc: ""
- p: hello.message
isKey: true
hc: ""
lc: ""
fc: ""
- p: hello.message
isKey: false
hc: ""
lc: ""
fc: ""
`
var expectedWhereIsMyCommentArray = `D0, P[], (!!seq)::- p: ""
isKey: false
hc: ""
lc: ""
fc: ""
- p: name
isKey: true
hc: ""
lc: ""
fc: ""
- p: name
isKey: false
hc: ""
lc: ""
fc: ""
- p: name.0
isKey: false
hc: under-name-comment
lc: ""
fc: ""
`
comment ops!
2020-11-06 00:23:26 +00:00
var commentOperatorScenarios = []expressionScenario{
wip - rabbit hole :/
2023-05-02 04:07:59 +00:00
// {
// description: "Set line comment",
// subdescription: "Set the comment on the key node for more reliability (see below).",
// document: `a: cat`,
// expression: `.a line_comment="single"`,
// expected: []string{
// "D0, P[], (doc)::a: cat # single\n",
// },
// },
// {
// description: "Set line comment of a maps/arrays",
// subdescription: "For maps and arrays, you need to set the line comment on the _key_ node. This will also work for scalars.",
// document: "a:\n b: things",
// expression: `(.a | key) line_comment="single"`,
// expected: []string{
// "D0, P[], (doc)::a: # single\n b: things\n",
// },
// },
// {
// skipDoc: true,
// document: "a: cat\nb: dog",
// expression: `.a line_comment=.b`,
// expected: []string{
// "D0, P[], (doc)::a: cat # dog\nb: dog\n",
// },
// },
// {
// skipDoc: true,
// document: "a: cat\n---\na: dog",
// expression: `.a line_comment |= documentIndex`,
// expected: []string{
// "D0, P[], (doc)::a: cat # 0\n",
// "D1, P[], (doc)::a: dog # 1\n",
// },
// },
// {
// description: "Use update assign to perform relative updates",
// document: "a: cat\nb: dog",
// expression: `.. line_comment |= .`,
// expected: []string{
// "D0, P[], (doc)::a: cat # cat\nb: dog # dog\n",
// },
// },
// {
// skipDoc: true,
// document: "a: cat\nb: dog",
// expression: `.. comments |= .`,
// expected: []string{
// "D0, P[], (doc)::a: cat # cat\n# cat\n\n# cat\nb: dog # dog\n# dog\n\n# dog\n",
// },
// },
Added comment operator examples
2022-09-30 01:22:58 +00:00
{
description: "Where is the comment - map key example",
subdescription: "The underlying yaml parser can assign comments in a document to surprising nodes. Use an expression like this to find where you comment is. 'p' indicates the path, 'isKey' is if the node is a map key (as opposed to a map value).\nFrom this, you can see the 'hello-world-comment' is actually on the 'hello' key",
document: "hello: # hello-world-comment\n message: world",
expression: `[... | {"p": path | join("."), "isKey": is_key, "hc": headComment, "lc": lineComment, "fc": footComment}]`,
expected: []string{
expectedWhereIsMyCommentMapKey,
},
},
wip - rabbit hole :/
2023-05-02 04:07:59 +00:00
// {
// description: "Retrieve comment - map key example",
// subdescription: "From the previous example, we know that the comment is on the 'hello' _key_ as a lineComment",
// document: "hello: # hello-world-comment\n message: world",
// expression: `.hello | key | line_comment`,
// expected: []string{
// "D0, P[hello], (!!str)::hello-world-comment\n",
// },
// },
// {
// description: "Where is the comment - array example",
// subdescription: "The underlying yaml parser can assign comments in a document to surprising nodes. Use an expression like this to find where you comment is. 'p' indicates the path, 'isKey' is if the node is a map key (as opposed to a map value).\nFrom this, you can see the 'under-name-comment' is actually on the first child",
// document: "name:\n # under-name-comment\n - first-array-child",
// expression: `[... | {"p": path | join("."), "isKey": is_key, "hc": headComment, "lc": lineComment, "fc": footComment}]`,
// expected: []string{
// expectedWhereIsMyCommentArray,
// },
// },
// {
// description: "Retrieve comment - array example",
// subdescription: "From the previous example, we know that the comment is on the first child as a headComment",
// document: "name:\n # under-name-comment\n - first-array-child",
// expression: `.name[0] | headComment`,
// expected: []string{
// "D0, P[name 0], (!!str)::under-name-comment\n",
// },
// },
// {
// description: "Set head comment",
// document: `a: cat`,
// expression: `. head_comment="single"`,
// expected: []string{
// "D0, P[], (doc)::# single\n\na: cat\n",
// },
// },
// {
// description: "Set head comment of a map entry",
// document: "f: foo\na:\n b: cat",
// expression: `(.a | key) head_comment="single"`,
// expected: []string{
// "D0, P[], (doc)::f: foo\n# single\na:\n b: cat\n",
// },
// },
// {
// description: "Set foot comment, using an expression",
// document: `a: cat`,
// expression: `. foot_comment=.a`,
// expected: []string{
// "D0, P[], (doc)::a: cat\n# cat\n",
// },
// },
// {
// skipDoc: true,
// description: "Set foot comment, using an expression",
// document: "a: cat\n\n# hi",
// expression: `. foot_comment=""`,
// expected: []string{
// "D0, P[], (doc)::a: cat\n",
// },
// },
// {
// skipDoc: true,
// document: `a: cat`,
// expression: `. foot_comment=.b.d`,
// expected: []string{
// "D0, P[], (doc)::a: cat\n",
// },
// },
// {
// skipDoc: true,
// document: `a: cat`,
// expression: `. foot_comment|=.b.d`,
// expected: []string{
// "D0, P[], (doc)::a: cat\n",
// },
// },
// {
// description: "Remove comment",
// document: "a: cat # comment\nb: dog # leave this",
// expression: `.a line_comment=""`,
// expected: []string{
// "D0, P[], (doc)::a: cat\nb: dog # leave this\n",
// },
// },
// {
// description: "Remove (strip) all comments",
// subdescription: "Note the use of `...` to ensure key nodes are included.",
// document: "# hi\n\na: cat # comment\n\n# great\n\nb: # key comment",
// expression: `... comments=""`,
// expected: []string{
// "D0, P[], (doc)::a: cat\nb:\n",
// },
// },
// {
// description: "Get line comment",
// document: "# welcome!\n\na: cat # meow\n\n# have a great day",
// expression: `.a | line_comment`,
// expected: []string{
// "D0, P[a], (!!str)::meow\n",
// },
// },
// {
// description: "Get head comment",
// dontFormatInputForDoc: true,
// document: "# welcome!\n\na: cat # meow\n\n# have a great day",
// expression: `. | head_comment`,
// expected: []string{
// "D0, P[], (!!str)::welcome!\n\n",
// },
// },
// {
// skipDoc: true,
// description: "strip trailing comment recurse all",
// document: "a: cat\n\n# haha",
// expression: `... comments= ""`,
// expected: []string{
// "D0, P[], (doc)::a: cat\n",
// },
// },
// {
// skipDoc: true,
// description: "strip trailing comment recurse values",
// document: "a: cat\n\n# haha",
// expression: `.. comments= ""`,
// expected: []string{
// "D0, P[], (doc)::a: cat\n",
// },
// },
// {
// description: "Head comment with document split",
// dontFormatInputForDoc: true,
// document: "# welcome!\n---\n# bob\na: cat # meow\n\n# have a great day",
// expression: `head_comment`,
// expected: []string{
// "D0, P[], (!!str)::welcome!\nbob\n",
// },
// },
// {
// description: "Get foot comment",
// dontFormatInputForDoc: true,
// document: "# welcome!\n\na: cat # meow\n\n# have a great day\n# no really",
// expression: `. | foot_comment`,
// expected: []string{
// "D0, P[], (!!str)::have a great day\nno really\n",
// },
// },
comment ops!
2020-11-06 00:23:26 +00:00
}
func TestCommentOperatorScenarios(t *testing.T) {
for _, tt := range commentOperatorScenarios {
testScenario(t, &tt)
}
Added XML decoder (#1044)
2021-12-21 04:02:07 +00:00
documentOperatorScenarios(t, "comment-operators", commentOperatorScenarios)
comment ops!
2020-11-06 00:23:26 +00:00
}
Reference in New Issue Copy Permalink