Auto-format our XAML files and enforce in CI (microsoft#9589)

This adds [`XamlStyler.Console`] to our solution, and calls it when we format the code, to also format our .xaml files. * `XamlStyler.Console` is a dotnet tool so it needs to be restored with `dotnet tool restore` * I've added a set of rules to approximately follow [@cmaneu's XAML guidelines]. Those guidelines also recommend things based on the code-behind, which this tool can't figure out, but also _don't matter that much_. * There's an extra step to strip BOMs from the output, since Xaml Styler adds a BOM by default. Some had them before and others didn't. BOMs have been nothing but trouble though. [`XamlStyler.Console`]: https://github.com/Xavalon/XamlStyler [@cmaneu's XAML guidelines]: https://github.com/cmaneu/xaml-coding-guidelines
DBehrashi · Mar 29, 2021 · 3323dc5 · 3323dc5
1 parent c19aa89
commit 3323dc5
Show file tree

Hide file tree

Showing 38 changed files with 2,863 additions and 2,262 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "XamlStyler.Console": {
+      "version": "3.2008.4",
+      "commands": [
+        "xstyler"
+      ]
+    }
+  }
+}
diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt
@@ -64,3 +64,4 @@ SUMS$
 ^\.github/actions/spelling/
 ^\.gitignore$
 ^doc/reference/master-sequence-list.csv$
+^\XamlStyler.json$
diff --git a/.github/actions/spelling/expect/expect.txt b/.github/actions/spelling/expect/expect.txt
@@ -2061,6 +2061,7 @@ runtests
 runtimeclass
 runuia
 runut
+runxamlformat
 rvalue
 RVERTICAL
 rxvt
@@ -2852,6 +2853,7 @@ XResource
 xsd
 xsi
 xsize
+xstyler
 XSubstantial
 xtended
 xterm

diff --git a/.nuget/packages.config b/.nuget/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="vswhere" version="2.6.7" />
-</packages>
+</packages>
diff --git a/XamlStyler.json b/XamlStyler.json
@@ -0,0 +1,41 @@
+{
+    "AttributesTolerance": 1,
+    "KeepFirstAttributeOnSameLine": true,
+    "MaxAttributeCharactersPerLine": 0,
+    "MaxAttributesPerLine": 1,
+    "NewlineExemptionElements": "RadialGradientBrush, GradientStop, LinearGradientBrush, ScaleTransform, SkewTransform, RotateTransform, TranslateTransform, Trigger, Condition, Setter",
+    "SeparateByGroups": false,
+    "AttributeIndentation": 0,
+    "AttributeIndentationStyle": 1,
+    "RemoveDesignTimeReferences":  false,
+    "EnableAttributeReordering": true,
+    "AttributeOrderingRuleGroups": [
+        "x:Class",
+        "xmlns, xmlns:x",
+        "xmlns:*",
+        "x:Key, Key, x:Name, Name, x:Uid, Uid, Title",
+        "Grid.Row, Grid.RowSpan, Grid.Column, Grid.ColumnSpan, Canvas.Left, Canvas.Top, Canvas.Right, Canvas.Bottom",
+        "Width, Height, MinWidth, MinHeight, MaxWidth, MaxHeight",
+        "Margin, Padding, HorizontalAlignment, VerticalAlignment, HorizontalContentAlignment, VerticalContentAlignment, Panel.ZIndex",
+        "*:*, *",
+        "PageSource, PageIndex, Offset, Color, TargetName, Property, Value, StartPoint, EndPoint",
+        "mc:Ignorable, d:IsDataSource, d:LayoutOverrides, d:IsStaticText",
+        "Storyboard.*, From, To, Duration"
+    ],
+    "FirstLineAttributes": "",
+    "OrderAttributesByName": true,
+    "PutEndingBracketOnNewLine": false,
+    "RemoveEndingTagOfEmptyElement": true,
+    "SpaceBeforeClosingSlash": true,
+    "RootElementLineBreakRule": 0,
+    "ReorderVSM": 2,
+    "ReorderGridChildren": false,
+    "ReorderCanvasChildren": false,
+    "ReorderSetters": 0,
+    "FormatMarkupExtension": true,
+    "NoNewLineMarkupExtensions": "x:Bind, Binding",
+    "ThicknessSeparator": 2,
+    "ThicknessAttributes": "Margin, Padding, BorderThickness, ThumbnailClipMargin",
+    "FormatOnSave": true,
+    "CommentPadding": 2,
+}
diff --git a/build/scripts/Invoke-FormattingCheck.ps1 b/build/scripts/Invoke-FormattingCheck.ps1
@@ -3,12 +3,24 @@
 # Checks for code formatting errors. Will throw exception if any are found.
 function Invoke-CheckBadCodeFormatting() {
     Import-Module ./tools/OpenConsole.psm1
-    Invoke-CodeFormat
+
+    # Don't run the XAML formatter in this step - even if it changes nothing,
+    # it'll still touch all the .xaml files.
+    Invoke-CodeFormat -IgnoreXaml
+
     # returns a non-zero exit code if there are any diffs in the tracked files in the repo
     git diff-index --quiet HEAD --
     if ($lastExitCode -eq 1) {
+
+        # Write the list of files that need updating to the log
+        git diff-index --name-only HEAD
+
         throw "code formatting bad, run Invoke-CodeFormat on branch"
     }
+
+    # Manually check the formatting of our .xaml files, without touching them.
+    Verify-XamlFormat
+
 }
 
 Invoke-CheckBadCodeFormatting
