prettier-plugin-xml-msword

Prettier for XML

This repository is the fork of the @prettier/plugin-xml. This formatter has been made to be compatible with MS Office XML files (that is being stored inside docx, xlsx, etc.)

Getting started

To run prettier with the XML plugin, you're going to need node.

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

npm install --save-dev prettier prettier-plugin-xml-msword

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

yarn add --dev prettier prettier-plugin-xml-msword

The prettier executable is now installed and ready for use:

./node_modules/.bin/prettier --plugin=prettier-plugin-xml-msword --write '**/*.xml'

Configuration

Below are the options (from 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)
printWidth	--print-width	80	Same as in Prettier (see prettier docs).
singleAttributePerLine	--single-attribute-per-line	false	Same as in Prettier (see prettier docs)
tabWidth	--tab-width	2	Same as in Prettier (see prettier docs).
xmlSelfClosingSpace	--xml-self-closing-space	true	Adds a space before self-closing tags.
xmlExpandSelfClosingTags	--xml-expand-self-closing-tags	false	Expands empty tags (instead of making them self-closed).
xmlWhitespaceSensitivity	--xml-whitespace-sensitivity	"strict"	Options are "strict" and "ignore". You may want "ignore", see below.
xmlQuoteAttributes	--xml-quote-attributes	"preserve"	Options are "preserve", "single", and "double"
xmlSortAttributesByKey	--xml-sort-attributes-by-key	false	Orders XML attributes by key alphabetically while prioritizing xmlns attributes.

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 --plugin=prettier-plugin-xml-msword --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 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:

<foo>
  <!-- prettier-ignore-start -->
    <this-content-will-not-be-formatted     />
  <!-- prettier-ignore-end -->
</foo>

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.