tmp

Author: carlossanlop

src/PortToTripleSlash/.lutignore

@@ -0,0 +1,153 @@
+## The .lutignore file is used by Live Unit Testing to ignore Visual Studio temporary files, build results,
+## and files generated by popular Visual Studio add-ons when creating a private copy of the source tree that
+## Live Unit Testing uses for its build.
+##
+## This file has same format as git's .gitignore file (https://git-scm.com/docs/gitignore). In fact, in the
+## case where a .lutignore file is not found, but a .gitignore file is found, Live Unit Testing will use the
+## .gitignore file directly for the above purpose.
+
+# User-specific files
+*.suo
+*.user
+*.userprefs
+*.sln.docstates
+.vs/
+.vscode/
+.packages/
+.dotnet/
+.tools/
+.idea/
+
+# Build results
+[Dd]ebug/
+[Rr]elease/
+[Bb]inaries/
+[Bb]in/
+[Oo]bj/
+x64/
+TestResults/
+
+# Debug artifactss
+launchSettings.json
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.Publish.xml
+
+# NuGet Packages Directory
+packages/
+
+# NuGet V3 artifacts
+[Nn]u[Gg]et.exe
+*-packages.config
+*.nuget.props
+*.nuget.targets
+project.lock.json
+msbuild.binlog
+*.project.lock.json
+
+# Miscellaneous
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.wrn
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.scc
+sql/
+*.Cache
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.[Pp]ublish.xml
+*.pfx
+*.publishsettings
+
+# Visual Studio cache files
+*.sln.ide/
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.opendb
+*.VC.db
+
+# Windows Store app package directory
+AppPackages/
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+*.ncrunch*
+.*crunch*.local.xml
+
+# Upgrade backups
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+App_Data/*.mdf
+App_Data/*.ldf
+
+#LightSwitch generated files
+GeneratedArtifacts/
+_Pvt_Extensions/
+ModelManifest.xml
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Mac desktop service store files
+.DS_Store
+
+# WPF temp projects
+*wpftmp.*

src/PortToTripleSlash/PortToTripleSlash.lutconfig

@@ -0,0 +1,6 @@
+<LUTConfig Version="1.0">
+  <Repository />
+  <ParallelBuilds>true</ParallelBuilds>
+  <ParallelTestRuns>true</ParallelTestRuns>
+  <TestCaseTimeout>180000</TestCaseTimeout>
+</LUTConfig>

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

@@ -6,6 +6,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
+using System.Xml.Linq;
 using ApiDocsSync.PortToTripleSlash.Docs;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
@@ -164,10 +165,14 @@ internal class TripleSlashSyntaxRewriter : CSharpSyntaxRewriter
         private const string Space = " ";
         private const string NewLine = "\n";
 
+        private static readonly char[] _NewLineSeparators = ['\n', '\r'];
+        private const StringSplitOptions _NewLineSplitOptions = StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries;
+
         private DocsCommentsContainer DocsComments { get; }
         private ResolvedLocation Location { get; }
         private SemanticModel Model => Location.Model;
 
+
         public TripleSlashSyntaxRewriter(DocsCommentsContainer docsComments, ResolvedLocation resolvedLocation) : base(visitIntoStructuredTrivia: false)
         {
             DocsComments = docsComments;
@@ -422,105 +427,117 @@ internal static SyntaxList<SyntaxNode> GetOrCreateXmlNodes(IDocsAPI api, SyntaxL
         {
             List<SyntaxNode> updated = new();
 
-            if(TryGetOrCreateXmlNode(originalXmls, SummaryTag, api.Summary, attributeValue: null, out XmlNodeSyntax? summaryNode, out _))
+            if(TryGetOrCreateXmlRows(originalXmls, SummaryTag, api.Summary, attributeValue: null, indentationTrivia, out List<XmlNodeSyntax> summaryNodes, out _))
             {
-                updated.AddRange(GetXmlRow(summaryNode, indentationTrivia));
+                updated.AddRange(summaryNodes);
             }
 
-           if (TryGetOrCreateXmlNode(originalXmls, ValueTag, api.Value, attributeValue: null, out XmlNodeSyntax? valueNode, out _))
+           if (TryGetOrCreateXmlRows(originalXmls, ValueTag, api.Value, attributeValue: null, indentationTrivia, out List<XmlNodeSyntax> valueNodes, out _))
             {
-                updated.AddRange(GetXmlRow(valueNode, indentationTrivia));
+                updated.AddRange(valueNodes);
             }
 
             foreach (DocsTypeParam typeParam in api.TypeParams)
             {
-                if (TryGetOrCreateXmlNode(originalXmls, TypeParamTag, typeParam.Value, attributeValue: typeParam.Name,  out XmlNodeSyntax? typeParamNode, out _))
+                if (TryGetOrCreateXmlRows(originalXmls, TypeParamTag, typeParam.Value, attributeValue: typeParam.Name, indentationTrivia, out List<XmlNodeSyntax> typeParamNodes, out _))
                 {
-                    updated.AddRange(GetXmlRow(typeParamNode, indentationTrivia));
+                    updated.AddRange(typeParamNodes);
                 }
             }
 
             foreach (DocsParam param in api.Params)
             {
-                if (TryGetOrCreateXmlNode(originalXmls, ParamTag, param.Value, attributeValue: param.Name, out XmlNodeSyntax? paramNode, out _))
+                if (TryGetOrCreateXmlRows(originalXmls, ParamTag, param.Value, attributeValue: param.Name, indentationTrivia, out List<XmlNodeSyntax> paramNodes, out _))
                 {
-                    updated.AddRange(GetXmlRow(paramNode, indentationTrivia));
+                    updated.AddRange(paramNodes);
                 }
             }
 
-            if (TryGetOrCreateXmlNode(originalXmls, ReturnsTag, api.Returns, attributeValue: null, out XmlNodeSyntax? returnsNode, out _))
+            if (TryGetOrCreateXmlRows(originalXmls, ReturnsTag, api.Returns, attributeValue: null, indentationTrivia, out List<XmlNodeSyntax> returnsNodes, out _))
             {
-                updated.AddRange(GetXmlRow(returnsNode, indentationTrivia));
+                updated.AddRange(returnsNodes);
             }
 
             foreach (DocsException exception in api.Exceptions)
             {
-                if (TryGetOrCreateXmlNode(originalXmls, ExceptionTag, exception.Value, attributeValue: exception.Cref[2..], out XmlNodeSyntax? exceptionNode, out _))
+                if (TryGetOrCreateXmlRows(originalXmls, ExceptionTag, exception.Value, attributeValue: exception.Cref[2..], indentationTrivia, out List<XmlNodeSyntax> exceptionNodes, out _))
                 {
-                    updated.AddRange(GetXmlRow(exceptionNode, indentationTrivia));
+                    updated.AddRange(exceptionNodes);
                 }
             }
 
-            if (TryGetOrCreateXmlNode(originalXmls, RemarksTag, api.Remarks, attributeValue: null, out XmlNodeSyntax? remarksNode, out bool isBackported) &&
+            if (TryGetOrCreateXmlRows(originalXmls, RemarksTag, api.Remarks, attributeValue: null, indentationTrivia, out List<XmlNodeSyntax> remarksNodes, out bool isBackported) &&
                 (!isBackported || (isBackported && !skipRemarks)))
             {
-                updated.AddRange(GetXmlRow(remarksNode!, indentationTrivia));
+                updated.AddRange(remarksNodes);
             }
 
             return new SyntaxList<SyntaxNode>(updated);
         }
 
-        private static IEnumerable<XmlNodeSyntax> GetXmlRow(XmlNodeSyntax item, SyntaxTrivia? indentationTrivia)
+        private static bool TryGetOrCreateXmlRows(SyntaxList<XmlNodeSyntax> originalXmls, string tagName,
+            string apiDocsText, string? attributeValue, SyntaxTrivia? indentationTrivia, out List<XmlNodeSyntax> rows, out bool isBackported)
         {
-            yield return GetIndentationNode(indentationTrivia);
-            yield return GetTripleSlashNode();
-            yield return item;
-            yield return GetNewLineNode();
-        }
+            rows = [];
 
-        private static bool TryGetOrCreateXmlNode(SyntaxList<XmlNodeSyntax> originalXmls, string tagName,
-            string apiDocsText, string? attributeValue, [NotNullWhen(returnValue: true)] out XmlNodeSyntax? node, out bool isBackported)
-        {
-            SyntaxTokenList contentTokens;
+            if (apiDocsText.IsDocsEmpty())
+            {
+                isBackported = false;
 
-            isBackported = false;
+                // Not yet documented in api docs, so try to see if it was already documented in triple slash
+                XmlNodeSyntax? xmlNode = originalXmls.FirstOrDefault(xmlNode => DoesNodeHaveTag(xmlNode, tagName));
 
-            if (!apiDocsText.IsDocsEmpty())
-            {
-                isBackported = true;
+                if (xmlNode != null)
+                {
+                    rows.Add(xmlNode);
+                    return true;
+                }
+
+                // We don't want to add an empty xml item. We want don't want to add one in this case, it needs
+                // to be missing on purpose so the developer sees the build error and adds it manually.
+                
+                return false;
+            }
 
+            isBackported = true;
+
+            List<XmlNodeSyntax> nodes = new();
+
+            bool first = true;
+            foreach (string line in apiDocsText.Split(_NewLineSeparators, _NewLineSplitOptions))
+            {
                 // Overwrite the current triple slash with the text that comes from api docs
                 SyntaxToken textLiteral = SyntaxFactory.XmlTextLiteral(
                     leading: SyntaxFactory.TriviaList(),
-                    text: apiDocsText,
-                    value: apiDocsText,
+                    text: line,
+                    value: line,
                     trailing: SyntaxFactory.TriviaList());
 
-                contentTokens = SyntaxFactory.TokenList(textLiteral);
-            }
-            else
-            {
-                // Not yet documented in api docs, so try to see if it was documented in triple slash
-                XmlNodeSyntax? xmlNode = originalXmls.FirstOrDefault(xmlNode => DoesNodeHasTag(xmlNode, tagName));
+                XmlTextSyntax xmlText = SyntaxFactory.XmlText().WithTextTokens(SyntaxFactory.TokenList(textLiteral));
 
-                if (xmlNode != null)
+                if (first)
                 {
-                    XmlElementSyntax xmlElement = (XmlElementSyntax)xmlNode;
-                    XmlTextSyntax xmlText = (XmlTextSyntax)xmlElement.Content.Single();
-                    contentTokens = xmlText.TextTokens;
+                    nodes.Add(xmlText);
+                    first = false;
                 }
                 else
                 {
-                    // We don't want to add an empty xml item. We want don't want to add one in this case, it needs
-                    // to be missing on purpose so the developer sees the build error and adds it manually.
-                    node = null;
-                    return false;
+                    IEnumerable<XmlNodeSyntax> content = GetXmlRow(xmlText, indentationTrivia);
+                    nodes.AddRange(content);
                 }
             }
 
-            node = CreateXmlNode(tagName, contentTokens, attributeValue);
+            rows.AddRange(GetXmlRow(CreateXmlNode(tagName, nodes.ToArray(), attributeValue), indentationTrivia));
+
             return true;
         }
+        private static IEnumerable<XmlNodeSyntax> GetXmlRow(XmlNodeSyntax item, SyntaxTrivia? indentationTrivia)
+        {
+            yield return GetIndentationNode(indentationTrivia);
+            yield return GetTripleSlashNode();
+            yield return item;
+            yield return GetNewLineNode();
+        }
 
         private static XmlTextSyntax GetTripleSlashNode()
         {
@@ -566,10 +583,8 @@ private static XmlTextSyntax GetNewLineNode()
             return SyntaxFactory.XmlText().WithTextTokens(SyntaxFactory.TokenList(tokens));
         }
 
-        private static XmlElementSyntax CreateXmlNode(string tagName, SyntaxTokenList contentTokens, string? attributeValue = null)
+        private static XmlElementSyntax CreateXmlNode(string tagName, XmlNodeSyntax[] content, string? attributeValue = null)
         {
-            SyntaxList<XmlNodeSyntax> content = SyntaxFactory.SingletonList<XmlNodeSyntax>(SyntaxFactory.XmlText().WithTextTokens(contentTokens));
-
             XmlElementSyntax result;
 
             switch (tagName)
@@ -614,7 +629,7 @@ private static XmlElementSyntax CreateXmlNode(string tagName, SyntaxTokenList co
             return result;
         }
 
-        private static XmlElementSyntax GetXmlAttributedElement(SyntaxList<XmlNodeSyntax> content, string tagName, string attributeName, string attributeValue)
+        private static XmlElementSyntax GetXmlAttributedElement(IEnumerable<XmlNodeSyntax> content, string tagName, string attributeName, string attributeValue)
         {
             Debug.Assert(!string.IsNullOrWhiteSpace(tagName));
             Debug.Assert(!string.IsNullOrWhiteSpace(attributeName));
@@ -639,10 +654,10 @@ private static XmlElementSyntax GetXmlAttributedElement(SyntaxList<XmlNodeSyntax
 
             XmlElementEndTagSyntax endTag = SyntaxFactory.XmlElementEndTag(SyntaxFactory.XmlName(SyntaxFactory.Identifier(tagName)));
 
-            return SyntaxFactory.XmlElement(startTag, content, endTag);
+            return SyntaxFactory.XmlElement(startTag, SyntaxFactory.List(content), endTag);
         }
 
-        private static bool DoesNodeHasTag(SyntaxNode xmlNode, string tagName)
+        private static bool DoesNodeHaveTag(SyntaxNode xmlNode, string tagName)
         {
             if (tagName == ExceptionTag)
             {