Fix highlighting with escaping

olsh · olsh · commit a8060cb970a0 · 2019-03-10T23:53:50.000+03:00
diff --git a/appveyor.yml b/appveyor.yml
@@ -3,7 +3,7 @@ image: Visual Studio 2017
 install:
   - dotnet tool install -g Cake.Tool --version 0.30.0 
 build_script:
-- cmd: dotnet cake -Target=CI
+- cmd: dotnet cake -Target=CI -buildConfig=Release
 test: off
 cache:
   - '%USERPROFILE%\.sonar\cache'
diff --git a/build.cake b/build.cake
@@ -4,15 +4,14 @@
 
 var target = Argument("target", "Default");
 var buildConfiguration = Argument("buildConfig", "Debug");
-var waveVersion = Argument("wave", "[182.0]");
-var extensionsVersion =  Argument("Version", "2018.2.3");
+var waveVersion = Argument("wave", "[183.0]");
+var extensionsVersion =  Argument("Version", "2018.3.0");
 
 var solutionName = "ReSharper.Structured.Logging";
 var projectName = solutionName;
 
 var solutionFile = string.Format("./src/{0}.sln", solutionName);
 var solutionFolder = string.Format("./src/{0}/", solutionName);
-var testBinaries = string.Format("test/src/**/ReSharper.Structured.Logging.Tests.dll", solutionFolder);
 var projectFile = string.Format("{0}{1}.csproj", solutionFolder, projectName);
 
 Task("AppendBuildNumber")
@@ -55,16 +54,12 @@ Task("NugetPack")
 
      var files = new List<NuSpecContent>();
      files.Add(new NuSpecContent {Source = string.Format("{0}/{1}.dll", buildPath, projectName), Target = "dotFiles"});
-
-     if (buildConfiguration == "Debug") 
-     {
-        files.Add(new NuSpecContent {Source = string.Format("{0}/{1}.pdb", buildPath, projectName), Target = "dotFiles"});
-     }
+     files.Add(new NuSpecContent {Source = string.Format("{0}/{1}.pdb", buildPath, projectName), Target = "dotFiles"});
 
      var nuGetPackSettings   = new NuGetPackSettings {
                                      Id                      = projectName,
                                      Version                 = extensionsVersion,
-                                     Title                   = "Structure Logging",
+                                     Title                   = "Structured Logging",
                                      Authors                 = new[] { "Oleg Shevchenko" },
                                      Owners                  = new[] { "Oleg Shevchenko" },
                                      Description             = "Provides support for Serilog",
diff --git a/src/ReSharper.Structured.Logging/Analyzer/DuplicatePropertiesTemplateAnalyzer.cs b/src/ReSharper.Structured.Logging/Analyzer/DuplicatePropertiesTemplateAnalyzer.cs
@@ -2,7 +2,6 @@
 
 using JetBrains.ReSharper.Feature.Services.Daemon;
 using JetBrains.ReSharper.Psi.CSharp.Tree;
-using JetBrains.ReSharper.Psi.Tree;
 using JetBrains.ReSharper.Psi.Util;
 
 using ReSharper.Structured.Logging.Extensions;
@@ -38,7 +37,7 @@ protected override void Run(
                 return;
             }
 
-            var messageTemplate = _messageTemplateParser.Parse(stringLiteral.CompiledValue);
+            var messageTemplate = _messageTemplateParser.Parse(stringLiteral.Expression.GetUnquotedText());
             if (messageTemplate.NamedProperties == null)
             {
                 return;
@@ -50,10 +49,7 @@ protected override void Run(
             {
                 foreach (var token in duplicates)
                 {
-                    consumer.AddHighlighting(
-                        new DuplicateTemplatePropertyWarning(
-                            stringLiteral.Expression.GetDocumentRange()
-                                .GetTokenDocumentRange(token)));
+                    consumer.AddHighlighting(new DuplicateTemplatePropertyWarning(stringLiteral.GetTokenDocumentRange(token)));
                 }
             }
         }
diff --git a/src/ReSharper.Structured.Logging/Analyzer/TemplateFormatAnalyzer.cs b/src/ReSharper.Structured.Logging/Analyzer/TemplateFormatAnalyzer.cs
@@ -4,7 +4,6 @@
 using JetBrains.ReSharper.Feature.Services.Daemon;
 using JetBrains.ReSharper.Psi;
 using JetBrains.ReSharper.Psi.CSharp.Tree;
-using JetBrains.ReSharper.Psi.Tree;
 using JetBrains.ReSharper.Psi.Util;
 
 using ReSharper.Structured.Logging.Extensions;
@@ -41,7 +40,7 @@ protected override void Run(
                 return;
             }
 
-            var messageTemplate = _messageTemplateParser.Parse(stringLiteral.CompiledValue);
+            var messageTemplate = _messageTemplateParser.Parse(stringLiteral.Expression.GetUnquotedText());
 
             HighlightTemplate(consumer, stringLiteral, messageTemplate);
             HighlightUnusedArguments(element, consumer, templateArgument, messageTemplate);
@@ -56,9 +55,8 @@ protected override void Run(
                     if (argumentsCount < 0)
                     {
                         consumer.AddHighlighting(
-                            new TemplateFormatStringInexistingArgumentWarning(
-                                stringLiteral.Expression.GetDocumentRange()
-                                    .GetTokenDocumentRange(property)));
+                            new TemplateFormatStringUnexistingArgumentWarning(
+                                stringLiteral.GetTokenDocumentRange(property)));
                     }
                 }
             }
@@ -74,9 +72,8 @@ protected override void Run(
                     if (position >= argumentsCount)
                     {
                         consumer.AddHighlighting(
-                            new TemplateFormatStringInexistingArgumentWarning(
-                                stringLiteral.Expression.GetDocumentRange()
-                                    .GetTokenDocumentRange(property)));
+                            new TemplateFormatStringUnexistingArgumentWarning(
+                                stringLiteral.GetTokenDocumentRange(property)));
                     }
                 }
             }
@@ -87,7 +84,6 @@ private static void HighlightTemplate(
             IStringLiteralAlterer stringLiteral,
             MessageTemplate messageTemplate)
         {
-            var documentRange = stringLiteral.Expression.GetDocumentRange();
             foreach (var token in messageTemplate.Tokens)
             {
                 if (!(token is PropertyToken))
@@ -97,7 +93,7 @@ private static void HighlightTemplate(
 
                 consumer.AddHighlighting(
                     new StringEscapeCharacterHighlighting(
-                        documentRange.GetTokenDocumentRange(token),
+                        stringLiteral.GetTokenDocumentRange(token),
                         HighlightingAttributeIds.FORMAT_STRING_ITEM));
             }
         }
diff --git a/src/ReSharper.Structured.Logging/Extensions/PsiExtensions.cs b/src/ReSharper.Structured.Logging/Extensions/PsiExtensions.cs
@@ -5,6 +5,7 @@
 using JetBrains.ReSharper.Feature.Services.CSharp.CodeStyle.Suggestions;
 using JetBrains.ReSharper.Psi;
 using JetBrains.ReSharper.Psi.CSharp.Tree;
+using JetBrains.ReSharper.Psi.Tree;
 using JetBrains.ReSharper.Psi.Util;
 using JetBrains.Util;
 
@@ -33,19 +34,23 @@ public static ICSharpArgument GetTemplateArgument(this IInvocationExpression inv
                 a => a.GetMatchingParameterName() == templateParameterName);
         }
 
-        [CanBeNull]
-        public static IStringLiteralAlterer GetMessageTemplateStringLiteral(this IInvocationExpression invocation)
+        public static DocumentRange GetTokenDocumentRange(this ICSharpArgument argument, MessageTemplateToken token)
         {
-            var templateArgument = invocation.GetTemplateArgument();
-            if (templateArgument == null)
-            {
-                return null;
-            }
+            var documentRange = argument.GetDocumentRange();
+
+            return GetTokenDocumentRange(token, documentRange);
+        }
+
+        public static DocumentRange GetTokenDocumentRange(this IStringLiteralAlterer stringLiteralAlterer, MessageTemplateToken token)
+        {
+            var documentRange = stringLiteralAlterer.Expression.GetDocumentRange();
 
-            return StringLiteralAltererUtil.TryCreateStringLiteralByExpression(templateArgument.Value);
+            return GetTokenDocumentRange(token, documentRange);
         }
 
