Need to escape single quotes in bash, updated docs #1932

mikefarah · Feb 2, 2024 · 6e21c9f · 6e21c9f
1 parent 2473068
commit 6e21c9f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/pkg/yqlib/doc/usage/recipes.md b/pkg/yqlib/doc/usage/recipes.md
@@ -168,8 +168,8 @@ fruit:
 then
 ```bash
 yq '.[] |(
-	( select(kind == "scalar") | key + "='" + . + "'"),
-	( select(kind == "seq") | key + "=(" + (map("'" + . + "'") | join(",")) + ")")
+	( select(kind == "scalar") | key + "='\''" + . + "'\''"),
+	( select(kind == "seq") | key + "=(" + (map("'\''" + . + "'\''") | join(",")) + ")")
 )' sample.yml
 ```
 will output
@@ -203,8 +203,8 @@ deep:
 then
 ```bash
 yq '.. |(
-	( select(kind == "scalar" and parent | kind != "seq") | (path | join("_")) + "='" + . + "'"),
-	( select(kind == "seq") | (path | join("_")) + "=(" + (map("'" + . + "'") | join(",")) + ")")
+	( select(kind == "scalar" and parent | kind != "seq") | (path | join("_")) + "='\''" + . + "'\''"),
+	( select(kind == "seq") | (path | join("_")) + "=(" + (map("'\''" + . + "'\''") | join(",")) + ")")
 )' sample.yml
 ```
 will output

diff --git a/pkg/yqlib/operators_test.go b/pkg/yqlib/operators_test.go
@@ -317,7 +317,7 @@ func documentInput(w *bufio.Writer, s expressionScenario) (string, string) {
 		writeOrPanic(w, "then\n")
 
 		if s.expression != "" {
-			writeOrPanic(w, fmt.Sprintf("```bash\n%vyq %v'%v' %v\n```\n", envCommand, command, s.expression, files))
+			writeOrPanic(w, fmt.Sprintf("```bash\n%vyq %v'%v' %v\n```\n", envCommand, command, strings.ReplaceAll(s.expression, "'", `'\''`), files))
 		} else {
 			writeOrPanic(w, fmt.Sprintf("```bash\n%vyq %v%v\n```\n", envCommand, command, files))
 		}