diff --git a/consolegit2gitfilters.json b/consolegit2gitfilters.json
@@ -38,6 +38,7 @@
     ".wrn",
     ".rec",
     ".err",
+    "XamlStyler.json",
     ".xlsx"
   ]
 }
diff --git a/samples/ConPTY/GUIConsole/GUIConsole.WPF/App.xaml b/samples/ConPTY/GUIConsole/GUIConsole.WPF/App.xaml
@@ -1,8 +1,6 @@
-<Application x:Class="GUIConsole.Wpf.App"
-             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
-             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
-             StartupUri="MainWindow.xaml">
-    <Application.Resources>
-
-    </Application.Resources>
-</Application>
+<Application x:Class="GUIConsole.Wpf.App"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             StartupUri="MainWindow.xaml">
+    <Application.Resources />
+</Application>
diff --git a/samples/ConPTY/GUIConsole/GUIConsole.WPF/MainWindow.xaml b/samples/ConPTY/GUIConsole/GUIConsole.WPF/MainWindow.xaml
@@ -1,84 +1,100 @@
-<Window x:Class="GUIConsole.Wpf.MainWindow"
-        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
-        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
-        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
-        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
-        mc:Ignorable="d"
-
-        Title="MainWindow" Height="450" Width="800"
-        Background="#C7000000"
-        AllowsTransparency="True"
-        WindowStyle="None"
-        MouseDown="Window_MouseDown"
-        BorderThickness="1"
-        BorderBrush="LightSlateGray"
-
-        KeyDown="Window_KeyDown"
-        Loaded="Window_Loaded">
-    <Window.Resources>
-        <Style x:Key="TitleBarButtonStyle" TargetType="{x:Type Button}">
-            <Setter Property="Background" Value="Transparent"/>
-            <Setter Property="FontFamily" Value="Segoe MDL2 Assets"/>
-            <Setter Property="FontSize" Value="14"/>
-            <Setter Property="Height" Value="32"/>
-            <Setter Property="Width" Value="46"/>
-            <Setter Property="Background" Value="Transparent"/>
-            <Setter Property="Foreground" Value="White"/>
-            <Setter Property="BorderThickness" Value="0"/>
-        </Style>
-
-        <Style x:Key="CloseButtonStyle" TargetType="{x:Type Button}" BasedOn="{StaticResource TitleBarButtonStyle}">
-            <Setter Property="Content" Value="&#xE10A;"/>
-            <!--Remove the default Button template's Triggers, otherwise they'll override our trigger below.-->
-            <Setter Property="Template">
-                <Setter.Value>
-                    <ControlTemplate TargetType="{x:Type Button}">
-                        <Border Background="{TemplateBinding Background}">
-                            <ContentPresenter HorizontalAlignment="Center" VerticalAlignment="Center"/>
-                        </Border>
-                    </ControlTemplate>
-                </Setter.Value>
-            </Setter>
-            <Style.Triggers>
-                <Trigger Property="IsMouseOver" Value="True">
-                    <Setter Property="Button.Background" Value="Red"/>
-                </Trigger>
-            </Style.Triggers>
-        </Style>
-    </Window.Resources>
-
-    <Grid>
-        <Grid.RowDefinitions>
-            <RowDefinition Height="Auto"/>
-            <RowDefinition Height="*"/>
-        </Grid.RowDefinitions>
-
-        <Grid Grid.Row="0">
-            <Grid.ColumnDefinitions>
-                <ColumnDefinition Width="*"/>
-                <ColumnDefinition Width="Auto"/>
-            </Grid.ColumnDefinitions>
-            <TextBlock x:Name="TitleBarTitle" Grid.Column="0" VerticalAlignment="Center" Padding="10 0" Foreground="White">
-                GUIConsole
-            </TextBlock>
-            <StackPanel x:Name="TitleBarButtons" Grid.Column="1" Orientation="Horizontal" VerticalAlignment="Top">
-                <Button x:Name="MinimizeButton"
-                        Click="MinimizeButton_Click"
-                        Content="&#xE108;"
-                        Style="{StaticResource TitleBarButtonStyle}"/>
-                <Button x:Name="MaximizeRestoreButton"
-                        Click="MaximizeRestoreButton_Click"
-                        Content="&#xE922;"
-                        FontSize="12"
-                        Style="{StaticResource TitleBarButtonStyle}"/>
-                <Button x:Name="CloseButton"
-                        Click="CloseButton_Click" 
-                        FontSize="12"
-                        Style="{StaticResource CloseButtonStyle}"/>
-            </StackPanel>
-        </Grid>
-        <ScrollViewer x:Name="TerminalHistoryViewer" Grid.Row="1" ScrollChanged="ScrollViewer_ScrollChanged">
-            <TextBlock x:Name="TerminalHistoryBlock" FontFamily="Consolas" TextWrapping="Wrap" Foreground="White"/>
-        </ScrollViewer>
-    </Grid>
-</Window>
+<Window x:Class="GUIConsole.Wpf.MainWindow"
+        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+        Title="MainWindow"
+        Width="800"
+        Height="450"
+        AllowsTransparency="True"
+        Background="#C7000000"
+        BorderBrush="LightSlateGray"
+        BorderThickness="1"
+        KeyDown="Window_KeyDown"
+        Loaded="Window_Loaded"
+        MouseDown="Window_MouseDown"
+        WindowStyle="None"
+        mc:Ignorable="d">
+    <Window.Resources>
+        <Style x:Key="TitleBarButtonStyle"
+               TargetType="{x:Type Button}">
+            <Setter Property="Background" Value="Transparent" />
+            <Setter Property="FontFamily" Value="Segoe MDL2 Assets" />
+            <Setter Property="FontSize" Value="14" />
+            <Setter Property="Height" Value="32" />
+            <Setter Property="Width" Value="46" />
+            <Setter Property="Background" Value="Transparent" />
+            <Setter Property="Foreground" Value="White" />
+            <Setter Property="BorderThickness" Value="0" />
+        </Style>
+
+        <Style x:Key="CloseButtonStyle"
+               BasedOn="{StaticResource TitleBarButtonStyle}"
+               TargetType="{x:Type Button}">
+            <Setter Property="Content" Value="&#xE10A;" />
+            <!--  Remove the default Button template's Triggers, otherwise they'll override our trigger below.  -->
+            <Setter Property="Template">
+                <Setter.Value>
+                    <ControlTemplate TargetType="{x:Type Button}">
+                        <Border Background="{TemplateBinding Background}">
+                            <ContentPresenter HorizontalAlignment="Center"
+                                              VerticalAlignment="Center" />
+                        </Border>
+                    </ControlTemplate>
+                </Setter.Value>
+            </Setter>
+            <Style.Triggers>
+                <Trigger Property="IsMouseOver" Value="True">
+                    <Setter Property="Button.Background" Value="Red" />
+                </Trigger>
+            </Style.Triggers>
+        </Style>
+    </Window.Resources>
+
+    <Grid>
+        <Grid.RowDefinitions>
+            <RowDefinition Height="Auto" />
+            <RowDefinition Height="*" />
+        </Grid.RowDefinitions>
+
+        <Grid Grid.Row="0">
+            <Grid.ColumnDefinitions>
+                <ColumnDefinition Width="*" />
+                <ColumnDefinition Width="Auto" />
+            </Grid.ColumnDefinitions>
+            <TextBlock x:Name="TitleBarTitle"
+                       Grid.Column="0"
+                       Padding="10,0"
+                       VerticalAlignment="Center"
+                       Foreground="White">
+                GUIConsole
+            </TextBlock>
+            <StackPanel x:Name="TitleBarButtons"
+                        Grid.Column="1"
+                        VerticalAlignment="Top"
+                        Orientation="Horizontal">
+                <Button x:Name="MinimizeButton"
+                        Click="MinimizeButton_Click"
+                        Content="&#xE108;"
+                        Style="{StaticResource TitleBarButtonStyle}" />
+                <Button x:Name="MaximizeRestoreButton"
+                        Click="MaximizeRestoreButton_Click"
+                        Content="&#xE922;"
+                        FontSize="12"
+                        Style="{StaticResource TitleBarButtonStyle}" />
+                <Button x:Name="CloseButton"
+                        Click="CloseButton_Click"
+                        FontSize="12"
+                        Style="{StaticResource CloseButtonStyle}" />
+            </StackPanel>
+        </Grid>
+        <ScrollViewer x:Name="TerminalHistoryViewer"
+                      Grid.Row="1"
+                      ScrollChanged="ScrollViewer_ScrollChanged">
+            <TextBlock x:Name="TerminalHistoryBlock"
+                       FontFamily="Consolas"
+                       Foreground="White"
+                       TextWrapping="Wrap" />
+        </ScrollViewer>
+    </Grid>
+</Window>
diff --git a/src/cascadia/LocalTests_TerminalApp/TestHostApp/UnitTestApp.xaml b/src/cascadia/LocalTests_TerminalApp/TestHostApp/UnitTestApp.xaml
@@ -1,8 +1,5 @@
-<Application
-    x:Class="TestHostApp.App"
-    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
-    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
-    xmlns:local="using:TestHostApp"
-    RequestedTheme="Dark">
-
-</Application>
+<Application x:Class="TestHostApp.App"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:local="using:TestHostApp"
+             RequestedTheme="Dark" />
-Original file line number
+Diff line change
@@ Expand Up / @@ -2061,6 +2061,7 @@ runtests @@
     runtimeclass
     runuia
     runut
+    runxamlformat
     rvalue
     RVERTICAL
     rxvt
@@ Expand Down Expand Up / @@ -2852,6 +2853,7 @@ XResource @@
     xsd
     xsi
     xsize
+    xstyler
     XSubstantial
     xtended
     xterm
@@ Expand Down @@