Add xmlSelfClosingTags option to disable auto-self-closing empty elements#993
Open
fuleinist wants to merge 1 commit intoprettier:mainfrom
Open
Add xmlSelfClosingTags option to disable auto-self-closing empty elements#993fuleinist wants to merge 1 commit intoprettier:mainfrom
fuleinist wants to merge 1 commit intoprettier:mainfrom
Conversation
…ents Adds a new option xmlSelfClosingTags (default: true) that controls whether empty elements are rendered as <tag/> or <tag></tag>. When set to false, empty elements preserve explicit open/close tags, which is useful for Salesforce metadata and other XML formats where self-closing syntax causes unwanted VCS diffs. Fixes: prettier#793
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new option
xmlSelfClosingTags(default:true) that controls whether empty elements are rendered as<tag/>or<tag></tag>.Problem
Some XML formats (notably Salesforce metadata) should not use self-closing syntax:
But prettier-plugin-xml currently auto-converts this to:
<searchLayouts />This causes unnecessary VCS diffs and clutter in IDEs until commits are cleaned with Husky.
Solution
When
xmlSelfClosingTags: false, empty elements preserve explicit open/close tags:Usage
{ "xmlSelfClosingTags": false }Or via CLI:
--xml-self-closing-tags=falseImplementation
xmlSelfClosingTagsoption inplugin.jswith defaulttrueprinter.jsto check this option when rendering empty elementsFixes: #793