Yamkix

Yamkix is an opinionated yaml file formatter. It reads YAML from a file or STDIN and writes it back nicely formatted, preserving comments.

Why?

• Because I like my yaml file to be nicely formatted and there is not out of the box default format rules.
• Because https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml does not add explicit start of documents and I don't like it this way
• Because I'm not a js / typescript dev so I don't want to go into a VSCode extension with client and server language

Documentation

The documentation follows the Diátaxis framework:

• Tutorials — start here if you are new: install yamkix and format your first file.
• How-to guides — task-oriented recipes: install, format files, convert flow style to block style, control quotes, align comments, pre-commit hook, editor integration.
• Reference — information-oriented descriptions: CLI options, public API, changelog.
• Explanation — understanding-oriented background: formatting rules, ecosystem.

Where does the name yamkix come from?

• Thanks to http://online-generator.com/name-generator/product-name-generator.php that suggested me zamkix. Just switched the starting z for the y of yaml