Skip to content

Add xml.format.mixedContent and xml.format.blockElements settings #1868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
datho7561 merged 1 commit into from
Oct 7, 2026
Merged

Add xml.format.mixedContent and xml.format.blockElements settings #1868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...ipse.lemminx/src/main/java/org/eclipse/lemminx/services/format/DOMAttributeFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,17 @@ public void formatAttribute(DOMAttr attr, int prevOffset, boolean singleAttribut
if (isPreserveAttributeLineBreaks() && hasLineBreak(prevOffset, attr.getStart())) {
replaceLeftSpacesWithIndentation(indentLevel + 1, prevOffset, attr.getStart(), true, edits);
alreadyIndented = true;
parentConstraints.setStartTagCrossedLine(true);
} else if (getSplitAttributes() == SplitAttributes.splitNewLine && !singleAttribute) {
replaceLeftSpacesWithIndentation(indentLevel + getSplitAttributesIndentSize(), prevOffset,
attr.getStart(), true, edits);
alreadyIndented = true;
parentConstraints.setStartTagCrossedLine(true);
} else if (getSplitAttributes() == SplitAttributes.alignWithFirstAttr && !isFirstAttr) {
replaceLeftSpacesWithIndentationWithOffsetSpaces(getFirstAttrOffset(attr.getOwnerElement(), indentLevel), prevOffset,
attr.getStart(), edits);
alreadyIndented = true;
parentConstraints.setStartTagCrossedLine(true);
}
}

