030 / go-yq

jq-style golang equivalent of yq

go-yq

jq-style golang equivalent of yq.

rationale

go-yq was created to prevent that pip has to be installed in order to install yq

installation

curl -L https://github.com/030/go-yq/releases/download/x.y.z/go-yq_x.y.z-0.deb -o go-yq.deb && \
sudo apt -y install ./go-yq.deb

usage

help

[user@localhost go-yq]$ ./go-yq -h
2018/11/13 12:07:39 Usage: go-yq <key e.g. .foo.bar> <filename e.g. input.yaml>
exit status 1

examples

[user@localhost go-yq]$ ./go-yq go run main.go .firefox_version ~/dev/ansible-firefox/defaults/main.yml

or

docker run -v /home/ben/dev/ansible-firefox:/ansible-firefox \
       -it utrecht/go-yq:x.y.z .firefox_version \
       /ansible-firefox/defaults/main.yml

returns:

66.0.3

go-yq's Issues

programmatically yaml test file

replace the test.yaml by constructing a yaml file using a yaml parser and cleaning it up when the test has been completed

Incorrect artifacts in releases section

map does not seem to work

go-yq '.a.b' does not match

a:
- b:
  - c: 123
    d: 456
    e:
      f: 789
  aa:
  - bb: 111
    cc: 222
    dd: 333

nested hash in yaml

cii badge

changelog.md

interface

struct

version

show version

Please add a binary for macOS

Currently you only provide linux binaries, can you also provide binaries for macOS?

golangci badge

windows binary

Lists separated as hyphens do not work

In this example yaml file (taken from Wikipedia)

men: [John Smith, Bill Jones]
women:
  - Mary Smith
  - Susan Williams

I get the unexpected output:

$ go-yq-1.1.1-darwin -yamlFile women.yml -key women
2018/11/12 12:09:35 File: women.yml does not contain key: women

For the key men it does work:

$ go-yq-1.1.1-darwin -yamlFile women.yml -key men
[John Smith, Bill Jones]

validate whether input file is yaml

use golang yaml parser

bash: /usr/local/bin/go-yq: No such file or directory

alpine 3.12

Duplicate keys overwrite older version

When I search for kid1 in the following yaml:

men: [John Smith, Bill Jones]
women:
  - Mary Smith
  - Susan Williams

kid:
  kid1: jan

kid1: piet

The output is piet. I'm not sure what to expect, but at least this behaviour should be documented.

sonar

rationale for starting this project

comments not allowed after values

example

a: halloAllemaal  # yamllint disable-line

should return

halloAllemaal

Partial match

[user@localhost go-yq]$ go run main.go firefox_checksum ~/dev/ansible-firefox/defaults/main.yml 
sha512:49d776cfb5f42c6e5ea1a55a80d9f6bad223080b16baa0d39de63534c25e68340091b4e16be5355d565f81291cb94fb996f03ae7e3e4c7a28021b0a0929daf58

partial match

[user@localhost go-yq]$ go run main.go irefox_checksum ~/dev/ansible-firefox/defaults/main.yml 
sha512:49d776cfb5f42c6e5ea1a55a80d9f6bad223080b16baa0d39de63534c25e68340091b4e16be5355d565f81291cb94fb996f03ae7e3e4c7a28021b0a0929daf58

output -o @yml

first mvp

docker

if a key contains a digit the tool will exit

./go-yq -yamlFile defaults/main.yml -key checksum3

results in:

2018/11/11 13:14:35 Cannot extract value for key, but was: 'checksum3: 7e3e4c7a28021b0a0929daf58' please check whether the regex matches the key

go modules

Add checksum files for the generated binaries

In order to verify the downloaded binaries it would be nice if you can add checksum files.

license

I have a similar project - want to join forces?

Hey just saw your post on jq, I also have a go implementation:

https://github.com/mikefarah/yq

I have a bunch of outstanding things to do - not sure if you're interested in helping out!

If not - no worries

apt

releases gist

cicd

jq compliant

Tool should comply to the jq policy, i.e. using dots, e.g. yq .foo.bar input.yml

Mismatch: 64.0 vs. %!s(float64=64)

never ignore error handling

Expected: exit 1 if key not found

Actual: exit 0