Another attempt to get the sort order right within VB spell check

src/EditorFeatures/VisualBasicTest/Diagnostics/AbstractVisualBasicDiagnosticProviderBasedUserDiagnosticTest.vb

@@ -24,8 +24,8 @@ Namespace Microsoft.CodeAnalysis.Editor.VisualBasic.UnitTests.Diagnostics
 
             Return VisualBasicWorkspaceFactory.CreateWorkspaceFromFile(
                 definition,
-                DirectCast(parseOptions, ParseOptions),
-                If(DirectCast(compilationOptions, CompilationOptions), New VisualBasicCompilationOptions(OutputKind.DynamicallyLinkedLibrary)))
+                parseOptions,
+                If(compilationOptions, New VisualBasicCompilationOptions(OutputKind.DynamicallyLinkedLibrary)))
         End Function
 
         Protected Shared Function NewLines(input As String) As String

src/EditorFeatures/VisualBasicTest/Diagnostics/Spellcheck/SpellcheckTests.vb

@@ -384,7 +384,7 @@ End Module</File>
 Imports System
 Imports System.Collections.Generic
 Imports System.Linq
-                           
+
 Module Program
     Class [Integer]
     End Class
@@ -398,7 +398,7 @@ End Module</File>
 Imports System
 Imports System.Collections.Generic
 Imports System.Linq
-                           
+
 Module Program
     Class [Integer]
     End Class
@@ -412,7 +412,7 @@ End Module</File>
 Imports System
 Imports System.Collections.Generic
 Imports System.Linq
-                           
+
 Module Program
     Class [Integer]
     End Class

src/Features/VisualBasic/CodeFixes/Spellcheck/SpellcheckCodeFixProvider.vb

@@ -143,7 +143,23 @@ Namespace Microsoft.CodeAnalysis.VisualBasic.CodeFixes.Spellcheck
                         Return goodnessComparisan
                     End If
 
-                    Return r1.ReplacementText.CompareTo(r2.ReplacementText)
+                    ' Try to order by name. Note that this is unescaped version of the name.
+                    Dim nameCompare = String.Compare(r1.Name, r2.Name, StringComparison.CurrentCultureIgnoreCase)
+                    If nameCompare <> 0 Then
+                        Return nameCompare
+                    End If
+
+                    ' Prefer escaped identifiers ahead of non-escaped
+                    Dim r1StartsWithEscape = r1.ReplacementText.Length > 0 AndAlso r1.ReplacementText(0) = "["c
+                    Dim r2StartsWithEscape = r2.ReplacementText.Length > 0 AndAlso r2.ReplacementText(0) = "["c
+
+                    If r1StartsWithEscape Then
+                        Return -1
+                    ElseIf r2StartsWithEscape
+                        Return 1
+                    End If
+
+                    Return String.Compare(r1.ReplacementText, r2.ReplacementText, StringComparison.CurrentCultureIgnoreCase)
                 End Function)
 
             Return results _