Add Rule0058PageVariableMethodOnTemporaryTable

Design/Rule0039ArgumentDifferentTypeThenExpected.cs

@@ -10,7 +10,10 @@ namespace BusinessCentral.LinterCop.Design
     [DiagnosticAnalyzer]
     public class Rule0039ArgumentDifferentTypeThenExpected : DiagnosticAnalyzer
     {
-        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create<DiagnosticDescriptor>(DiagnosticDescriptors.Rule0039ArgumentDifferentTypeThenExpected, DiagnosticDescriptors.Rule0049PageWithoutSourceTable);
+        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create<DiagnosticDescriptor>(DiagnosticDescriptors.Rule0039ArgumentDifferentTypeThenExpected, DiagnosticDescriptors.Rule0049PageWithoutSourceTable, DiagnosticDescriptors.Rule0058PageVariableMethodOnTemporaryTable);
+
+        private static readonly string[] pageProcedureNames = ["GetRecord", "SetRecord", "SetSelectionFilter", "SetTableView"];
+        private static readonly string[] pageRunProcedureNames = ["Run", "RunModal"];
 
         private static readonly List<PropertyKind> referencePageProviders = new List<PropertyKind>
         {
@@ -34,8 +37,7 @@ private void AnalyzeRunPageArguments(OperationAnalysisContext ctx)
             if (operation.TargetMethod.MethodKind != MethodKind.BuiltInMethod) return;
 
             if (operation.TargetMethod.ContainingType.GetTypeSymbol().GetNavTypeKindSafe() != NavTypeKind.Page) return;
-            string[] procedureNames = { "Run", "RunModal" };
-            if (!procedureNames.Contains(operation.TargetMethod.Name)) return;
+            if (!pageRunProcedureNames.Contains(operation.TargetMethod.Name)) return;
             if (operation.Arguments.Count() < 2) return;
 
             if (operation.Arguments[0].Syntax.Kind != SyntaxKind.OptionAccessExpression) return;
@@ -50,7 +52,7 @@ private void AnalyzeRunPageArguments(OperationAnalysisContext ctx)
             ITableTypeSymbol recordArgument = ((IRecordTypeSymbol)operand.GetSymbol().GetTypeSymbol()).BaseTable;
 
             if (!AreTheSameNavObjects(recordArgument, pageSourceTable))
-                ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.Rule0039ArgumentDifferentTypeThenExpected, ctx.Operation.Syntax.GetLocation(), new object[] { 2, operand.GetSymbol().GetTypeSymbol().ToString(), pageSourceTable.GetNavTypeKindSafe() + " \"" + pageSourceTable.Name + "\"" }));
+                ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.Rule0039ArgumentDifferentTypeThenExpected, ctx.Operation.Syntax.GetLocation(), new object[] { 2, operand.GetSymbol().GetTypeSymbol().ToString(), pageSourceTable.GetNavTypeKindSafe() + pageSourceTable.Name.QuoteIdentifierIfNeeded() }));
         }
 
         private void AnalyzeSetRecordArgument(OperationAnalysisContext ctx)
@@ -61,8 +63,7 @@ private void AnalyzeSetRecordArgument(OperationAnalysisContext ctx)
             if (operation.TargetMethod.MethodKind != MethodKind.BuiltInMethod) return;
 
             if (operation.TargetMethod.ContainingType.GetTypeSymbol().GetNavTypeKindSafe() != NavTypeKind.Page) return;
-            string[] procedureNames = { "GetRecord", "SetRecord", "SetSelectionFilter", "SetTableView" };
-            if (!procedureNames.Contains(operation.TargetMethod.Name)) return;
+            if (!pageProcedureNames.Contains(operation.TargetMethod.Name)) return;
             if (operation.Arguments.Count() != 1) return;
 
             if (operation.Arguments[0].Syntax.Kind != SyntaxKind.IdentifierName || operation.Arguments[0].Value.Kind != OperationKind.ConversionExpression) return;
@@ -78,14 +79,16 @@ private void AnalyzeSetRecordArgument(OperationAnalysisContext ctx)
                 ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.Rule0049PageWithoutSourceTable, ctx.Operation.Syntax.GetLocation(), new object[] { NavTypeKind.Page, GetFullyQualifiedObjectName(pageTypeSymbol) }));
                 return;
             }
-            ITableTypeSymbol pageSourceTable = pageTypeSymbol.RelatedTable;
 
             IOperation operand = ((IConversionExpression)operation.Arguments[0].Value).Operand;
-            ITypeSymbol typeSymbol = operand.GetSymbol().GetTypeSymbol();
-            if (typeSymbol.GetNavTypeKindSafe() != NavTypeKind.Record)
+            IRecordTypeSymbol recordTypeSymbol = operand.GetSymbol().GetTypeSymbol() as IRecordTypeSymbol;
+            if (recordTypeSymbol.Temporary && SemanticFacts.IsSameName(operation.TargetMethod.Name, "SetRecord"))
+            {
+                ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.Rule0058PageVariableMethodOnTemporaryTable, ctx.Operation.Syntax.GetLocation(), new object[] { variableSymbol.ToString().QuoteIdentifierIfNeeded(), operation.TargetMethod.Name }));
                 return;
