Working on adding xml whitespace ignore.

belav · belav · commit 7df40283a60b · 2025-12-29T15:22:26.000-06:00
diff --git a/Src/CSharpier.Core/CSharp/CSharpFormatter.cs b/Src/CSharpier.Core/CSharp/CSharpFormatter.cs
@@ -155,6 +155,7 @@ bool TryGetCompilationFailure(out CodeFormatterResult compilationResult)
                     LineEnding = lineEnding,
                     IndentSize = printerOptions.IndentSize,
                     UseTabs = printerOptions.UseTabs,
+                    XmlWhitespaceSensitivity = XmlWhitespaceSensitivity.Strict,
                 },
             };
             var document = Node.Print(rootNode, printingContext);
@@ -181,6 +182,7 @@ bool TryGetCompilationFailure(out CodeFormatterResult compilationResult)
                         LineEnding = lineEnding,
                         IndentSize = printerOptions.IndentSize,
                         UseTabs = printerOptions.UseTabs,
+                        XmlWhitespaceSensitivity = XmlWhitespaceSensitivity.Strict,
                     },
                 };
                 document = Node.Print(
diff --git a/Src/CSharpier.Core/CSharp/SyntaxPrinter/PrintingContext.cs b/Src/CSharpier.Core/CSharp/SyntaxPrinter/PrintingContext.cs
@@ -36,6 +36,7 @@ public class PrintingContextOptions
         public required string LineEnding { get; init; }
         public required int IndentSize { get; init; }
         public required bool UseTabs { get; init; }
+        public required XmlWhitespaceSensitivity XmlWhitespaceSensitivity { get; init; }
     }
 
     public class PrintingContextState
diff --git a/Src/CSharpier.Core/Xml/XNodePrinters/Attributes.cs b/Src/CSharpier.Core/Xml/XNodePrinters/Attributes.cs
@@ -42,7 +42,7 @@ public static Doc Print(RawNode rawNode, PrintingContext context)
              */
             (
                 rawNode.Nodes.Count != 0
-                && Tag.NeedsToBorrowParentOpeningTagEndMarker(rawNode.Nodes.First())
+                && Tag.NeedsToBorrowParentOpeningTagEndMarker(rawNode.Nodes.First(), context)
             ) || doNotBreakAttributes
         )
         {
diff --git a/Src/CSharpier.Core/Xml/XNodePrinters/ElementChildren.cs b/Src/CSharpier.Core/Xml/XNodePrinters/ElementChildren.cs
@@ -38,6 +38,17 @@ public static Doc Print(RawNode node, PrintingContext context)
                 ? PrintBetweenLine(childNode, childNode.NextNode)
                 : Doc.Null;
 
+            if (
+                context.Options.XmlWhitespaceSensitivity is not XmlWhitespaceSensitivity.Strict
+                && childNode.PreviousNode is null
+                && childNode.NextNode is null
+                && childNode.IsTextLike()
+            )
+            {
+                prevBetweenLine = Doc.SoftLine;
+                nextBetweenLine = Doc.SoftLine;
+            }
+
             if (prevBetweenLine is not NullDoc)
             {
                 if (prevBetweenLine is HardLine)
@@ -50,7 +61,14 @@ public static Doc Print(RawNode node, PrintingContext context)
                 }
                 else
                 {
-                    leadingParts.Add(Doc.IfBreak(Doc.Null, Doc.SoftLine, groupIds[x - 1]));
+                    if (groupIds.Count > 1)
+                    {
+                        leadingParts.Add(Doc.IfBreak(Doc.Null, Doc.SoftLine, groupIds[x - 1]));
+                    }
+                    else
+                    {
+                        leadingParts.Add(prevBetweenLine);
+                    }
                 }
             }
 
