# prettier-plugin-xml

> prettier plugin for XML

Latest version **0.1.0** (published 2019-11-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install prettier-plugin-xml
pnpm add prettier-plugin-xml
yarn add prettier-plugin-xml
bun add prettier-plugin-xml
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-11-12 |
| First published | 2019-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 14 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 276 |
| Author | Kevin Deisz |
| Maintainers | kddeisz |

## Links

- npm: https://www.npmjs.com/package/prettier-plugin-xml
- Repository: https://github.com/kddeisz/prettier-plugin-xml
- Homepage: https://github.com/kddeisz/prettier-plugin-xml#readme
- Issues: https://github.com/kddeisz/prettier-plugin-xml/issues
- npm.io page: https://npm.io/package/prettier-plugin-xml

## Dependencies (2)

- [prettier](https://npm.io/package/prettier.md) >=1.10
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) ^3.14.0

## Recent versions

- 0.1.0 (latest) — 2019-11-12

## README

<h1 align="center">Prettier for XML</h1>

<p align="center">
  <a href="https://gitter.im/jlongster/prettier">
    <img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
  </a>
  <a href="https://www.npmjs.com/package/prettier-plugin-xml">
    <img alt="NPM Version" src="https://img.shields.io/npm/v/prettier-plugin-xml.svg?style=flat-square">
  </a>
  <a href="#badge">
    <img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square">
  </a>
  <a href="https://twitter.com/PrettierCode">
    <img alt="Follow+Prettier+on+Twitter" src="https://img.shields.io/twitter/follow/prettiercode.svg?label=follow+prettier&style=flat-square">
  </a>
</p>

`prettier-plugin-xml` is a [prettier](https://prettier.io/) 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`](https://nodejs.org/en/download/) (version `8.3` or newer).

If you're using the `npm` CLI, then add the plugin by:

```bash
npm install --save-dev prettier prettier-plugin-xml
```

Or if you're using `yarn`, then add the plugin by:

```bash
yarn add --dev prettier prettier-plugin-xml
```

The `prettier` executable is now installed and ready for use:

```bash
./node_modules/.bin/prettier --write '**/*.xml'
```

## Configuration

Below are the options (from [`src/plugin.js`](src/plugin.js)) that `prettier-plugin-xml` currently supports:

| Name                 | Default | Description                                                                                      |
| -------------------- | :-----: | ------------------------------------------------------------------------------------------------ |
| `printWidth`         |  `80`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)). |
| `tabWidth`           |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).   |
| `xmlSelfClosingTags` | `true`  | Whether or not to allow self closing XML tags.                                                   |

Any of these can be added to your existing [prettier configuration
file](https://prettier.io/docs/en/configuration.html). For example:

```json
{
  "xmlSelfClosingTags": false
}
```

Or, they can be passed to `prettier` as arguments:

```bash
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](https://opensource.org/licenses/MIT).

---
_Source: https://npm.io/package/prettier-plugin-xml · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