Expand Down Expand Up @@ -168,6 +171,7 @@ public void formatAttribute(DOMAttr attr, int prevOffset, boolean singleAttribut
if (isMaxLineWidthSupported() && parentConstraints.getAvailableLineWidth() < 0
&& getSplitAttributes() == SplitAttributes.preserve) {
replaceLeftSpacesWithIndentation(indentLevel + 1, from, to, true, edits);
parentConstraints.setStartTagCrossedLine(true);
int attrValuelength = attr.getValue() != null ? attr.getValue().length() : 0;
parentConstraints.setAvailableLineWidth(
getMaxLineWidth() - getTabSize() * (indentLevel + 1) - attributeNamelength
Expand Down
125 changes: 114 additions & 11 deletions ...clipse.lemminx/src/main/java/org/eclipse/lemminx/services/format/DOMElementFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,16 @@ public void formatElement(DOMElement element, XMLFormattingConstraints parentCon
EmptyElements emptyElements = getEmptyElements(element, formatElementCategory);

int indentLevel = parentConstraints.getIndentLevel();
parentConstraints.setStartTagCrossedLine(false);
int width = formatStartTagElement(element, parentConstraints, emptyElements, start, end, edits);
parentConstraints.setAvailableLineWidth(parentConstraints.getAvailableLineWidth() - width);

// Track indent level for text nodes in mixed content so they
// can be indented consistently with their parent element.
if (parentConstraints.getMixedContentIndentLevel() == 0
&& parentConstraints.getFormatElementCategory() == FormatElementCategory.MixedContent) {
&& (parentConstraints.getFormatElementCategory() == FormatElementCategory.MixedContent
|| (parentConstraints.getFormatElementCategory() == FormatElementCategory.IgnoreSpace
&& formatterDocument.isMixedContentReflow()))) {
parentConstraints.setMixedContentIndentLevel(indentLevel);
}

Expand All @@ -131,6 +134,17 @@ public void formatElement(DOMElement element, XMLFormattingConstraints parentCon
constraints.setIndentLevel(indentLevel + 1);
}
constraints.setFormatElementCategory(formatElementCategory);
// Per-element flags, not inherited from parent.
constraints.setWrapAllChildren(false);
constraints.setSoftWrapped(false);
constraints.setStartTagCrossedLine(parentConstraints.isStartTagCrossedLine());
parentConstraints.setStartTagCrossedLine(false);

// expand mode: force all MixedContent children to block layout.
if (formatElementCategory == FormatElementCategory.MixedContent
&& formatterDocument.isMixedContentExpand()) {
constraints.setWrapAllChildren(true);
}

formatChildren(element, constraints, start, end, edits);

Expand Down Expand Up @@ -184,12 +198,52 @@ private int formatStartTagElement(DOMElement element, XMLFormattingConstraints p
break;

case MixedContent: {
// Phase 1: overflow handling (#1797, #1131)
// Move overflowing elements to new lines when maxLineWidth is enabled.
// Block/inline distinction only in reflow or expand mode.
// In normalize mode (default), all elements stay inline — backward compatible.
//
// Use case (reflow + blockElements=["div"]):
// <p>text <div>details</div> <b>bold</b></p>
// → <div> is block (in blockElements) → own line
// → <b> is not block → stays on same line as text
//
// Use case (expand): all children get own line regardless of blockElements.
//
// Use case (normalize + blockElements=["div"]):
// <p>text <div>details</div></p>
// → blockElements ignored in normalize mode, all elements stay inline
if (formatterDocument.isMixedContentReflow()
&& (isBlockElement(element) || parentConstraints.isWrapAllChildren())) {
int parentContentStart = getParentContentStartOffset(element);
int replaced = replaceLeftSpacesWithIndentation(indentLevel, parentContentStart,
startTagOpenOffset, true, true, edits);
if (replaced == 0) {
insertIndentation(indentLevel, startTagOpenOffset, edits);
}
resetLineWidth(parentConstraints, indentLevel);
parentConstraints.setSoftWrapped(true);
break;
}
// Inline element in mixed content — stay inline with surrounding text.
// Soft-wrap: move to new line when the full element doesn't fit on
// the current line. Unlike expand mode, only overflowing elements move.
// Use case: <p>text <b>here</b> more <b>bold</b></p> with maxLineWidth=40
// → <b>bold</b> wraps to next line only if it overflows.
boolean moved = false;
if (isMaxLineWidthSupported()) {
int parentContentStart = getParentContentStartOffset(element);
if (shouldMoveOverflowingMixedContentElement(element, parentConstraints,
if (formatterDocument.isMixedContentReflow()) {
int fullElementWidth = element.getEnd() - element.getStart();
if (parentConstraints.getAvailableLineWidth() - fullElementWidth < 0) {
int replaced = replaceLeftSpacesWithIndentation(indentLevel, parentContentStart,
startTagOpenOffset, true, true, edits);
if (replaced == 0) {
insertIndentation(indentLevel, startTagOpenOffset, edits);
}
resetLineWidth(parentConstraints, indentLevel);
parentConstraints.setSoftWrapped(true);
moved = true;
}
} else if (shouldMoveOverflowingMixedContentElement(element, parentConstraints,
width, parentContentStart, startTagOpenOffset)) {
int replaced = replaceLeftSpacesWithIndentation(indentLevel, parentContentStart,
startTagOpenOffset, true, true, edits);
Expand Down Expand Up @@ -554,17 +608,36 @@ private int formatEndTagElement(DOMElement element, XMLFormattingConstraints par
width += indentLevel * getTabSize();
}
break;
case MixedContent:
// Use case: <p>text <b>bold</b> </p>
// When the last child is an element or comment (not text), normalize
// trailing whitespace before the end tag to proper indentation.
// Text-last: <p>text</p> — end tag stays inline (no indentation).
if (hasTrailingWhitespaceAfterElementOrComment(element, endTagOpenOffset)) {
case MixedContent: {
DOMNode lastContent = getLastNonWhitespaceChild(element);
boolean lastIsBlock = formatterDocument.isMixedContentReflow()
&& lastContent != null && lastContent.isElement()
&& isBlockElement((DOMElement) lastContent);
if (lastIsBlock || constraints.isWrapAllChildren()
|| constraints.isSoftWrapped()
|| constraints.isStartTagCrossedLine()) {
// End tag on own line when:
// - last child is block: <p>text <div>x</div></p> → </p> on own line
// - expand mode: <p>\n text\n <b>bold</b>\n</p>
// - soft-wrap occurred: content wrapped due to maxLineWidth overflow
boolean endTagAfterNewline = isEndTagDirectlyAfterNewline(endTagOpenOffset, startTagCloseOffset);
boolean joinWillRemoveNewline = endTagAfterNewline
&& formatterDocument.getSharedSettings().getFormattingSettings().isJoinContentLines();
if (!endTagAfterNewline || joinWillRemoveNewline) {
int replaced = replaceLeftSpacesWithIndentation(indentLevel,
startTagCloseOffset, endTagOpenOffset, true, true, edits);
if (replaced == 0) {
insertIndentation(indentLevel, endTagOpenOffset, edits);
}
}
width += indentLevel * getTabSize();
} else if (hasTrailingWhitespaceAfterElementOrComment(element, endTagOpenOffset)) {
replaceLeftSpacesWithIndentationPreservedNewLines(startTagCloseOffset, endTagOpenOffset,
indentLevel, edits);
width += indentLevel * getTabSize();
}
break;
}
case IgnoreSpace:
// Use case: <root> <child/> </root> → <root>\n <child />\n</root>
// End tag always gets indented on its own line.
Expand All @@ -573,7 +646,15 @@ private int formatEndTagElement(DOMElement element, XMLFormattingConstraints par
width += indentLevel * getTabSize();
break;
case NormalizeSpace:
// Text-only element — end tag stays inline after the text content.
if (constraints.isSoftWrapped()
|| (constraints.isStartTagCrossedLine() && !element.isEmpty())) {
int replaced = replaceLeftSpacesWithIndentation(indentLevel,
startTagCloseOffset, endTagOpenOffset, true, true, edits);
if (replaced == 0) {
insertIndentation(indentLevel, endTagOpenOffset, edits);
}
width += indentLevel * getTabSize();
}
break;
}
// Remove extra spaces before the closing '>'
Expand Down Expand Up @@ -601,6 +682,23 @@ private boolean isEndTagDirectlyAfterNewline(int endTagOpenOffset, int startTagC
return c == '\n' || c == '\r';
}

/**
* Returns the last child that is not a whitespace-only text node,
* or {@code null} if no such child exists.
*
* <p>Use case: {@code <p><div>block</div> </p>} — skips trailing whitespace
* text, returns {@code <div>}.</p>
*/
private DOMNode getLastNonWhitespaceChild(DOMElement element) {
DOMNode child = element.getLastChild();
while (child != null && child.isText()
&& StringUtils.isWhitespace(formatterDocument.getTextSequence(),
child.getStart(), child.getEnd())) {
child = child.getPreviousSibling();
}
return child;
}

/**
* Returns {@code true} if the element's last child is an element or comment
* AND there is trailing whitespace before the end tag.
Expand Down Expand Up @@ -778,6 +876,11 @@ private boolean shouldCollapseEmptyElement(DOMElement element, SharedSettings se
return formatterDocument.shouldCollapseEmptyElement(element, settings);
}

/** Delegates to {@link XMLFormatterDocument#isBlockElement}. */
private boolean isBlockElement(DOMElement element) {
return formatterDocument.isBlockElement(element);
}

/** Returns the configured maximum line width, or 0 if disabled. */
private int getMaxLineWidth() {
return formatterDocument.getMaxLineWidth();
Expand Down
Loading
Loading