JQ usage examples

_resources.md

Useful resources

• https://jqlang.github.io/jq/manual/
• https://jqplay.org/
• https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq
• https://unix.stackexchange.com/questions/722684/jq-nested-reduce-grouping-of-json-data
• https://programminghistorian.org/en/lessons/json-and-jq

contracts-test.json

{
  "contracts": [
    {
      "name": "Honda001",
      "manufacturer": {
        "name": "Honda"
      }
    },
    {
      "name": "Toyota001",
      "manufacturer": {
        "name": "Toyota"
      }
    },
    {
      "name": "Honda001",
      "manufacturer": {
        "name": "Honda"
      }
    },
    {
      "name": "Lexus001",
      "manufacturer": {
        "name": "Lexus"
      }
    },
    {
      "name": "Nissan001",
      "manufacturer": {
        "name": "Nissan"
      }
    },
    {
      "name": "Toyota002",
      "manufacturer": {
        "name": "Toyota"
      }
    }
  ]
}

contracts-test.md

Transformation

Number of contract

jq '.contracts | length' contracts-test.json

Contract names

jq '.contracts | .[].name' contracts-test.json

Number of unique manufacturers

jq '.contracts | map(.manufacturer) | unique_by(.name) | length' contracts-test.json

Unique manufacturer names

jq '.contracts | map(.manufacturer) | unique_by(.name) | .[].name' contracts-test.json

works but breaks json into separate inputs

jq -c '.contracts[] | {m: .manufacturer.name, c: .name}' contracts-test.json
jq '.contracts[] | select(.manufacturer.name == "Honda")'  contracts-test.json

List manufacturers and their contracts

jq '.contracts | group_by(.manufacturer.name) | map({"manufacturer": .[0].manufacturer.name, "contracts": map(.name)})' contracts-test.json

See working example at https://jqplay.org/s/n3i9BZwgE0_m

create.md

Create new JSON

Using shell parameter passed

compatibility="forward"
jq -n --arg content "$compatibility" '{"compatibility": $content}'

Escape schema json parameter as string

jq -n --arg content "$schema" --arg artifact "$filename" \
'{"schema": $content, "metadata": {"properties": {"artifact": $artifact} } }'

Include json unescaped passed as a parameter

jq -n --argjson data $vault_data '{"data": $data}'

ms-teams.json

{
  "type": "message",
  "attachments": [
    {
      "contentType": "application/vnd.microsoft.card.adaptive",
      "content": {
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
        "type": "AdaptiveCard",
        "version": "1.2",
        "body": [
          {
            "type": "TextBlock",
            "text": "{{ message }}",
            "weight": "bolder",
            "size": "large",
            "wrap": true,
            "color": "{{ color }}"
          }
        ],
        "msteams": {
          "width": "Full"
        }
      }
    }
  ]
}

ms-teams.md

Replace values in JSON tempate and post MS Teams notification

status="good"
message="Test message"
json=$(jq --arg status "$status" --arg message "$message" \
          '.attachments[0].content.body[0].text = $message | .attachments[0].content.body[0].color = $status' \
          .github/teams.json)
curl -s --show-error --fail --request POST --header 'Content-Type: application/json;charset=UTF-8' --data "$json" $teams_hook_url