Add a strip comments flag that will remove all comments from the output

[momoYB]

Is your feature request related to a problem? Please describe.
Add a strip comments flag, as it will help resolve some minor incompatible changes produced by the "keeping YAML comments" feature in YQ 3.X.X

mikefarah commented 14 days ago
...
Failing a yaml.v3 fix - the only thing I can think of is adding a strip comments flag that will remove all the comments...

Describe the solution you'd like
If we have countries.yaml like:

country:
    name: USA
    # name: United States of America
    capital: Washington, D.C.
    monuments:
        - Statue of Liberty
        - Grand Canyon
        # - Giant Sequoia
        # - Washington Monument
        - Mount Rushmore
    # currency: USD

Currently, if we run the command:

yq r countries.yaml "country.monuments"

the output is:

- Statue of Liberty
- Grand Canyon
# - Giant Sequoia
# - Washington Monument
- Mount Rushmore

With strip comments flag like:

yq r countries.yaml --stripComments "country.monuments"

the wanted output should be:

- Statue of Liberty
- Grand Canyon
- Mount Rushmore

[mikefarah]

This would be a nice feature to add - I'll get to it when I have time (or someone raises a PR...)

[summatix]

Has this been implemented yet?

[mikefarah]

yep - in 3.3.0: https://mikefarah.gitbook.io/yq/usage/output-format#strip-comments

[summatix]

Ah ok. I was looking at yq merge and couldn't find the option, but now I see it in yq read.

[igaskin]

For future travelers, updated link for v4.x: https://mikefarah.gitbook.io/yq/operators/comment-operators#remove-strip-all-comments