diff --git a/Src/CSharpier.Core/Xml/XNodePrinters/Node.cs b/Src/CSharpier.Core/Xml/XNodePrinters/Node.cs
@@ -40,7 +40,7 @@ internal static Doc Print(RawNode node, PrintingContext context)
         {
             List<Doc> doc =
             [
-                Tag.PrintOpeningTagPrefix(node),
+                Tag.PrintOpeningTagPrefix(node, context),
                 GetTextValue(node),
                 Tag.PrintClosingTagSuffix(node, context),
             ];
diff --git a/Src/CSharpier.Core/Xml/XNodePrinters/Tag.cs b/Src/CSharpier.Core/Xml/XNodePrinters/Tag.cs
@@ -11,7 +11,7 @@ public static Doc PrintOpeningTag(RawNode rawNode, PrintingContext context)
         return Doc.Concat(
             PrintOpeningTagStart(rawNode, context),
             Attributes.Print(rawNode, context),
-            rawNode.IsEmpty ? Doc.Null : PrintOpeningTagEnd(rawNode)
+            rawNode.IsEmpty ? Doc.Null : PrintOpeningTagEnd(rawNode, context)
         );
     }
 
@@ -22,23 +22,23 @@ rawNode.PreviousNode is not null
             && NeedsToBorrowNextOpeningTagStartMarker(rawNode.PreviousNode)
             ? Doc.Null
             : Doc.Concat(
-                PrintOpeningTagPrefix(rawNode),
+                PrintOpeningTagPrefix(rawNode, context),
                 PrintOpeningTagStartMarker(rawNode, context)
             );
     }
 
-    private static Doc PrintOpeningTagEnd(RawNode rawNode)
+    private static Doc PrintOpeningTagEnd(RawNode rawNode, PrintingContext context)
     {
         return
             rawNode.Nodes.FirstOrDefault() is { } firstNode
-            && NeedsToBorrowParentOpeningTagEndMarker(firstNode)
+            && NeedsToBorrowParentOpeningTagEndMarker(firstNode, context)
             ? Doc.Null
             : ">";
     }
 
-    public static Doc PrintOpeningTagPrefix(RawNode rawNode)
+    public static Doc PrintOpeningTagPrefix(RawNode rawNode, PrintingContext context)
     {
-        return NeedsToBorrowParentOpeningTagEndMarker(rawNode) ? ">" : "";
+        return NeedsToBorrowParentOpeningTagEndMarker(rawNode, context) ? ">" : "";
     }
 
     public static Doc PrintClosingTag(RawNode rawNode, PrintingContext context)
@@ -53,7 +53,7 @@ public static Doc PrintClosingTagStart(RawNode rawNode, PrintingContext context)
     {
         var lastChild = rawNode.Nodes.LastOrDefault();
 
-        return lastChild is not null && PrintParentClosingTagStartWithContent(lastChild)
+        return lastChild is not null && PrintParentClosingTagStartWithContent(lastChild, context)
             ? Doc.Null
             : PrintClosingTagStartMarker(rawNode, context);
     }
@@ -78,7 +78,7 @@ public static Doc PrintClosingTagEndMarker(RawNode rawNode)
 
     public static Doc PrintClosingTagSuffix(RawNode rawNode, PrintingContext context)
     {
-        return PrintParentClosingTagStartWithContent(rawNode)
+        return PrintParentClosingTagStartWithContent(rawNode, context)
                 ? PrintClosingTagStartMarker(rawNode.Parent!, context)
             : NeedsToBorrowNextOpeningTagStartMarker(rawNode)
                 ? PrintOpeningTagStartMarker(rawNode.NextNode!, context)
@@ -113,7 +113,10 @@ private static bool NeedsToBorrowNextOpeningTagStartMarker(RawNode rawNode)
         ;
     }
 
-    private static bool PrintParentClosingTagStartWithContent(RawNode rawNode)
+    private static bool PrintParentClosingTagStartWithContent(
+        RawNode rawNode,
+        PrintingContext context
+    )
     {
         /*
          *     <p>
@@ -147,7 +150,8 @@ Life is demanding.
          </Element>
 </Root>
          */
-        return rawNode.NextNode is null
+        return context.Options.XmlWhitespaceSensitivity is XmlWhitespaceSensitivity.Strict
+            && rawNode.NextNode is null
             && rawNode.IsTextLike()
             && rawNode.GetLastDescendant() is { NodeType: XmlNodeType.Text } textNode
             && (
@@ -157,7 +161,10 @@ Life is demanding.
             );
     }
 
