@prettier/plugin-xml
Advanced tools
@prettier/plugin-xml is a plugin for Prettier that allows you to format XML files. It integrates seamlessly with Prettier, enabling you to maintain consistent formatting across your XML documents.
Format XML
This feature allows you to format XML files to ensure they are properly indented and easy to read. The plugin will automatically adjust the spacing and indentation to match Prettier's configuration.
<note>
<to>Tove</to>
<from>Jani</from>
<heading>Reminder</heading>
<body>Don't forget me this weekend!</body>
</note>Integration with Prettier
This feature demonstrates how to integrate the XML plugin with Prettier. By adding the plugin to your Prettier configuration, you can ensure that XML files are formatted according to the same rules as your other code.
module.exports = {
plugins: [require('@prettier/plugin-xml')],
xmlWhitespaceSensitivity: 'ignore'
};xml-formatter is a standalone library for formatting XML files. Unlike @prettier/plugin-xml, it does not integrate with Prettier but can be used independently to format XML strings or files.
pretty-data is a package that provides functions to pretty-print XML, JSON, and CSS data. It offers more versatility in terms of data types but does not integrate with Prettier like @prettier/plugin-xml.
xml-beautifier is another standalone XML formatter. It focuses solely on XML and provides a simple API for beautifying XML strings. It lacks the integration with Prettier that @prettier/plugin-xml offers.
@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.
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'
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). |
xmlSelfClosingSpace | true | Adds a space before self-closing tags. |
xmlWhitespaceSensitivity | "strict" | How to handle whitespaces. Options are "strict" and "ignore". |
Any of these can be added to your existing prettier configuration file. For example:
{
"tabWidth": 4
}
Or, they can be passed to prettier as arguments:
prettier --tab-width 4 --write '**/*.xml'
Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-xml.
The package is available as open source under the terms of the MIT License.
[0.6.0] - 2020-01-27
xmlWhitespaceSensitivity option, with current valid values of "strict" and "ignore". "strict" behavior maintains the current behavior, while "ignore" allows the plugin more freedom in where to place nodes.FAQs
prettier plugin for XML
The npm package @prettier/plugin-xml receives a total of 130,423 weekly downloads. As such, @prettier/plugin-xml popularity was classified as popular.
We found that @prettier/plugin-xml demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 14 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.