prettier-plugin-yaml weekly downloads statistics

prettier-plugin-yaml

Additional YAML formatting options for Prettier.

Install

Usage

Reference prettier-plugin-yaml in your Prettier config:

If you’re using any other YAML plugins, make sure prettier-plugin-yaml is listed last.

Options

In addition to Prettier’s built-in options that affect YAML formatting, prettier-plugin-yaml offers additional configuration options.

FAQ

How do I automatically quote integer values?

Use yamlQuoteValuesMatching. Unlike yamlQuoteValues, which only applies to string values, it matches values based on their string representation. For example, to quote integers:

You can quote boolean and null values similarly:

To quote mapping keys, use yamlQuoteKeys and yamlQuoteKeysMatching.

Why is the pattern a string instead of a regular expression?

yamlQuoteValuesMatching and yamlQuoteKeysMatching accept strings due to a limitation in how Prettier handles configuration values. RegExp is not a supported type, so the pattern must be provided as a string.

Internally, the plugin applies the pattern as new RegExp(pattern). Remember to escape backslashes and other special characters accordingly.

Related

• @standard-config/prettier • prettier-plugin-expand-json • prettier-plugin-markdown-html

License

MIT © Dom Porada

Description from the npm listing.