"format selection" changing entire document

[jamesford42]

See original post (inappropriately), in the vscode repository.
microsoft/vscode#241129

TLDR; copypasta for your reading pleasure!

With an xml document open i drag select some lines of it and ctrl-k,ctrl-f or using context menu "format selection". Normally this does in fact just format the selection. However, very very frequently I end up in a state where instead it formats the entire document.

I just tracked down the cause, or at least how to reproduce it, and its super dumb. So, If you drag select exactly and only the xml element you want formatted it seems to only format that. If you have even a single line of whitespace above or below it, it formats the entire document. This also means, you cannot drag select and reformat two consecutive elements separated by whitespace, since the whitespace between them makes it think (apparently) that you want to format the entire root node ...

Actually its even worse than that. If you have even a single space character selected before the start of the element, or after it, the same occurs. So .. you paste in something and it has incorrect tabs/indents, typical issue to have. You cannot drag select the lines and reformat them. You have to drag select exactly from the elements open tag to close tag.

[datho7561]

Could you please provide an XML document that reproduces the problem? I've been trying with this document:

<?xml version="1.0" encoding="UTF-8"?>
<root>
<tag>
<AAA><BBB><CCC></CCC></BBB></AAA>




<AAA><BBB><CCC></CCC></BBB></AAA>
</tag>
</root>

I've been invoking range formatting from the > after the <tag> to the end of the second </AAA>.

and it seems to be working as expected:

<?xml version="1.0" encoding="UTF-8"?>
<root>
<tag>
        <AAA>
            <BBB>
                <CCC></CCC>
            </BBB>
        </AAA>


        <AAA>
            <BBB>
                <CCC></CCC>
            </BBB>
        </AAA>
</tag>
</root>

[jamesford42]

Select the bottom one only, plus one line of whitespace above it. I expect them youll see the top block also get formatted

…

On Tue, Apr 8, 2025, 2:00 PM David Thompson ***@***.***> wrote: Could you please provide an XML document that reproduces the problem? I've been trying with this document: <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA><BBB><CCC></CCC></BBB></AAA> <AAA><BBB><CCC></CCC></BBB></AAA> </tag> </root> I've been invoking range formatting from the > after the <tag> to the end of the second </AAA>. and it seems to be working as expected: <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA> <BBB> <CCC></CCC> </BBB> </AAA> <AAA> <BBB> <CCC></CCC> </BBB> </AAA> </tag> </root> — Reply to this email directly, view it on GitHub <#1059 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABGAKEUR2NCTGHT4KCKRDL2YQMFDAVCNFSM6AAAAABYCZ6ORSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOOBXGQYDMMRYGM> . You are receiving this because you authored the thread.Message ID: ***@***.***> *datho7561* left a comment (redhat-developer/vscode-xml#1059) <#1059 (comment)> Could you please provide an XML document that reproduces the problem? I've been trying with this document: <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA><BBB><CCC></CCC></BBB></AAA> <AAA><BBB><CCC></CCC></BBB></AAA> </tag> </root> I've been invoking range formatting from the > after the <tag> to the end of the second </AAA>. and it seems to be working as expected: <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA> <BBB> <CCC></CCC> </BBB> </AAA> <AAA> <BBB> <CCC></CCC> </BBB> </AAA> </tag> </root> — Reply to this email directly, view it on GitHub <#1059 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABGAKEUR2NCTGHT4KCKRDL2YQMFDAVCNFSM6AAAAABYCZ6ORSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOOBXGQYDMMRYGM> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[datho7561]

Like this (with the region between the | selected)?

<?xml version="1.0" encoding="UTF-8"?>
<root>
<tag>
<AAA><BBB><CCC></CCC></BBB></AAA>
|



<AAA><BBB><CCC></CCC></BBB></AAA>|
</tag>
</root>

That gives me this:

<?xml version="1.0" encoding="UTF-8"?>
<root>
<tag>
<AAA><BBB><CCC></CCC></BBB></AAA>


        <AAA>
            <BBB>
                <CCC></CCC>
            </BBB>
        </AAA>
</tag>
</root>

[jamesford42]

Look like ill need to send you my exact setting and a document then. The big thing missing i see is no use of attributes. Ill get you something, back soon..

…

