Unix line breaks (#146)

* Manually change newline of test files to LF

* Use Unix newline in TripleSlashSyntaxRewriter

* Change the SyntaxTrivia from CarriageReturnLineFeed to LineFeed

* .editorconfig

* .gitattributes

Author: carlossanlop

.editorconfig

@@ -11,6 +11,8 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
 
 # Generated code
 [*{_AssemblyInfo.cs,.notsupported.cs,AsmOffsets.cs}]
@@ -183,10 +185,3 @@ indent_size = 2
 # YAML config files
 [*.{yml,yaml}]
 indent_size = 2
-
-# Shell scripts
-[*.sh]
-end_of_line = lf
-[*.{cmd,bat}]
-end_of_line = crlf
-

.gitattributes

@@ -1,5 +1,5 @@
 # Set default behavior to automatically normalize line endings.
-* text=auto
+* text=auto eol=lf
 
 *.doc  diff=astextplain
 *.DOC	diff=astextplain
@@ -54,6 +54,7 @@
 *.fs text=auto
 *.fsx text=auto
 *.hs text=auto
+*.xml text=auto
 
 *.csproj text=auto
 *.vbproj text=auto

src/PortToTripleSlash/src/libraries/RoslynTripleSlash/TripleSlashSyntaxRewriter.cs

@@ -92,6 +92,8 @@ internal class TripleSlashSyntaxRewriter : CSharpSyntaxRewriter
     {
         #region Private members
 
+        private static readonly string UnixNewLine = "\n";
+
         private static readonly string[] ReservedKeywords = new[] { "abstract", "async", "await", "false", "null", "sealed", "static", "true", "virtual" };
 
         private static readonly string[] MarkdownUnconvertableStrings = new[] { "](~/includes", "[!INCLUDE" };
@@ -437,7 +439,7 @@ private static SyntaxNode GetNodeWithTrivia(SyntaxTriviaList leadingWhitespace,
                     if (leadingTrivia[0].IsKind(SyntaxKind.EndOfLineTrivia))
                     {
                         // Ensure the endline that separates nodes is respected
-                        finalTrivia = new SyntaxTriviaList(SyntaxFactory.ElasticCarriageReturnLineFeed)
+                        finalTrivia = new SyntaxTriviaList(SyntaxFactory.ElasticLineFeed)
                             .AddRange(finalTrivia);
                     }
                 }
@@ -476,7 +478,7 @@ private static SyntaxTriviaList GetLeadingDoubleSlashComments(SyntaxNode node, S
                     doubleSlashComments = doubleSlashComments
                                             .AddRange(leadingWhitespace)
                                             .Add(trivia)
-                                            .Add(SyntaxFactory.CarriageReturnLineFeed);
+                                            .Add(SyntaxFactory.LineFeed);
                 }
             }
 
@@ -697,12 +699,12 @@ private static XmlTextSyntax GetTextAsCommentedTokens(string text, SyntaxTriviaL
 
             // collapse newlines to a single one
             string whitespace = Regex.Replace(leadingWhitespace.ToFullString(), @"(\r?\n)+", "");
-            SyntaxToken whitespaceToken = SyntaxFactory.XmlTextNewLine(Environment.NewLine + whitespace);
+            SyntaxToken whitespaceToken = SyntaxFactory.XmlTextNewLine(UnixNewLine + whitespace);
 
             SyntaxTrivia leadingTrivia = SyntaxFactory.SyntaxTrivia(SyntaxKind.DocumentationCommentExteriorTrivia, string.Empty);
             SyntaxTriviaList leading = SyntaxTriviaList.Create(leadingTrivia);
 
-            string[] lines = text.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
+            string[] lines = text.Split(new char[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
 
             var tokens = new List<SyntaxToken>();
 
@@ -740,7 +742,7 @@ private static SyntaxTriviaList GetXmlTrivia(XmlNodeSyntax node, SyntaxTriviaLis
 
             return leadingWhitespace
                 .Add(docCommentTrivia)
-                .Add(SyntaxFactory.CarriageReturnLineFeed);
+                .Add(SyntaxFactory.LineFeed);
         }
 
         // Generates a custom SyntaxTrivia object containing a triple slashed xml element with optional attributes.
@@ -765,9 +767,9 @@ private static SyntaxTriviaList GetXmlTrivia(string name, SyntaxList<XmlAttribut
 
         private static string WrapInRemarks(string acum)
         {
-            string wrapped = Environment.NewLine + "<format type=\"text/markdown\"><![CDATA[" + Environment.NewLine;
+            string wrapped = UnixNewLine + "<format type=\"text/markdown\"><![CDATA[" + UnixNewLine;
             wrapped += acum;
-            wrapped += Environment.NewLine + "]]></format>" + Environment.NewLine;
+            wrapped += UnixNewLine + "]]></format>" + UnixNewLine;
             return wrapped;
         }
 
@@ -776,7 +778,7 @@ private static string WrapCodeIncludes(string[] splitted, ref int n)
             string acum = string.Empty;
             while (n < splitted.Length && splitted[n].ContainsStrings(MarkdownCodeIncludes))
             {
-                acum += Environment.NewLine + splitted[n];
+                acum += UnixNewLine + splitted[n];
                 if ((n + 1) < splitted.Length && splitted[n + 1].ContainsStrings(MarkdownCodeIncludes))
                 {
                     n++;
@@ -802,7 +804,7 @@ private static SyntaxTriviaList GetFormattedRemarks(IDocsAPI api, SyntaxTriviaLi
             }
             else
             {
-                string[] splitted = remarks.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries);
+                string[] splitted = remarks.Split(new char[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries);
                 string updatedRemarks = string.Empty;
                 for (int n = 0; n < splitted.Length; n++)
                 {
@@ -814,7 +816,7 @@ private static SyntaxTriviaList GetFormattedRemarks(IDocsAPI api, SyntaxTriviaLi
                         n++;
                         while (n < splitted.Length && splitted[n].StartsWith(">"))
                         {
-                            acum += Environment.NewLine + splitted[n];
+                            acum += UnixNewLine + splitted[n];
                             if ((n + 1) < splitted.Length && splitted[n + 1].StartsWith(">"))
                             {
                                 n++;
@@ -843,14 +845,14 @@ private static SyntaxTriviaList GetFormattedRemarks(IDocsAPI api, SyntaxTriviaLi
                             }
                             else
                             {
-                                example += Environment.NewLine + line;
+                                example += UnixNewLine + line;
                             }
                             n++;
                         }
                     }
                     else
                     {
-                        updatedRemarks += ReplaceMarkdownWithXmlElements(Environment.NewLine + line, api.Params, api.TypeParams);
+                        updatedRemarks += ReplaceMarkdownWithXmlElements(UnixNewLine + line, api.Params, api.TypeParams);
                     }
                 }
 

src/PortToTripleSlash/tests/PortToTripleSlash/TestData/Basic/MyEnum.xml

@@ -48,4 +48,4 @@ URL entities: %23%28%2C%29 must remain unconverted.
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

src/PortToTripleSlash/tests/PortToTripleSlash/TestData/Basic/MyType.xml

@@ -230,4 +230,4 @@ There are also a `true` and a `null`.
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

src/PortToTripleSlash/tests/PortToTripleSlash/TestData/Generics/MyGenericType`1+Enumerator.xml

@@ -6,4 +6,4 @@
   <Docs>
     <summary>This is the MyGenericType{T}.Enumerator class summary.</summary>
   </Docs>
-</Type>
+</Type>

src/PortToTripleSlash/tests/PortToTripleSlash/TestData/Generics/MyGenericType`1.xml

@@ -13,4 +13,4 @@ Contains the nested class <xref:MyNamespace.MyGenericType%601.Enumerator>.
       ]]></format>
     </remarks>
   </Docs>
-</Type>
+</Type>