Skip to content
Prettier XML plugin
JavaScript
Branch: master
Clone or download
kddeisz Merge pull request #16 from prettier/dependabot/npm_and_yarn/eslint-c…
…onfig-prettier-6.7.0

Bump eslint-config-prettier from 6.6.0 to 6.7.0
Latest commit d9c3494 Dec 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Fix up lint Nov 12, 2019
src Merge pull request #4 from infotexture/feature/dita Nov 13, 2019
test Support XML processing instructions Nov 13, 2019
.eslintrc.json
.gitignore Add tests for everything Nov 12, 2019
.prettierignore
.travis.yml Up the node version in travis Nov 13, 2019
CHANGELOG.md Bump to v0.3.0 Nov 14, 2019
LICENSE Add package metadata Nov 12, 2019
README.md
package.json Bump to v0.3.0 Nov 14, 2019
yarn.lock Merge pull request #16 from prettier/dependabot/npm_and_yarn/eslint-c… Dec 3, 2019

README.md

Prettier for XML

Gitter Travis NPM Version code style: prettier Follow+Prettier+on+Twitter

@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:

{
  "xmlSelfClosingTags": false
}

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/prettier/plugin-xml.

License

The package is available as open source under the terms of the MIT License.

You can’t perform that action at this time.