yq工具处理YAML转环境变量格式的注意事项

在Shell脚本开发中，经常需要将YAML配置文件转换为环境变量格式。mikefarah/yq作为强大的YAML处理工具，其文档中提供了一个将YAML转换为环境变量格式的示例，但在实际使用中发现该示例存在转义问题。

问题现象

当尝试使用文档中的示例命令时：

echo 'simple: string0
simpleArray:
  - apple
  - banana
  - peach
deep:
  property: value
  array:
    - cat' | yq '.. |(
        ( select(kind == "scalar" and parent | kind != "seq") | (path | join("_")) + "='" + . + "'"),
        ( select(kind == "seq") | (path | join("_")) + "=(" + (map("'" + . + "'") | join(",")) + ")")
)'

输出结果不符合预期，字符串连接处出现了+ . +这样的异常内容。

问题原因

这是由于Shell中单引号字符串内的单引号需要特殊转义导致的。在Shell中，要在单引号字符串中包含单引号本身，需要使用'\''这样的转义序列。

解决方案

修正后的命令应该如下：

yq '.. |(
        ( select(kind == "scalar" and parent | kind != "seq") | (path | join("_")) + "='\''" + . + "'\''"),
        ( select(kind == "seq") | (path | join("_")) + "=(" + (map("'\''" + . + "'\''") | join(",")) + ")")
)' test.yaml

技术要点

1. Shell字符串转义：在单引号字符串中插入单引号需要特殊处理，'\''实际上是：

   • 结束当前单引号字符串
   • 使用转义的单引号
   • 开始新的单引号字符串

2. yq处理逻辑：

   • 对于标量值（非数组元素），生成KEY='VALUE'格式
   • 对于数组，生成KEY=('VALUE1','VALUE2')格式
   • 使用path | join("_")将嵌套路径转换为下划线连接的变量名

3. 类型判断：

   • kind == "scalar"判断是否为简单值
   • parent | kind != "seq"确保不是数组元素
   • kind == "seq"判断是否为数组

实际应用

这种转换特别适用于：

• 需要将YAML配置导入Shell环境的场景
• 在CI/CD流程中动态生成环境变量
• 开发跨语言配置共享的系统

通过正确转义单引号，可以确保生成的变量定义能够被Shell正确解析，避免语法错误。这个技巧也适用于其他需要在Shell中处理包含特殊字符字符串的场景。