Implement positional properties analyzer

rules/AnonymousObjectDestructuringProblem.md

@@ -1,4 +1,4 @@
-##### Anonymous objects must be destructured
+#### Anonymous objects must be destructured
 
 Noncompliant Code Examples:
 ```csharp

rules/ComplexObjectDestructuringProblem.md

@@ -1,4 +1,4 @@
-##### Complex objects with default `ToString()` implementation probably need to be destructured 
+#### Complex objects with default `ToString()` implementation probably need to be destructured 
 
 Noncompliant Code Example:
 ```csharp

rules/ContextualLoggerProblem.md

@@ -1,4 +1,4 @@
-##### Incorrect type is used for contextual logger
+#### Incorrect type is used for contextual logger
 
 Noncompliant Code Examples:
 ```csharp

rules/ExceptionPassedAsTemplateArgumentProblem.md

@@ -1,4 +1,4 @@
-##### Exception passed as a template argument
+#### Exception passed as a template argument
 
 Noncompliant Code Example:
 ```csharp

rules/PositionalPropertyUsedProblem.md

@@ -0,0 +1,12 @@
+#### Prefer named properties instead of positional ones
+
+Noncompliant Code Examples:
+```csharp
+Log.Error("Disk quota {0} MB exceeded by {1}", quota, user);
+```
+
+
+Compliant Solution:
+```csharp
+Log.Error("Disk quota {Quota} MB exceeded by {User}", quota, user);
+```

rules/TemplateDuplicatePropertyProblem.md

@@ -1,4 +1,4 @@
-##### Duplicate template property 
+#### Duplicate template property 
 
 Noncompliant Code Example:
 ```csharp

rules/TemplateIsNotCompileTimeConstantProblem.md

@@ -1,4 +1,4 @@
-##### Message template is not a compile time constant
+#### Message template is not a compile time constant
 
 Noncompliant Code Examples:
 ```csharp

src/ReSharper.Structured.Logging.sln

@@ -25,6 +25,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Rules", "Rules", "{D93C6901
 		..\rules\ComplexObjectDestructuringProblem.md = ..\rules\ComplexObjectDestructuringProblem.md
 		..\rules\ContextualLoggerProblem.md = ..\rules\ContextualLoggerProblem.md
 		..\rules\ExceptionPassedAsTemplateArgumentProblem.md = ..\rules\ExceptionPassedAsTemplateArgumentProblem.md
+		..\rules\PositionalPropertyUsedProblem.md = ..\rules\PositionalPropertyUsedProblem.md
 		..\rules\TemplateDuplicatePropertyProblem.md = ..\rules\TemplateDuplicatePropertyProblem.md
 		..\rules\TemplateIsNotCompileTimeConstantProblem.md = ..\rules\TemplateIsNotCompileTimeConstantProblem.md
 	EndProjectSection

src/ReSharper.Structured.Logging/Analyzer/PositionalPropertiesUsageAnalyzer.cs

@@ -0,0 +1,52 @@
+using System.Linq;
+
+using JetBrains.ReSharper.Feature.Services.Daemon;
+using JetBrains.ReSharper.Psi.CSharp.Tree;
+using JetBrains.ReSharper.Psi.Util;
+
+using ReSharper.Structured.Logging.Extensions;
+using ReSharper.Structured.Logging.Highlighting;
+using ReSharper.Structured.Logging.Serilog.Parsing;
+
+namespace ReSharper.Structured.Logging.Analyzer
+{
+    [ElementProblemAnalyzer(typeof(IInvocationExpression))]
+    public class PositionalPropertiesUsageAnalyzer : ElementProblemAnalyzer<IInvocationExpression>
+    {
+        private readonly MessageTemplateParser _messageTemplateParser;
+
+        public PositionalPropertiesUsageAnalyzer(MessageTemplateParser messageTemplateParser)
+        {
+            _messageTemplateParser = messageTemplateParser;
+        }
+
+        protected override void Run(
+            IInvocationExpression element,
+            ElementProblemAnalyzerData data,
+            IHighlightingConsumer consumer)
+        {
+            var templateArgument = element.GetTemplateArgument();
+            if (templateArgument == null)
+            {
+                return;
+            }
+
+            var stringLiteral = StringLiteralAltererUtil.TryCreateStringLiteralByExpression(templateArgument.Value);
+            if (stringLiteral == null)
+            {
+                return;
+            }
+
+            var messageTemplate = _messageTemplateParser.Parse(stringLiteral.Expression.GetUnquotedText());
+            if (messageTemplate.PositionalProperties == null)
+            {
+                return;
+            }
+
+            foreach (var property in messageTemplate.PositionalProperties)
+            {
+                consumer.AddHighlighting(new PositionalPropertyUsedWarning(stringLiteral, property, stringLiteral.GetTokenDocumentRange(property)));
+            }
+        }
+    }
+}

src/ReSharper.Structured.Logging/Highlighting/PositionalPropertyUsedWarning.cs

@@ -0,0 +1,61 @@
+using JetBrains.DocumentModel;
+using JetBrains.ReSharper.Feature.Services.Daemon;
+using JetBrains.ReSharper.Psi.CSharp;
+using JetBrains.ReSharper.Psi.Util;
+
+using ReSharper.Structured.Logging.Highlighting;
+using ReSharper.Structured.Logging.Serilog.Parsing;
+
+[assembly:
+    RegisterConfigurableSeverity(
+        PositionalPropertyUsedWarning.SeverityId,
+        null,
+        HighlightingGroupIds.CompilerWarnings,
+        PositionalPropertyUsedWarning.Message,
+        PositionalPropertyUsedWarning.Message,
+        Severity.WARNING)]
+
+namespace ReSharper.Structured.Logging.Highlighting
+{
+    [ConfigurableSeverityHighlighting(
+        SeverityId,
+        CSharpLanguage.Name,
+        OverlapResolve = OverlapResolveKind.WARNING,
+        ToolTipFormatString = Message)]
+    public class PositionalPropertyUsedWarning : IHighlighting
+    {
+        public const string Message = "Prefer named properties instead of positional ones";
+
+        public const string SeverityId = "PositionalPropertyUsedProblem";
+
+        public PositionalPropertyUsedWarning(
+            IStringLiteralAlterer stringLiteral,
+            PropertyToken namedProperty,
+            DocumentRange documentRange)
+        {
+            StringLiteral = stringLiteral;
+            NamedProperty = namedProperty;
+            Range = documentRange;
+        }
+
+        public string ErrorStripeToolTip => ToolTip;
+
+        public PropertyToken NamedProperty { get; }
+
+        public DocumentRange Range { get; }
+
+        public IStringLiteralAlterer StringLiteral { get; }
+
+        public string ToolTip => Message;
+
+        public DocumentRange CalculateRange()
+        {
+            return Range;
+        }
+
+        public bool IsValid()
+        {
+            return Range.IsValid();
+        }
+    }
+}

src/ReSharper.Structured.Logging/Wiki/StructuredLoggingWikiDataProvider.cs

@@ -35,6 +35,10 @@ public class StructuredLoggingWikiDataProvider : ICodeInspectionWikiDataProvider
                                                                                       {
                                                                                           ComplexObjectDestructuringWarning.SeverityId,
                                                                                           CreateSeverityUrl(ComplexObjectDestructuringWarning.SeverityId)
+                                                                                      },
+                                                                                      {
+                                                                                          PositionalPropertyUsedWarning.SeverityId,
+                                                                                          CreateSeverityUrl(PositionalPropertyUsedWarning.SeverityId)
                                                                                       }
                                                                                   };
 

