miekg/yamlfmt

Format YAML

YAMLfmt

yamlfmt is a little Go binary that reads YAML from file(s) or standard input, formats it and then writes it to standard output.

Use in Editors

Vim

Use the following configuration in Vim, to create a "Fmt" command that formats your YAML.

au FileType yaml command! Fmt call YamlFmt(120)
let yaml_fmt = "yamlfmt /dev/stdin"
au FileType yaml let &l:formatprg=yaml_fmt

yamlfmt's Issues

Print leading '---'

It would make it trivial to apply multiple yamlfmt'ed files for sending over pipes and such:

cat lots-of-yaml/* | ssh bastion ... kubectl apply -f -

(ATM, I have to apply them one a time OR manually stitch them together).

While I've mostly been hand-writing YAML (horay for auto-formatting!), quite a few linters get annoyed about the missing trible-dash in the beginning of the document.

go yaml v3 is out

yaml v3 keeps track of comment, which will make yamlfmt just perfect.

Move to yaml v3 .

Continuously adds an empty line to a block of >- text

On the following YAML file yamlfmt will continuously insert an empty line between X and Y, no matter how many empty lines are there between them.

>-
  X
    Y