StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix net field replacements not reported for a subclass reference (#471)

This commit is contained in:
Jesse Plamondon-Willard 2018-04-09 23:43:13 -04:00
parent c8db771e11
commit 971ed1a175
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/SMAPI.ModBuildConfig.Analyzer.Tests/UnitTests.cs
View File

@ -38,6 +38,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
public NetInt type { get; } = new NetInt { Value = 42 };
public NetRef refField { get; } = null;
}
class SObject : Item { }
}
namespace SampleMod
@ -47,9 +48,10 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
public void Entry()
{
Item item = null;
SObject obj = null;
// this line should raise diagnostics
{{test-code}} // line 36
{{test-code}} // line 38
// these lines should not
if (item.type.Value != 42);
@ -59,7 +61,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
";
/// <summary>The line number where the unit tested code is injected into <see cref="SampleProgram"/>.</summary>
private const int SampleCodeLine = 36;
private const int SampleCodeLine = 38;
/// <summary>The column number where the unit tested code is injected into <see cref="SampleProgram"/>.</summary>
private const int SampleCodeColumn = 25;
@ -93,6 +95,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
[TestCase("if (item.type != 42);", 4, "item.type", "NetInt", "int")]
[TestCase("if (item.refField != null);", 4, "item.refField", "NetRef", "object")]
[TestCase("if (item?.type != 42);", 4, "item?.type", "NetInt", "int")]
[TestCase("if (obj.type != 42);", 4, "obj.type", "NetInt", "int")]
public void AvoidImplicitNetFieldComparisons_RaisesDiagnostic(string codeText, int column, string expression, string fromType, string toType)
{
// arrange
@ -118,6 +121,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
[TestCase("int category = item.category;", 15, "item.category", "NetInt", "Category")]
[TestCase("int category = (item).category;", 15, "(item).category", "NetInt", "Category")]
[TestCase("int category = ((Item)item).category;", 15, "((Item)item).category", "NetInt", "Category")]
[TestCase("int category = obj.category;", 15, "obj.category", "NetInt", "Category")]
public void AvoidNetFields_RaisesDiagnostic(string codeText, int column, string expression, string netType, string suggestedProperty)
{
// arrange

8
src/SMAPI.ModBuildConfig.Analyzer/NetFieldAnalyzer.cs
View File

@ -209,9 +209,13 @@ namespace StardewModdingAPI.ModBuildConfig.Analyzer
string propertyName = node.Name.Identifier.Text;
// suggest replacement
if (this.NetFieldWrapperProperties.TryGetValue($"{declaringType}::{propertyName}", out string suggestedPropertyName))
for (ITypeSymbol type = declaringType; type != null; type = type.BaseType)
{
context.ReportDiagnostic(Diagnostic.Create(this.Rules["SMAPI002"], context.Node.GetLocation(), node, memberType.Type.Name, suggestedPropertyName));
if (this.NetFieldWrapperProperties.TryGetValue($"{type}::{propertyName}", out string suggestedPropertyName))
{
context.ReportDiagnostic(Diagnostic.Create(this.Rules["SMAPI002"], context.Node.GetLocation(), node, memberType.Type.Name, suggestedPropertyName));
break;
}
}
}
catch (Exception ex)