@prettier/plugin-xml

    1.0.2 • Public • Published

    Prettier for XML

    Gitter GitHub Actions 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.

    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:

    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).
    tabWidth --tab-width 2 Same as in Prettier (see prettier docs).
    xmlWhitespaceSensitivity --xml-whitespace-sensitivity "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'

    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.

    Keywords

    none

    Install

    npm i @prettier/plugin-xml

    DownloadsWeekly Downloads

    52,462

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    36.6 kB

    Total Files

    12

    Last publish

    Collaborators

    • suchipi
    • mgrip
    • czosel
    • patrick91
    • zimme
    • azz
    • vjeux
    • evilebottnawi
    • kddeisz
    • shinigami92
    • j-f
    • lydell