Reformat yaml #2124
Reformat yaml #2124
Conversation
Using an extension isn't great for portability, but afaict the extension uses the same formatter as prettier under the hood - so we could use that: |
|
An alternative is to use #2130 (google's yamlfmt) |
| @@ -1,4 +1,4 @@ | |||
| {{- $keycloakHost := printf "authentication-%s" .Values.host }} | |||
| { { - $keycloakHost := printf "authentication-%s" .Values.host } } | |||
There was a problem hiding this comment.
this breaks the config by adding a space between the paranthesis - I can't figure out how to stop it
There was a problem hiding this comment.
Ah that probably means we shouldn't use it
There might not be a way to fix/configure it - other than adding the folder to ignore files (which would be ok, this is not proper yaml anyways, it's a superset with templating specific grammar)
There was a problem hiding this comment.
Yep, it doesn't break it because it aborts due to syntax error
$ yamlfmt kubernetes/loculus/templates/keycloak-config-map.yaml
encountered the following formatting errors:
kubernetes/loculus/templates/keycloak-config-map.yaml: yaml: did not find expected node content
There was a problem hiding this comment.
In VSCode, it also doesn't format it, because I have the kubernetes extension installed which recognizes this file as a helm template (as opposed to yaml) and hence doesn't format with the yaml language formatter
There was a problem hiding this comment.
Ah awesome! sorry I missed this and basically added this same comment thread to #2130
|
Closing this as #2130 does a better job at handling helm templates - thanks @corneliusroemer for looking into this! |
### Summary - Add yamlfmt config to root - Recommend yamlfmt vscode extension This formatter with current config doesn't wrap long lines, which saves us a lot of lines. Install formatter with homebrew or: ``` go install github.com/google/yamlfmt/cmd/yamlfmt@latest ``` Blog writeup on the formatter: https://til.simonwillison.net/yaml/yamlfmt Alternative to #2124
Summary
This uses https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml to format all yaml files consistently.