Mirrors/CliFx
1
0
Fork 0
mirror of https://github.com/Tyrrrz/CliFx.git synced 2025-10-25 15:19:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add analyzers for invalid validators

Browse Source
This commit is contained in:
Tyrrrz
2020-11-18 18:26:04 +02:00
parent d6da687170
commit f9f5a4696b
4 changed files with 164 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
CliFx.Analyzers/CommandSchemaAnalyzer.cs
View File

@@ -18,12 +18,14 @@ namespace CliFx.Analyzers
DiagnosticDescriptors.CliFx0023,
DiagnosticDescriptors.CliFx0024,
DiagnosticDescriptors.CliFx0025,
DiagnosticDescriptors.CliFx0026,
DiagnosticDescriptors.CliFx0041,
DiagnosticDescriptors.CliFx0042,
DiagnosticDescriptors.CliFx0043,
DiagnosticDescriptors.CliFx0044,
DiagnosticDescriptors.CliFx0045,
DiagnosticDescriptors.CliFx0046
DiagnosticDescriptors.CliFx0046,
DiagnosticDescriptors.CliFx0047
);
private static bool IsScalarType(ITypeSymbol typeSymbol) =>
@@ -57,14 +59,24 @@ namespace CliFx.Analyzers
.NamedArguments
.Where(a => a.Key == "Converter")
.Select(a => a.Value.Value)
.FirstOrDefault() as ITypeSymbol;
.Cast<ITypeSymbol?>()
.FirstOrDefault();
var validators = attribute
.NamedArguments
.Where(a => a.Key == "Validators")
.SelectMany(a => a.Value.Values)
.Select(c => c.Value)
.Cast<ITypeSymbol>()
.ToArray();
return new
{
Property = p,
Order = order,
Name = name,
Converter = converter
Converter = converter,
Validators = validators
};
})
.ToArray();
@@ -140,6 +152,18 @@ namespace CliFx.Analyzers
DiagnosticDescriptors.CliFx0025, parameter.Property.Locations.First()
));
}
// Invalid validators
var invalidValidatorsParameters = parameters
.Where(p => !p.Validators.All(v => v.AllInterfaces.Any(KnownSymbols.IsArgumentValueValidatorInterface)))
.ToArray();
foreach (var parameter in invalidValidatorsParameters)
{
context.ReportDiagnostic(Diagnostic.Create(
DiagnosticDescriptors.CliFx0026, parameter.Property.Locations.First()
));
}
}
private static void CheckCommandOptionProperties(
@@ -175,7 +199,16 @@ namespace CliFx.Analyzers
.NamedArguments
.Where(a => a.Key == "Converter")
.Select(a => a.Value.Value)
.FirstOrDefault() as ITypeSymbol;
.Cast<ITypeSymbol>()
.FirstOrDefault();
var validators = attribute
.NamedArguments
.Where(a => a.Key == "Validators")
.SelectMany(a => a.Value.Values)
.Select(c => c.Value)
.Cast<ITypeSymbol>()
.ToArray();
return new
{
@@ -183,7 +216,8 @@ namespace CliFx.Analyzers
Name = name,
ShortName = shortName,
EnvironmentVariableName = envVarName,
Converter = converter
Converter = converter,
Validators = validators
};
})
.ToArray();
@@ -270,6 +304,18 @@ namespace CliFx.Analyzers
DiagnosticDescriptors.CliFx0046, option.Property.Locations.First()
));
}
// Invalid validators
var invalidValidatorsOptions = options
.Where(p => !p.Validators.All(v => v.AllInterfaces.Any(KnownSymbols.IsArgumentValueValidatorInterface)))
.ToArray();
foreach (var option in invalidValidatorsOptions)
{
context.ReportDiagnostic(Diagnostic.Create(
DiagnosticDescriptors.CliFx0047, option.Property.Locations.First()
));
}
}
private static void CheckCommandType(SymbolAnalysisContext context)

14
CliFx.Analyzers/DiagnosticDescriptors.cs
View File

@@ -53,6 +53,13 @@ namespace CliFx.Analyzers
"Usage", DiagnosticSeverity.Error, true
);
public static readonly DiagnosticDescriptor CliFx0026 =
new DiagnosticDescriptor(nameof(CliFx0026),
"Parameter validator must implement 'CliFx.ArgumentValueValidator<T>'",
"Parameter validator must implement 'CliFx.ArgumentValueValidator<T>'",
"Usage", DiagnosticSeverity.Error, true
);
public static readonly DiagnosticDescriptor CliFx0041 =
new DiagnosticDescriptor(nameof(CliFx0041),
"Option must have a name or short name specified",
@@ -95,6 +102,13 @@ namespace CliFx.Analyzers
"Usage", DiagnosticSeverity.Error, true
);
public static readonly DiagnosticDescriptor CliFx0047 =
new DiagnosticDescriptor(nameof(CliFx0047),
"Option validator must implement 'CliFx.ArgumentValueValidator<T>'",
"Option validator must implement 'CliFx.ArgumentValueValidator<T>'",
"Usage", DiagnosticSeverity.Error, true
);
public static readonly DiagnosticDescriptor CliFx0100 =
new DiagnosticDescriptor(nameof(CliFx0100),
"Use the provided IConsole abstraction instead of System.Console to ensure that the command can be tested in isolation",

3
CliFx.Analyzers/KnownSymbols.cs
View File

@@ -28,6 +28,9 @@ namespace CliFx.Analyzers
public static bool IsArgumentValueConverterInterface(ISymbol symbol) =>
symbol.DisplayNameMatches("CliFx.IArgumentValueConverter");
public static bool IsArgumentValueValidatorInterface(ISymbol symbol) =>
symbol.DisplayNameMatches("CliFx.IArgumentValueValidator");
public static bool IsCommandAttribute(ISymbol symbol) =>
symbol.DisplayNameMatches("CliFx.Attributes.CommandAttribute");