YAML plugin for Prettier

[!NOTE] 🤖 Developed with AI assistance.

Yet another YAML plugin for Prettier. This exists because I got so attached to the way JetBrains IDEs format YAML that I couldn't bear to look at anything else. Indented sequence values? No fucking thanks. I've really only implemented enough to get the formatting I want, and when I say "I've," I mean I asked Copilot to do it. This is mostly vibe-coded. It's a YAML formatter that runs before committing, so the stakes are low. It does what I want it to.

Getting started

Installation and usage

npm install --save-dev prettier @unfunco/prettier-plugin-yaml

Usage

Add the plugin to your Prettier configuration file and configure the options as desired if they differ from the defaults.

{
  "plugins": ["@unfunco/prettier-plugin-yaml"],
  "yamlIndentSequenceValue": false,
  "yamlSpacesWithinBraces": true,
  "yamlSpacesWithinBrackets": true
}

| JetBrains EditorConfig property | Prettier plugin | Default | | -------------------------------------------: | :------------------------: | :-----: | | ij_yaml_align_values_properties | TODO | TODO | | ij_yaml_autoinsert_sequence_marker | TODO | TODO | | ij_yaml_block_mapping_on_new_line | TODO | TODO | | ij_yaml_indent_sequence_value | yamlIndentSequenceValue | false | | ij_yaml_indent_size | TODO | TODO | | ij_yaml_keep_indents_on_empty_lines | TODO | TODO | | ij_yaml_keep_line_breaks | TODO | TODO | | ij_yaml_line_comment_add_space | TODO | TODO | | ij_yaml_line_comment_add_space_on_reformat | TODO | TODO | | ij_yaml_line_comment_at_first_column | TODO | TODO | | ij_yaml_sequence_on_new_line | TODO | TODO | | ij_yaml_space_before_colon | TODO | TODO | | ij_yaml_spaces_within_braces | yamlSpacesWithinBraces | true | | ij_yaml_spaces_within_brackets | yamlSpacesWithinBrackets | true |

License

© 2023 Daniel Morris
Made available under the terms of the MIT License.