Merge pull request #30 from episerver/user/shsh/add-view-location-comments

add view location comments

Author: jbearfoot

src/EpiSourceUpdater/EpiPartialControllerCodeFixProvider.cs

@@ -90,12 +90,15 @@ private static async Task<Document> ReplaceNameAndReturnParameterAsync(Document
         private static async Task<Document> ReplacePartialViewMethodAsync(Document document, IdentifierNameSyntax identifierNameSyntax, CancellationToken cancellationToken)
         {
             var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
-
-            var updatedName = identifierNameSyntax.WithIdentifier(SyntaxFactory.Identifier("View"));
+            var comment = SyntaxFactory.Comment($"//The default convention for views and viewcomponent is '/Views/Shared/Components/ComponentName/Default.cshtml'");
+            var leadingTrivia = GetAncestorsTrivia(identifierNameSyntax);
+            var updatedName = identifierNameSyntax.WithIdentifier(SyntaxFactory.Identifier(SyntaxTriviaList.Create(SyntaxFactory.CarriageReturnLineFeed).AddRange(leadingTrivia).Add(comment).Add(SyntaxFactory.CarriageReturnLineFeed).AddRange(leadingTrivia), "View", SyntaxTriviaList.Empty));
             var newRoot = root!.ReplaceNode(identifierNameSyntax, updatedName);
-
             // Return document with transformed tree.
             return document.WithSyntaxRoot(newRoot);
         }
+
+        private static SyntaxTriviaList GetAncestorsTrivia(IdentifierNameSyntax identifierNameSyntax) =>
+            identifierNameSyntax.Ancestors().Where(a => a.HasLeadingTrivia).FirstOrDefault()?.GetLeadingTrivia()?? SyntaxTriviaList.Empty;
     }
 }

src/EpiSourceUpdater/EpiPartialRouterCodeFixProvider.cs

@@ -148,7 +148,7 @@ private async Task<Document> HandlePartialRouteRegistration(Document document, I
                         //The registration is done somewhere where we do not have access to IServiceCollection, add a comment on how registration should be done       
                         var parameterType = getPartialRouterArgument is ObjectCreationExpressionSyntax objectCreationExpression ? objectCreationExpression.Type.ToString() : "CustomPartialRouter";
                         var comment = SyntaxFactory.Comment($"//Partial router should be registered in ioc container like 'services.AddSingleton<IPartialRouter, {parameterType}>()'");
-                        statements = statements.Insert(index, statement.WithLeadingTrivia(statement.GetLeadingTrivia().Add(comment).Add(SyntaxFactory.CarriageReturnLineFeed)));
+                        statements = statements.Insert(index, statement.WithLeadingTrivia(statement.GetLeadingTrivia().Add(comment).Add(SyntaxFactory.CarriageReturnLineFeed).AddRange(statement.GetLeadingTrivia())));
                     }
 
                     var newCodeBlock = currentCodeBlock.WithStatements(statements);