test/data/Analyzers/PositionalPropertiesUsage/SerilogPositionProperty.cs

@@ -0,0 +1,12 @@
+using Serilog;
+
+namespace ConsoleApp
+{
+    public static class Program
+    {
+        public static void Main()
+        {
+            Log.Logger.Information("{0}", 1);
+        }
+    }
+}

test/data/Analyzers/PositionalPropertiesUsage/SerilogPositionProperty.cs.gold

@@ -0,0 +1,16 @@
+using Serilog;
+
+namespace ConsoleApp
+{
+    public static class Program
+    {
+        public static void Main()
+        {
+            Log.Logger.Information("||{0}|(0)|(1)", 1);
+        }
+    }
+}
+
+---------------------------------------------------------
+(0): ReSharper Format String Item: 
+(1): ReSharper Warning: Prefer named properties instead of positional ones

test/data/Analyzers/TemplateFormat/SerilogInvalidPositionProperty.cs.gold

@@ -6,15 +6,18 @@ namespace ConsoleApp
     {
         public static void Main()
         {
-            Log.Logger.Information("|{0}|(0) ||{1}|(1)|(2)", 1);
-            Log.Logger.Information("|{1}|(3)", |1|(4), 2);
+            Log.Logger.Information("||{0}|(0)|(1) |||{1}|(2)|(3)|(4)", 1);
+            Log.Logger.Information("||{1}|(5)|(6)", |1|(7), 2);
         }
     }
 }
 
 ---------------------------------------------------------
 (0): ReSharper Format String Item: 
-(1): ReSharper Format String Item: 
-(2): ReSharper Warning: Non-existing argument in message template
+(1): ReSharper Warning: Prefer named properties instead of positional ones
+(2):<overlapped> ReSharper Warning: Non-existing argument in message template
 (3): ReSharper Format String Item: 
-(4): ReSharper Dead Code: Argument is not used in message template
+(4): ReSharper Warning: Prefer named properties instead of positional ones
+(5): ReSharper Format String Item: 
+(6): ReSharper Warning: Prefer named properties instead of positional ones
+(7): ReSharper Dead Code: Argument is not used in message template

test/data/Analyzers/TemplateFormat/SerilogValidPositionProperty.cs.gold

@@ -6,10 +6,11 @@ namespace ConsoleApp
     {
         public static void Main()
         {
-            Log.Logger.Information("|{0}|(0)", 1);
+            Log.Logger.Information("||{0}|(0)|(1)", 1);
         }
     }
 }
 
 ---------------------------------------------------------
 (0): ReSharper Format String Item: 
+(1): ReSharper Warning: Prefer named properties instead of positional ones

test/src/Analyzer/MessageTemplateTests.cs

@@ -44,7 +44,8 @@ protected override bool HighlightingPredicate(
                    || highlighting is AnonymousObjectDestructuringWarning
                    || highlighting is ContextualLoggerWarning
                    || highlighting is ExceptionPassedAsTemplateArgumentWarning
-                   || highlighting is ComplexObjectDestructuringWarning;
+                   || highlighting is ComplexObjectDestructuringWarning
+                   || highlighting is PositionalPropertyUsedWarning;
         }
     }
 }

test/src/Analyzer/PositionalPropertiesUsageAnalyzerTests.cs

@@ -0,0 +1,11 @@
+using NUnit.Framework;
+
+namespace ReSharper.Structured.Logging.Tests.Analyzer
+{
+    public class PositionalPropertiesUsageAnalyzerTests : MessageTemplateAnalyzerTestBase
+    {
+        protected override string SubPath => "PositionalPropertiesUsage";
+
+        [Test] public void TestSerilogPositionProperty() => DoNamedTest2();
+    }
+}