-    public static bool NeedsToBorrowParentOpeningTagEndMarker(RawNode rawNode)
+    public static bool NeedsToBorrowParentOpeningTagEndMarker(
+        RawNode rawNode,
+        PrintingContext context
+    )
     {
         /*
          *     <p
@@ -168,7 +175,8 @@ public static bool NeedsToBorrowParentOpeningTagEndMarker(RawNode rawNode)
          *       ><a
          *       ^
          */
-        return rawNode.PreviousNode is null
+        return context.Options.XmlWhitespaceSensitivity is XmlWhitespaceSensitivity.Strict
+            && rawNode.PreviousNode is null
             && rawNode.NodeType is XmlNodeType.Text
             && rawNode.Value![0] is not ('\r' or '\n');
     }
diff --git a/Src/CSharpier.Core/Xml/XmlFormatter.cs b/Src/CSharpier.Core/Xml/XmlFormatter.cs
@@ -35,6 +35,7 @@ PrinterOptions printerOptions
                     LineEnding = lineEnding,
                     IndentSize = printerOptions.IndentSize,
                     UseTabs = printerOptions.UseTabs,
+                    XmlWhitespaceSensitivity = printerOptions.XmlWhitespaceSensitivity,
                 },
             };
             var doc = Node.Print(rootNode, printingContext);
