Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

yaml: Consider adding a YAML style guide #841

Open
nielm opened this issue Jul 17, 2024 · 2 comments
Open

yaml: Consider adding a YAML style guide #841

nielm opened this issue Jul 17, 2024 · 2 comments

Comments

@nielm
Copy link

nielm commented Jul 17, 2024

Consider adding a style guide for YAML files.

Google has a YAML formatter with a certain set of default rules , which I assume expresses the style guide...

https://github.com/google/yamlfmt/blob/main/docs/config-file.md

@vapier
Copy link
Member

vapier commented Dec 3, 2024

we don't have a style guide. that formatter is the only thing we have. and even its README is clear:

This tool is not yet officially supported by Google. It is currently maintained solely by @braydonk, and unless something changes primarily in spare time.

@braydonk
Copy link

braydonk commented Dec 3, 2024

Yes, to be clear the yamlfmt project doesn't make any attempt to lay out an opinionated style. The formatting is done by round-trip-ing yaml through a particular yaml parser in Go, so the default is just however that library decides to format it on output. It wasn't thought out in any way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants