Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prettier/plugin-xml
Prettier XML plugin
https://github.com/prettier/plugin-xml
prettier xml
Last synced: about 2 months ago
JSON representation
Prettier XML plugin
- Host: GitHub
- URL: https://github.com/prettier/plugin-xml
- Owner: prettier
- License: mit
- Created: 2019-11-12T20:04:06.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T01:04:30.000Z (5 months ago)
- Last Synced: 2024-04-14T21:54:26.101Z (5 months ago)
- Topics: prettier, xml
- Language: JavaScript
- Homepage:
- Size: 2.75 MB
- Stars: 218
- Watchers: 7
- Forks: 33
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Prettier for XML
`@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/).
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 --plugin=@prettier/plugin-xml --write '**/*.xml'
```
## Configuration
Below are the options (from [`src/plugin.js`](src/plugin.js)) that `@prettier/plugin-xml` currently supports:
| API Option | CLI Option | Default | Description |
| -------------------------- | ------------------------------ | :----------: | ------------------------------------------------------------------------------------------------------------------------ |
| `bracketSameLine` | `--bracket-same-line` | `true` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#bracket-line)) |
| `printWidth` | `--print-width` | `80` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)). |
| `singleAttributePerLine` | `--single-attribute-per-line` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#single-attribute-per-line)) |
| `tabWidth` | `--tab-width` | `2` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)). |
| `xmlQuoteAttributes` | `--xml-quote-attributes` | `"preserve"` | Options are `"preserve"`, `"single"`, and `"double"` |
| `xmlSelfClosingSpace` | `--xml-self-closing-space` | `true` | Adds a space before self-closing tags. |
| `xmlSortAttributesByKey` | `--xml-sort-attributes-by-key` | `false` | Orders XML attributes by key alphabetically while prioritizing xmlns attributes. |
| `xmlWhitespaceSensitivity` | `--xml-whitespace-sensitivity` | `"strict"` | Options are `"strict"`, `"preserve"`, and `"ignore"`. You may want `"ignore"` or `"preserve"`, [see below](#whitespace). |
Any of these can be added to your existing [prettier configuration
file](https://prettier.io/docs/en/configuration.html). For example:
```json
{
"tabWidth": 4
}
```
Or, they can be passed to `prettier` as arguments:
```bash
prettier --plugin=@prettier/plugin-xml --tab-width 4 --write '**/*.xml'
```
### Whitespace
In XML, by default, all whitespace inside elements has semantic meaning. For prettier to maintain its contract of not changing the semantic meaning of your program, this means the default for `xmlWhitespaceSensitivity` is `"strict"`. When running in this mode, prettier's ability to rearrange your markup is somewhat limited, as it has to maintain the exact amount of whitespace that you input within elements.
If you're sure that the XML files that you're formatting do not require whitespace sensitivity, you can use the `"ignore"` option, as this will produce a standardized amount of whitespace. This will fix any indentation issues, and collapse excess blank lines (max of 1 blank line). For most folks most of the time, this is probably the option that you want.
You can also use the `"preserve"` option, if you want to preserve the whitespace of text nodes within XML elements and attributes. See [#478](https://github.com/prettier/plugin-xml/issues/478) for more detail.
### Ignore ranges
You can use two special comments to get prettier to ignore formatting a specific piece of the document, as in the following example:
```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](https://opensource.org/licenses/MIT).