-        public static DocumentRange GetTokenDocumentRange(this DocumentRange documentRange, MessageTemplateToken token)
+        private static DocumentRange GetTokenDocumentRange(
+            MessageTemplateToken token,
+            DocumentRange documentRange)
         {
             var startOffset = documentRange.TextRange.StartOffset + token.StartIndex + 1;
 
diff --git a/src/ReSharper.Structured.Logging/Highlighting/TemplateFormatItemAndMatchingArgumentHighlighter.cs b/src/ReSharper.Structured.Logging/Highlighting/TemplateFormatItemAndMatchingArgumentHighlighter.cs
@@ -80,7 +80,7 @@ protected override void CollectHighlightings(
             }
 
             var templateString = StringLiteralAltererUtil.TryCreateStringLiteralByExpression(templateArgument.Value)
-                ?.CompiledValue;
+                ?.Expression.GetUnquotedText();
             if (templateString == null)
             {
                 return;
@@ -141,7 +141,7 @@ private static void HighlightByArgument(
                 var property = namedProperties[argumentIndex];
                 consumer.ConsumeHighlighting(
                     HighlightingAttributeIds.USAGE_OF_ELEMENT_UNDER_CURSOR,
-                    templateArgument.GetDocumentRange().GetTokenDocumentRange(property));
+                    templateArgument.GetTokenDocumentRange(property));
                 consumer.ConsumeHighlighting(
                     HighlightingAttributeIds.USAGE_OF_ELEMENT_UNDER_CURSOR,
                     selectedArgument.GetDocumentRange());
@@ -162,7 +162,7 @@ private static void HighlightByArgument(
 
                     consumer.ConsumeHighlighting(
                         HighlightingAttributeIds.USAGE_OF_ELEMENT_UNDER_CURSOR,
-                        templateArgument.GetDocumentRange().GetTokenDocumentRange(property));
+                        templateArgument.GetTokenDocumentRange(property));
                 }
 
                 consumer.ConsumeHighlighting(
@@ -194,7 +194,7 @@ private static void HighlightByNamedPlaceholder(
 
                 consumer.ConsumeHighlighting(
                     HighlightingAttributeIds.USAGE_OF_ELEMENT_UNDER_CURSOR,
-                    templateArgument.GetDocumentRange().GetTokenDocumentRange(selectedToken));
+                    templateArgument.GetTokenDocumentRange(selectedToken));
                 consumer.ConsumeHighlighting(
                     HighlightingAttributeIds.USAGE_OF_ELEMENT_UNDER_CURSOR,
                     arguments[argumentIndex].GetDocumentRange());
@@ -226,7 +226,7 @@ private static void HighlightByNamedPlaceholder(
 
                     consumer.ConsumeHighlighting(
                         HighlightingAttributeIds.USAGE_OF_ELEMENT_UNDER_CURSOR,
-                        templateArgument.GetDocumentRange().GetTokenDocumentRange(property));
+                        templateArgument.GetTokenDocumentRange(property));
                 }
 
                 var argumentIndex = templateArgument.IndexOf() + position + 1;
diff --git a/src/ReSharper.Structured.Logging/Highlighting/TemplateFormatStringInexistingArgumentWarning.cs b/src/ReSharper.Structured.Logging/Highlighting/TemplateFormatStringInexistingArgumentWarning.cs
@@ -5,8 +5,8 @@
 using ReSharper.Structured.Logging.Highlighting;
 
 [assembly:
-    RegisterConfigurableSeverity(TemplateFormatStringInexistingArgumentWarning.SeverityId, null, HighlightingGroupIds.CompilerWarnings,
-        TemplateFormatStringInexistingArgumentWarning.Message, TemplateFormatStringInexistingArgumentWarning.Message,
+    RegisterConfigurableSeverity(TemplateFormatStringUnexistingArgumentWarning.SeverityId, null, HighlightingGroupIds.CompilerWarnings,
+        TemplateFormatStringUnexistingArgumentWarning.Message, TemplateFormatStringUnexistingArgumentWarning.Message,
         Severity.WARNING)]
 
 namespace ReSharper.Structured.Logging.Highlighting
@@ -16,15 +16,15 @@ namespace ReSharper.Structured.Logging.Highlighting
         CSharpLanguage.Name,
         OverlapResolve = OverlapResolveKind.WARNING,
         ToolTipFormatString = Message)]
