Prettier for XML
prettier-plugin-xml
is a prettier plugin for XML. prettier
is an opinionated code formatter that supports multiple languages and integrates with most editors. The idea is to eliminate discussions of style in code review and allow developers to get back to thinking about code design instead.
Getting started
To run prettier
with the XML plugin, you're going to need node
(version 8.3
or newer).
If you're using the npm
CLI, then add the plugin by:
npm install --save-dev prettier prettier-plugin-xml
Or if you're using yarn
, then add the plugin by:
yarn add --dev prettier prettier-plugin-xml
The prettier
executable is now installed and ready for use:
./node_modules/.bin/prettier --write '**/*.xml'
Configuration
Below are the options (from src/plugin.js
) that prettier-plugin-xml
currently supports:
Name | Default | Description |
---|---|---|
printWidth |
80 |
Same as in Prettier (see prettier docs). |
tabWidth |
2 |
Same as in Prettier (see prettier docs). |
xmlSelfClosingTags |
true |
Whether or not to allow self closing XML tags. |
Any of these can be added to your existing prettier configuration file. For example:
Or, they can be passed to prettier
as arguments:
prettier --xml-self-closing-tags false --write '**/*.xml'
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/prettier-plugin-xml.
License
The package is available as open source under the terms of the MIT License.