-
-            ITableTypeSymbol recordArgument = ((IRecordTypeSymbol)typeSymbol).BaseTable;
+            }
+            ITableTypeSymbol pageSourceTable = pageTypeSymbol.RelatedTable;
+            ITableTypeSymbol recordArgument = recordTypeSymbol.BaseTable;
 
             if (!AreTheSameNavObjects(recordArgument, pageSourceTable))
                 ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.Rule0039ArgumentDifferentTypeThenExpected, ctx.Operation.Syntax.GetLocation(), new object[] { 1, operand.GetSymbol().GetTypeSymbol().ToString(), pageSourceTable.GetNavTypeKindSafe().ToString() + ' ' + pageSourceTable.Name.QuoteIdentifierIfNeeded() }));

LinterCop.ruleset.json

@@ -281,6 +281,11 @@
       "id": "LC0057",
       "action": "Info",
       "justification": "Enum values must have non-empty a Caption to be selectable in the client."
+    },
+    {
+      "id": "LC0058",
+      "action": "Warning",
+      "justification": "PageVariable.SetRecord(): You cannot use a temporary record for the Record parameter."
     }
   ]
 }

LinterCopAnalyzers.Generated.cs

@@ -63,5 +63,6 @@ public static class DiagnosticDescriptors
         public static readonly DiagnosticDescriptor Rule0055TokSuffixForTokenLabels = new DiagnosticDescriptor(LinterCopAnalyzers.AnalyzerPrefix + "0055", (LocalizableString)new LocalizableResourceString("Rule0055TokSuffixForTokenLabelsTitle", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), (LocalizableString)new LocalizableResourceString("Rule0055TokSuffixForTokenLabelsFormat", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "Design", DiagnosticSeverity.Info, true, (LocalizableString)new LocalizableResourceString("Rule0055TokSuffixForTokenLabelsDescription", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0055");
         public static readonly DiagnosticDescriptor Rule0056EmptyEnumValueWithCaption = new DiagnosticDescriptor(LinterCopAnalyzers.AnalyzerPrefix + "0056", (LocalizableString)new LocalizableResourceString("Rule0056EmptyEnumValueWithCaptionTitle", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), (LocalizableString)new LocalizableResourceString("Rule0056EmptyEnumValueWithCaptionFormat", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "Design", DiagnosticSeverity.Info, true, (LocalizableString)new LocalizableResourceString("Rule0056EmptyEnumValueWithCaptionDescription", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0056");
         public static readonly DiagnosticDescriptor Rule0057EnumValueWithEmptyCaption = new DiagnosticDescriptor(LinterCopAnalyzers.AnalyzerPrefix + "0057", (LocalizableString)new LocalizableResourceString("Rule0057EnumValueWithEmptyCaptionTitle", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), (LocalizableString)new LocalizableResourceString("Rule0057EnumValueWithEmptyCaptionFormat", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "Design", DiagnosticSeverity.Info, true, (LocalizableString)new LocalizableResourceString("Rule0057EnumValueWithEmptyCaptionDescription", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0057");
+        public static readonly DiagnosticDescriptor Rule0058PageVariableMethodOnTemporaryTable = new DiagnosticDescriptor(LinterCopAnalyzers.AnalyzerPrefix + "0058", (LocalizableString)new LocalizableResourceString("Rule0058PageVariableMethodOnTemporaryTableTitle", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), (LocalizableString)new LocalizableResourceString("Rule0058PageVariableMethodOnTemporaryTableFormat", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "Design", DiagnosticSeverity.Warning, true, (LocalizableString)new LocalizableResourceString("Rule0058PageVariableMethodOnTemporaryTableDescription", LinterCopAnalyzers.ResourceManager, typeof(LinterCopAnalyzers)), "https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0058");
     }
 }

LinterCopAnalyzers.resx

@@ -619,12 +619,12 @@
     <value>Enum values must have non-empty a Caption to be selectable in the client.</value>
   </data>
   <data name="Rule0058PageVariableMethodOnTemporaryTableTitle" xml:space="preserve">
-    <value>You cannot use a temporary record for the Record parameter on {0}.{1}."</value>
+    <value>{0}.{1}(): You cannot use a temporary record for the Record parameter.</value>
   </data>
   <data name="Rule0058PageVariableMethodOnTemporaryTableFormat" xml:space="preserve">
-    <value>You cannot use a temporary record for the Record parameter on {0}.{1}."</value>
+    <value>{0}.{1}(): You cannot use a temporary record for the Record parameter.</value>
   </data>
   <data name="Rule0058PageVariableMethodOnTemporaryTableDescription" xml:space="preserve">
-    <value>You cannot use a temporary record for the Record parameter on {0}.{1}."</value>
+    <value>{0}.{1}(): You cannot use a temporary record for the Record parameter.</value>
   </data>
 </root>

README.md

@@ -103,3 +103,4 @@ For an example and the default values see: [LinterCop.ruleset.json](LinterCop.ru
 |[LC0055](https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0055)|The suffix `Tok` is meant to be used when the value of the label matches the name.|Info|
 |[LC0056](https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0056)|Empty Enum values should not have a specified `Caption` property.|Info|
 |[LC0057](https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0057)|Enum values must have non-empty a `Caption` to be selectable in the client|Info|
+|[LC0058](https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0058)|PageVariable.SetRecord(): You cannot use a temporary record for the Record parameter.|Warning|