-    public class TemplateFormatStringInexistingArgumentWarning : IHighlighting
+    public class TemplateFormatStringUnexistingArgumentWarning : IHighlighting
     {
         public const string SeverityId = "TemplateFormatStringProblem";
 
         public const string Message = "Non-existing argument in message template";
 
         private readonly DocumentRange _documentRange;
 
-        public TemplateFormatStringInexistingArgumentWarning(DocumentRange documentRange)
+        public TemplateFormatStringUnexistingArgumentWarning(DocumentRange documentRange)
         {
             _documentRange = documentRange;
         }
diff --git a/test/data/Analyzers/SerilogTemplateWithEscapedSymbols.cs b/test/data/Analyzers/SerilogTemplateWithEscapedSymbols.cs
@@ -0,0 +1,12 @@
+﻿using Serilog;
+
+namespace ConsoleApp
+{
+    public static class Program
+    {
+        public static void Main()
+        {
+            Log.Logger.Information("\r\n{MyProperty} \r\n {OtherProperty}", 1, 2);
+        }
+    }
+}
diff --git a/test/data/Analyzers/SerilogTemplateWithEscapedSymbols.cs.gold b/test/data/Analyzers/SerilogTemplateWithEscapedSymbols.cs.gold
@@ -0,0 +1,20 @@
+﻿using Serilog;
+
+namespace ConsoleApp
+{
+    public static class Program
+    {
+        public static void Main()
+        {
+            Log.Logger.Information("|\r|(0)|\n|(1)|{MyProperty}|(2) |\r|(3)|\n|(4) |{OtherProperty}|(5)", 1, 2);
+        }
+    }
+}
+
+---------------------------------------------------------
+(0): ReSharper String Escape Character 1: 
+(1): ReSharper String Escape Character 2: 
+(2): ReSharper Format String Item: 
+(3): ReSharper String Escape Character 1: 
+(4): ReSharper String Escape Character 2: 
+(5): ReSharper Format String Item: 
diff --git a/test/src/Analyzer/MessageTemplateTests.cs b/test/src/Analyzer/MessageTemplateTests.cs
@@ -21,7 +21,7 @@ protected override bool HighlightingPredicate(
             IContextBoundSettingsStore settingsStore)
         {
             return highlighting is TemplateFormatStringArgumentIsNotUsedWarning
-                   || highlighting is TemplateFormatStringInexistingArgumentWarning
+                   || highlighting is TemplateFormatStringUnexistingArgumentWarning
                    || highlighting is StringEscapeCharacterHighlighting
                    || highlighting is DuplicateTemplatePropertyWarning
                    || highlighting is ExceptionPassedAsTemplateArgumentWarning;
diff --git a/test/src/Analyzer/TemplateFormatAnalyzerTests.cs b/test/src/Analyzer/TemplateFormatAnalyzerTests.cs
@@ -27,5 +27,11 @@ public void TestSerilogValidPositionProperty()
         {
             DoNamedTest2();
         }
+
+        [Test]
+        public void TestSerilogTemplateWithEscapedSymbols()
+        {
+            DoNamedTest2();
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`	`using JetBrains.ReSharper.Feature.Services.Daemon;`
`4`	`4`	`using JetBrains.ReSharper.Psi.CSharp.Tree;`
`5`		`-using JetBrains.ReSharper.Psi.Tree;`
`6`	`5`	`using JetBrains.ReSharper.Psi.Util;`
`7`	`6`
`8`	`7`	`using ReSharper.Structured.Logging.Extensions;`
`@@ -38,7 +37,7 @@ protected override void Run(`
`38`	`37`	`return;`
`39`	`38`	`}`
`40`	`39`
`41`		`- var messageTemplate = _messageTemplateParser.Parse(stringLiteral.CompiledValue);`
	`40`	`+ var messageTemplate = _messageTemplateParser.Parse(stringLiteral.Expression.GetUnquotedText());`
`42`	`41`	`if (messageTemplate.NamedProperties == null)`
`43`	`42`	`{`
`44`	`43`	`return;`
`@@ -50,10 +49,7 @@ protected override void Run(`
`50`	`49`	`{`
`51`	`50`	`foreach (var token in duplicates)`
`52`	`51`	`{`
`53`		`- consumer.AddHighlighting(`
`54`		`- new DuplicateTemplatePropertyWarning(`
`55`		`- stringLiteral.Expression.GetDocumentRange()`
`56`		`- .GetTokenDocumentRange(token)));`
	`52`	`+ consumer.AddHighlighting(new DuplicateTemplatePropertyWarning(stringLiteral.GetTokenDocumentRange(token)));`
`57`	`53`	`}`
`58`	`54`	`}`
`59`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`	`using JetBrains.ReSharper.Feature.Services.Daemon;`
`5`	`5`	`using JetBrains.ReSharper.Psi;`
`6`	`6`	`using JetBrains.ReSharper.Psi.CSharp.Tree;`
`7`		`-using JetBrains.ReSharper.Psi.Tree;`
`8`	`7`	`using JetBrains.ReSharper.Psi.Util;`
`9`	`8`
`10`	`9`	`using ReSharper.Structured.Logging.Extensions;`
`@@ -41,7 +40,7 @@ protected override void Run(`
`41`	`40`	`return;`
`42`	`41`	`}`
`43`	`42`
`44`		`- var messageTemplate = _messageTemplateParser.Parse(stringLiteral.CompiledValue);`
	`43`	`+ var messageTemplate = _messageTemplateParser.Parse(stringLiteral.Expression.GetUnquotedText());`
`45`	`44`
`46`	`45`	`HighlightTemplate(consumer, stringLiteral, messageTemplate);`
`47`	`46`	`HighlightUnusedArguments(element, consumer, templateArgument, messageTemplate);`
`@@ -56,9 +55,8 @@ protected override void Run(`
`56`	`55`	`if (argumentsCount < 0)`
`57`	`56`	`{`
`58`	`57`	`consumer.AddHighlighting(`
`59`		`- new TemplateFormatStringInexistingArgumentWarning(`
`60`		`- stringLiteral.Expression.GetDocumentRange()`
`61`		`- .GetTokenDocumentRange(property)));`
	`58`	`+ new TemplateFormatStringUnexistingArgumentWarning(`
	`59`	`+ stringLiteral.GetTokenDocumentRange(property)));`
`62`	`60`	`}`
`63`	`61`	`}`
`64`	`62`	`}`
`@@ -74,9 +72,8 @@ protected override void Run(`
`74`	`72`	`if (position >= argumentsCount)`
`75`	`73`	`{`
`76`	`74`	`consumer.AddHighlighting(`
`77`		`- new TemplateFormatStringInexistingArgumentWarning(`
`78`		`- stringLiteral.Expression.GetDocumentRange()`
`79`		`- .GetTokenDocumentRange(property)));`
	`75`	`+ new TemplateFormatStringUnexistingArgumentWarning(`
	`76`	`+ stringLiteral.GetTokenDocumentRange(property)));`
`80`	`77`	`}`
`81`	`78`	`}`
`82`	`79`	`}`
`@@ -87,7 +84,6 @@ private static void HighlightTemplate(`
`87`	`84`	`IStringLiteralAlterer stringLiteral,`
`88`	`85`	`MessageTemplate messageTemplate)`
`89`	`86`	`{`
`90`		`- var documentRange = stringLiteral.Expression.GetDocumentRange();`
`91`	`87`	`foreach (var token in messageTemplate.Tokens)`
`92`	`88`	`{`
`93`	`89`	`if (!(token is PropertyToken))`
`@@ -97,7 +93,7 @@ private static void HighlightTemplate(`
`97`	`93`
`98`	`94`	`consumer.AddHighlighting(`
`99`	`95`	`new StringEscapeCharacterHighlighting(`
`100`		`- documentRange.GetTokenDocumentRange(token),`
	`96`	`+ stringLiteral.GetTokenDocumentRange(token),`
`101`	`97`	`HighlightingAttributeIds.FORMAT_STRING_ITEM));`
`102`	`98`	`}`
`103`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ protected override bool HighlightingPredicate(`
`21`	`21`	`IContextBoundSettingsStore settingsStore)`
`22`	`22`	`{`
`23`	`23`	`return highlighting is TemplateFormatStringArgumentIsNotUsedWarning`
`24`		`- \|\| highlighting is TemplateFormatStringInexistingArgumentWarning`
	`24`	`+ \|\| highlighting is TemplateFormatStringUnexistingArgumentWarning`
`25`	`25`	`\|\| highlighting is StringEscapeCharacterHighlighting`
`26`	`26`	`\|\| highlighting is DuplicateTemplatePropertyWarning`
`27`	`27`	`\|\| highlighting is ExceptionPassedAsTemplateArgumentWarning;`