On Tue, Apr 8, 2025, 4:02 PM David Thompson ***@***.***> wrote: Like this (with the region between the | selected)? <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA><BBB><CCC></CCC></BBB></AAA> | <AAA><BBB><CCC></CCC></BBB></AAA>| </tag> </root> That gives me this: <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA><BBB><CCC></CCC></BBB></AAA> <AAA> <BBB> <CCC></CCC> </BBB> </AAA> </tag> </root> — Reply to this email directly, view it on GitHub <#1059 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABGAKGYBJWPS6FGWUS57XL2YQ2QDAVCNFSM6AAAAABYCZ6ORSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOOBXGY2TMMJVGA> . You are receiving this because you authored the thread.Message ID: ***@***.***> *datho7561* left a comment (redhat-developer/vscode-xml#1059) <#1059 (comment)> Like this (with the region between the | selected)? <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA><BBB><CCC></CCC></BBB></AAA> | <AAA><BBB><CCC></CCC></BBB></AAA>| </tag> </root> That gives me this: <?xml version="1.0" encoding="UTF-8"?> <root> <tag> <AAA><BBB><CCC></CCC></BBB></AAA> <AAA> <BBB> <CCC></CCC> </BBB> </AAA> </tag> </root> — Reply to this email directly, view it on GitHub <#1059 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABGAKGYBJWPS6FGWUS57XL2YQ2QDAVCNFSM6AAAAABYCZ6ORSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOOBXGY2TMMJVGA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[jamesford42]

Here is an xml document for you.

<?xml version="1.0" encoding="utf-8"?>
<root>
	<range name="None" display_name="None" range="0" />
	<range name="AlmostNone" display_name="Almost None" range="300" is_melee="true" />
	<range name="AlmostNone2" display_name="Almost None" range="500" is_melee="true" />
	<range name="VeryTiny1" display_name="VeryTiny1" range="1000" />
	<range name="VeryTiny2" display_name="VeryTiny2" range="1125" />
	<range name="VeryTiny3" display_name="VeryTiny3" range="1250" />
	<range name="VeryTiny4" display_name="VeryTiny4" range="1500" />
	<range name="Tiny1" display_name="Tiny1" range="1700" />
  <range name="Tiny2" display_name="Tiny2" range="2000" />
  <range name="Tiny3" display_name="Tiny3" range="2500" />
  <range name="Tiny4" display_name="Tiny4" range="2800" />
  <range name="Small1" display_name="Small1" range="3200" />
  <range name="Small2" display_name="Small2" range="3500" />
  <range name="Small3" display_name="Small3" range="3800" />
  <range name="Small4" display_name="Small4" range="4000" />
  <range name="Small5" display_name="Small5" range="4200" />
  <range name="Normal1" display_name="Normal1" range="5000" />
  <range name="Normal2" display_name="Normal2" range="5200" />
  <range name="Normal3" display_name="Normal3" range="5600" />
  <range name="Normal4" display_name="Normal4" range="6000" />
  <range name="Normal5" display_name="Normal5" range="6500" />
  <range name="Normal6" display_name="Normal6" range="7100" />
  <range name="AboveAverage1" display_name="AboveAverage1" range="8000" />
  <range name="AboveAverage2" display_name="AboveAverage2" range="9000" />
  <range name="AboveAverage3" display_name="AboveAverage3" range="10100" />
  <range name="AboveAverage4" display_name="AboveAverage4" range="12000" />
  <range name="AboveAverage5" display_name="AboveAverage5" range="14000" />
  <range name="High1" display_name="High1" range="15000" />
  <range name="High2" display_name="High2" range="18000" />
  <range name="High3" display_name="High3" range="24000" />
  <range name="ExtremelyHigh" display_name="ExtremelyHigh" range="30000" />
  <range name="IncrediblyHigh" display_name="IncrediblyHigh" range="40000" />
  <range name="InsanelyHigh" display_name="InsanelyHigh" range="124000" />
  <range name="Planetary" display_name="Planetary" range="600000" />
  <range name="EssentiallyInfinite" display_name="EssentiallyInfinite" range="9990999" is_sniper="true" />
</root>

Note the inconsistent use of space vs tab characters (not that its significant, other than for my instructions). Select these.

Ctrl-k, Ctrl-f

: The whole document is reformated.

And here are my user settings exported from vscode.

[datho7561]

If I enable (as you did):

"xml.format.splitAttributes": "splitNewLine"

then I can reproduce the bug.

@angelozerr what do you think about holding off on the release to fix this? I think it's worth doing the bugfix release, then investigating this after, because I think this issue will get complicated.

[datho7561]

Root cause: we weren't handling range formatting for self-closing elements (eg. <range name="aaa" range="9001"/> instead of <range name="aaa" range="9001"></range>) properly.