diff --git a/Src/CSharpier.Playground/ClientApp/src/AppContext.ts b/Src/CSharpier.Playground/ClientApp/src/AppContext.ts
@@ -37,6 +37,7 @@ class AppState {
     showAst = getBoolean("showAst", false);
     showDoc = getBoolean("showDoc", false);
     hideNull = getBoolean("hideNull", false);
+    xmlWhitespaceSensitivity = getString("xmlWhitespaceSensitivity", "Strict");
     doc = "";
     isLoading = false;
     hasErrors = false;
@@ -53,6 +54,11 @@ class AppState {
         this.formatter = value;
     };
 
+    setXmlWhitespaceSensitivity = (value: string) => {
+        window.sessionStorage.setItem("xmlWhitespaceSensitivity", value);
+        this.xmlWhitespaceSensitivity = value;
+    };
+
     setIndentSize = (value: number) => {
         window.sessionStorage.setItem("indentSize", value.toString(10));
         this.indentSize = value;
@@ -119,6 +125,7 @@ class AppState {
                 this.indentSize,
                 this.useTabs,
                 this.formatter,
+                this.xmlWhitespaceSensitivity,
             );
 
             runInAction(() => {
diff --git a/Src/CSharpier.Playground/ClientApp/src/Controls.tsx b/Src/CSharpier.Playground/ClientApp/src/Controls.tsx
@@ -13,6 +13,8 @@ export const Controls = observer(() => {
         setUseTabs,
         formatter,
         setFormatter,
+        xmlWhitespaceSensitivity,
+        setXmlWhitespaceSensitivity,
         showDoc,
         setShowDoc,
         hideNull,
@@ -47,6 +49,19 @@ export const Controls = observer(() => {
                     <option value="CSharpScript">C# Script</option>
                     <option value="XML">XML</option>
                 </select>
+                {formatter === "XML" && (
+                    <>
+                        <label>Whitespace Sensitivity</label>
+                        <select
+                            value={xmlWhitespaceSensitivity}
+                            onChange={e => setXmlWhitespaceSensitivity(e.target.value)}
+                        >
+                            <option value="Strict">Strict</option>
+                            <option value="Xaml">Xaml</option>
+                            <option value="Ignore">Ignore</option>
+                        </select>
+                    </>
+                )}
             </div>
             <div>
                 <h3>Debug</h3>
diff --git a/Src/CSharpier.Playground/ClientApp/src/FormatCode.ts b/Src/CSharpier.Playground/ClientApp/src/FormatCode.ts
@@ -8,11 +8,12 @@ export const formatCode = async (
     indentSize: number,
     useTabs: boolean,
     formatter: string,
+    xmlWhitespaceSensitivity: string,
 ) => {
     const makeRequest = async () => {
         const response = await fetch("/Format", {
             method: "POST",
-            body: JSON.stringify({ code, printWidth, indentSize, useTabs, formatter }),
+            body: JSON.stringify({ code, printWidth, indentSize, useTabs, formatter, xmlWhitespaceSensitivity }),
             headers: {
                 "Content-Type": "application/json",
                 "cache-control": "no-cache",
diff --git a/Src/CSharpier.Playground/Controllers/FormatController.cs b/Src/CSharpier.Playground/Controllers/FormatController.cs
@@ -32,6 +32,7 @@ public class PostModel
         public int IndentSize { get; set; }
         public bool UseTabs { get; set; }
         public string Formatter { get; set; } = string.Empty;
+        public string XmlWhitespaceSensitivity { get; set; } = string.Empty;
     }
 
     [HttpPost]
@@ -54,6 +55,12 @@ CancellationToken cancellationToken
                 Width = model.PrintWidth,
                 IndentSize = model.IndentSize,
                 UseTabs = model.UseTabs,
+                XmlWhitespaceSensitivity = model.XmlWhitespaceSensitivity switch
+                {
+                    "Ignore" => XmlWhitespaceSensitivity.Ignore,
+                    "Xaml" => XmlWhitespaceSensitivity.Xaml,
+                    _ => XmlWhitespaceSensitivity.Strict,
+                },
             },
             cancellationToken
         );
diff --git a/Src/CSharpier.Tests/CSharp/SyntaxPrinter/CSharpierIgnoreTests.cs b/Src/CSharpier.Tests/CSharp/SyntaxPrinter/CSharpierIgnoreTests.cs
@@ -1,4 +1,5 @@
 using AwesomeAssertions;
+using CSharpier.Core;
 using CSharpier.Core.CSharp.SyntaxPrinter;
 
 namespace CSharpier.Tests.CSharp.SyntaxPrinter;
@@ -71,6 +72,7 @@ private static string PrintWithoutFormatting(string code)
                         LineEnding = Environment.NewLine,
                         IndentSize = 4,
                         UseTabs = false,
+                        XmlWhitespaceSensitivity = XmlWhitespaceSensitivity.Strict,
                     },
                 }
             )
diff --git a/Src/CSharpier.Tests/FormattingTests/BaseTest.cs b/Src/CSharpier.Tests/FormattingTests/BaseTest.cs
@@ -29,22 +29,47 @@ public void BuildTests<T>(DynamicTestBuilderContext context, string folder)
 
         foreach (var group in files.GroupBy(o => o.Directory!.Name))
         {
-            var formattingType = group.Key;
-
             foreach (var file in group)
             {
                 var fileNameWithoutExtension = Path.GetFileNameWithoutExtension(file.Name);
                 var useTabs = fileNameWithoutExtension.EndsWith("_Tabs", StringComparison.Ordinal);
+                var directoryName = file.Directory!.Name;
+                var xmlWhitespaceSensitivity = XmlWhitespaceSensitivity.Strict;
+                if (directoryName.Contains('_'))
+                {
+                    var parts = directoryName.Split('_');
+                    directoryName = parts[0];
+                    xmlWhitespaceSensitivity =
+                        parts[1] is "ignore" ? XmlWhitespaceSensitivity.Ignore
+                        : parts[1] is "xaml" ? XmlWhitespaceSensitivity.Xaml
+                        : XmlWhitespaceSensitivity.Strict;
+                }
+
+                var formatter = directoryName switch
+                {
+                    "cs" => Formatter.CSharp,
+                    "csx" => Formatter.CSharpScript,
+                    "xml" => Formatter.XML,
+                    _ => Formatter.Unknown,
+                };
+
+                var printerOptions = new PrinterOptions(formatter)
+                {
+                    UseTabs = useTabs,
+                    Width = PrinterOptions.WidthUsedByTests,
+                    IndentSize = formatter == Formatter.XML ? 2 : 4,
+                    XmlWhitespaceSensitivity = xmlWhitespaceSensitivity,
+                };
 
                 context.AddTest(
                     new DynamicTest<T>
                     {
-                        TestMethod = @class => @class.RunTest(string.Empty, string.Empty, false),
+                        TestMethod = @class => @class.RunTest(string.Empty, string.Empty, null),
                         TestMethodArguments =
                         [
                             fileNameWithoutExtension,
                             file.Directory!.Name,
-                            useTabs,
+                            printerOptions,
                         ],
                         DisplayName = fileNameWithoutExtension,
                     }
@@ -53,13 +78,17 @@ public void BuildTests<T>(DynamicTestBuilderContext context, string folder)
         }
     }
 
-    public async Task RunTest(string fileName, string fileExtensionWithoutDot, bool useTabs = false)
+    internal async Task RunTest(
+        string fileName,
+        string directoryName,
+        PrinterOptions printerOptions
+    )
     {
         var filePath = Path.Combine(
             this.rootDirectory.FullName,
             "FormattingTests",
             "TestFiles",
-            fileExtensionWithoutDot,
+            directoryName,
             fileName + ".test"
         );
         var fileReaderResult = await FileReader.ReadFileAsync(
@@ -68,22 +97,9 @@ public async Task RunTest(string fileName, string fileExtensionWithoutDot, bool
             CancellationToken.None
         );
 
-        var formatter = fileExtensionWithoutDot switch
-        {
-            "cs" => Formatter.CSharp,
-            "csx" => Formatter.CSharpScript,
-            "xml" => Formatter.XML,
-            _ => Formatter.Unknown,
-        };
-
         var result = await CodeFormatter.FormatAsync(
             fileReaderResult.FileContents,
-            new PrinterOptions(formatter)
-            {
-                Width = PrinterOptions.WidthUsedByTests,
-                UseTabs = useTabs,
-                IndentSize = formatter == Formatter.XML ? 2 : 4,
-            },
+            printerOptions,
             CancellationToken.None
         );
 
diff --git a/Src/CSharpier.Tests/FormattingTests/TestFiles/xml_ignore/Elements.expected.test b/Src/CSharpier.Tests/FormattingTests/TestFiles/xml_ignore/Elements.expected.test
@@ -0,0 +1,10 @@
+<Root>
+  <LongElement____________________________________________>
+    TextValue
+  </LongElement____________________________________________>
+  <LongElementWithAttribute Attribute="AttributeValue_________________">
+    TextValue
+  </LongElementWithAttribute>
+  <ShortElement>TextValue</ShortElement>
+  <ShortElementWithAttribute Attribute="1">TextValue</ShortElementWithAttribute>
+</Root>
diff --git a/Src/CSharpier.Tests/FormattingTests/TestFiles/xml_ignore/Elements.test b/Src/CSharpier.Tests/FormattingTests/TestFiles/xml_ignore/Elements.test
diff --git a/Src/CSharpier.Tests/FormattingTests/XmlIgnoreFormatting.cs b/Src/CSharpier.Tests/FormattingTests/XmlIgnoreFormatting.cs

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ public class PrintingContextOptions`
`36`	`36`	`public required string LineEnding { get; init; }`
`37`	`37`	`public required int IndentSize { get; init; }`
`38`	`38`	`public required bool UseTabs { get; init; }`
	`39`	`+ public required XmlWhitespaceSensitivity XmlWhitespaceSensitivity { get; init; }`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`public class PrintingContextState`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public static Doc Print(RawNode rawNode, PrintingContext context)`
`42`	`42`	`*/`
`43`	`43`	`(`
`44`	`44`	`rawNode.Nodes.Count != 0`
`45`		`- && Tag.NeedsToBorrowParentOpeningTagEndMarker(rawNode.Nodes.First())`
	`45`	`+ && Tag.NeedsToBorrowParentOpeningTagEndMarker(rawNode.Nodes.First(), context)`
`46`	`46`	`) \|\| doNotBreakAttributes`
`47`	`47`	`)`
`48`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ internal static Doc Print(RawNode node, PrintingContext context)`
`40`	`40`	`{`
`41`	`41`	`List<Doc> doc =`
`42`	`42`	`[`
`43`		`- Tag.PrintOpeningTagPrefix(node),`
	`43`	`+ Tag.PrintOpeningTagPrefix(node, context),`
`44`	`44`	`GetTextValue(node),`
`45`	`45`	`Tag.PrintClosingTagSuffix(node, context),`
`46`	`46`	`];`