When you are working on the web or with DevOps or GitOps, you will have cases where you want to transform a JSON file to YAML. This article walks you though converting the JSON document to YAML using the \u201cjq\u201d tool.<\/p>\n
Here are a few reasons why developers prefer YAML over JSON:<\/p>\n
~\/.jq<\/code><\/li>\n<\/ul>\n\ndef yamlify2:\n (objects | to_entries | (map(.key | length) | max + 2) as $w |\n .[] | (.value | type) as $type |\n if $type == \"array\" then\n \"\\(.key):\", (.value | yamlify2)\n elif $type == \"object\" then\n \"\\(.key):\", \" \\(.value | yamlify2)\"\n else\n \"\\(.key):\\(\" \" * (.key | $w - length))\\(.value)\"\n end\n )\n \/\/ (arrays | select(length > 0)[] | [yamlify2] |\n \" - \\(.[0])\", \" \\(.[1:][])\"\n )\n \/\/ .\n ;<\/pre>\n<\/div>\nThe above code adds a new function \u201cyamlify2\u201d to your library of jq functions.
<\/div> <\/div><\/p>\nJSON to YAML conversion using JQ<\/h3>\n
Now we are ready to convert a JSON document to YAML.<\/p>\n
Syntax:<\/h2>\n\njq -r yamlify2 input.json\n# or\njq -r yamlify2 input.json > output.yaml<\/pre>\n<\/div>\nWorking Example:<\/h2>\n
Filename: glossary.json<\/p>\n
\n{\n \"glossary\": {\n \"title\": \"example glossary\",\n\t\t\"GlossDiv\": {\n \"title\": \"S\",\n\t\t\t\"GlossList\": {\n \"GlossEntry\": {\n \"ID\": \"SGML\",\n\t\t\t\t\t\"SortAs\": \"SGML\",\n\t\t\t\t\t\"GlossTerm\": \"Standard Generalized Markup Language\",\n\t\t\t\t\t\"Acronym\": \"SGML\",\n\t\t\t\t\t\"Abbrev\": \"ISO 8879:1986\",\n\t\t\t\t\t\"GlossDef\": {\n \"para\": \"A meta-markup language, used to create markup languages such as DocBook.\",\n\t\t\t\t\t\t\"GlossSeeAlso\": [\"GML\", \"XML\"]\n },\n\t\t\t\t\t\"GlossSee\": \"markup\"\n }\n }\n }\n }\n}<\/pre>\n<\/div>\n\njq -r yamlify2 glossary.json\n# or\njq -r yamlify2 glossary.json > glossary.yaml<\/pre>\n<\/div>\nResult (under glossary.yaml)<\/p>\n
\nglossary:\n title: example glossary\n GlossDiv:\n title: S\n GlossList:\n GlossEntry:\n ID: SGML\n SortAs: SGML\n GlossTerm: Standard Generalized Markup Language\n Acronym: SGML\n Abbrev: ISO 8879:1986\n GlossDef:\n para: A meta-markup language, used to create markup languages such as DocBook.\n GlossSeeAlso:\n - GML\n - XML\n GlossSee: markup<\/pre>\n<\/div>\nYou should have a YAML file ready to use in your project.<\/p>\n
Cheers<\/p>\n
\n