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

Merge branch 'master' into aot

Browse Source
This commit is contained in:
Tyrrrz
2024-05-27 20:57:50 +03:00
parent ae9c4e6d1e 30bc1d3330
commit 57db910489
51 changed files with 235 additions and 274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CliFx.Analyzers.Tests/CliFx.Analyzers.Tests.csproj
View File

@@ -9,15 +9,15 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.4.5" />
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.7.2" />
<PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
<PackageReference Include="GitHubActionsTestLogger" Version="2.3.3" PrivateAssets="all" />
<PackageReference Include="FluentAssertions" Version="6.12.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" />
<PackageReference Include="xunit" Version="2.6.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.3" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.9.2" />
<PackageReference Include="xunit" Version="2.8.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.0" PrivateAssets="all" />
</ItemGroup>
<ItemGroup>

3
CliFx.Analyzers.Tests/GeneralSpecs.cs
View File

@@ -13,8 +13,7 @@ public class GeneralSpecs
{
// Arrange
var analyzers = typeof(AnalyzerBase)
.Assembly
.GetTypes()
.Assembly.GetTypes()
.Where(t => !t.IsAbstract && t.IsAssignableTo(typeof(DiagnosticAnalyzer)))
.Select(t => (DiagnosticAnalyzer)Activator.CreateInstance(t)!)
.ToArray();

8
CliFx.Analyzers.Tests/OptionMustHaveNameOrShortNameAnalyzerSpecs.cs
View File

@@ -20,7 +20,7 @@ public class OptionMustHaveNameOrShortNameAnalyzerSpecs
{
[CommandOption(null)]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -40,7 +40,7 @@ public class OptionMustHaveNameOrShortNameAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -60,7 +60,7 @@ public class OptionMustHaveNameOrShortNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -79,7 +79,7 @@ public class OptionMustHaveNameOrShortNameAnalyzerSpecs
public class MyCommand : ICommand
{
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

12
CliFx.Analyzers.Tests/OptionMustHaveUniqueNameAnalyzerSpecs.cs
View File

@@ -19,10 +19,10 @@ public class OptionMustHaveUniqueNameAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
[CommandOption("foo")]
public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -42,10 +42,10 @@ public class OptionMustHaveUniqueNameAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
[CommandOption("bar")]
public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -65,7 +65,7 @@ public class OptionMustHaveUniqueNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -84,7 +84,7 @@ public class OptionMustHaveUniqueNameAnalyzerSpecs
public class MyCommand : ICommand
{
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

16
CliFx.Analyzers.Tests/OptionMustHaveUniqueShortNameAnalyzerSpecs.cs
View File

@@ -20,10 +20,10 @@ public class OptionMustHaveUniqueShortNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
[CommandOption('f')]
public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -43,10 +43,10 @@ public class OptionMustHaveUniqueShortNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
[CommandOption('b')]
public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -66,10 +66,10 @@ public class OptionMustHaveUniqueShortNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
[CommandOption('F')]
public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -89,7 +89,7 @@ public class OptionMustHaveUniqueShortNameAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -108,7 +108,7 @@ public class OptionMustHaveUniqueShortNameAnalyzerSpecs
public class MyCommand : ICommand
{
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

10
CliFx.Analyzers.Tests/OptionMustHaveValidNameAnalyzerSpecs.cs
View File

@@ -19,7 +19,7 @@ public class OptionMustHaveValidNameAnalyzerSpecs
{
[CommandOption("f")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -39,7 +39,7 @@ public class OptionMustHaveValidNameAnalyzerSpecs
{
[CommandOption("1foo")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -59,7 +59,7 @@ public class OptionMustHaveValidNameAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -79,7 +79,7 @@ public class OptionMustHaveValidNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -98,7 +98,7 @@ public class OptionMustHaveValidNameAnalyzerSpecs
public class MyCommand : ICommand
{
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

8
CliFx.Analyzers.Tests/OptionMustHaveValidShortNameAnalyzerSpecs.cs
View File

@@ -20,7 +20,7 @@ public class OptionMustHaveValidShortNameAnalyzerSpecs
{
[CommandOption('1')]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -40,7 +40,7 @@ public class OptionMustHaveValidShortNameAnalyzerSpecs
{
[CommandOption('f')]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -60,7 +60,7 @@ public class OptionMustHaveValidShortNameAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -79,7 +79,7 @@ public class OptionMustHaveValidShortNameAnalyzerSpecs
public class MyCommand : ICommand
{
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

16
CliFx.Analyzers.Tests/OptionMustHaveValidValidatorsAnalyzerSpecs.cs
View File

@@ -19,13 +19,13 @@ public class OptionMustHaveValidValidatorsAnalyzerSpecs
{
public void Validate(string value) {}
}
[Command]
public class MyCommand : ICommand
{
[CommandOption("foo", Validators = new[] { typeof(MyValidator) })]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -44,13 +44,13 @@ public class OptionMustHaveValidValidatorsAnalyzerSpecs
{
public override BindingValidationError Validate(int value) => Ok();
}
[Command]
public class MyCommand : ICommand
{
[CommandOption("foo", Validators = new[] { typeof(MyValidator) })]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -69,13 +69,13 @@ public class OptionMustHaveValidValidatorsAnalyzerSpecs
{
public override BindingValidationError Validate(string value) => Ok();
}
[Command]
public class MyCommand : ICommand
{
[CommandOption("foo", Validators = new[] { typeof(MyValidator) })]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -95,7 +95,7 @@ public class OptionMustHaveValidValidatorsAnalyzerSpecs
{
[CommandOption("foo")]
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
@@ -114,7 +114,7 @@ public class OptionMustHaveValidValidatorsAnalyzerSpecs
public class MyCommand : ICommand
{
public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

2
CliFx.Analyzers.Tests/SystemConsoleShouldBeAvoidedAnalyzerSpecs.cs
View File

@@ -103,7 +103,7 @@ public class SystemConsoleShouldBeAvoidedAnalyzerSpecs
public class MyCommand : ICommand
{
public void SomeOtherMethod() => Console.WriteLine("Test");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";

16
CliFx.Analyzers.Tests/Utils/AnalyzerAssertions.cs
View File

@@ -30,8 +30,7 @@ internal class AnalyzerAssertions(DiagnosticAnalyzer analyzer)
// Get default CliFx namespaces
var defaultCliFxNamespaces = typeof(ICommand)
.Assembly
.GetTypes()
.Assembly.GetTypes()
.Where(t => t.IsPublic)
.Select(t => t.Namespace)
.Distinct()
@@ -54,10 +53,9 @@ internal class AnalyzerAssertions(DiagnosticAnalyzer analyzer)
var compilation = CSharpCompilation.Create(
"CliFxTests_DynamicAssembly_" + Guid.NewGuid(),
[ast],
Net80
.References
.All
.Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)),
Net80.References.All.Append(
MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)
),
// DLL to avoid having to define the Main() method
new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)
);
@@ -105,8 +103,7 @@ internal class AnalyzerAssertions(DiagnosticAnalyzer analyzer)
== expectedDiagnosticIds.Length;
Execute
.Assertion
.ForCondition(isSuccessfulAssertion)
.Assertion.ForCondition(isSuccessfulAssertion)
.FailWith(() =>
{
var buffer = new StringBuilder();
@@ -150,8 +147,7 @@ internal class AnalyzerAssertions(DiagnosticAnalyzer analyzer)
var isSuccessfulAssertion = !producedDiagnostics.Any();
Execute
.Assertion
.ForCondition(isSuccessfulAssertion)
.Assertion.ForCondition(isSuccessfulAssertion)
.FailWith(() =>
{
var buffer = new StringBuilder();

4
CliFx.Analyzers/CliFx.Analyzers.csproj
View File

@@ -17,11 +17,11 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
<!-- Make sure to target the lowest possible version of the compiler for wider support -->
<PackageReference Include="Microsoft.CodeAnalysis" Version="3.0.0" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.0.0" PrivateAssets="all" />
<PackageReference Include="PolyShim" Version="1.8.0" PrivateAssets="all" />
<PackageReference Include="PolyShim" Version="1.10.0" PrivateAssets="all" />
</ItemGroup>
</Project>

4
CliFx.Analyzers/CommandMustBeAnnotatedAnalyzer.cs
View File

@@ -26,8 +26,8 @@ public class CommandMustBeAnnotatedAnalyzer()
if (type.IsAbstract)
return;
var implementsCommandInterface = type.AllInterfaces.Any(
i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
var implementsCommandInterface = type.AllInterfaces.Any(i =>
i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
);
var hasCommandAttribute = type.GetAttributes()

4
CliFx.Analyzers/CommandMustImplementInterfaceAnalyzer.cs
View File

@@ -24,8 +24,8 @@ public class CommandMustImplementInterfaceAnalyzer()
.Select(a => a.AttributeClass)
.Any(c => c.DisplayNameMatches(SymbolNames.CliFxCommandAttribute));
var implementsCommandInterface = type.AllInterfaces.Any(
i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
var implementsCommandInterface = type.AllInterfaces.Any(i =>
i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
);
// If the attribute is present, but the interface is not implemented,

22
CliFx.Analyzers/ObjectModel/CommandOptionSymbol.cs
View File

@@ -32,10 +32,9 @@ internal partial class CommandOptionSymbol
private static AttributeData? TryGetOptionAttribute(IPropertySymbol property) =>
property
.GetAttributes()
.FirstOrDefault(
a =>
a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandOptionAttribute)
== true
.FirstOrDefault(a =>
a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandOptionAttribute)
== true
);
public static CommandOptionSymbol? TryResolve(IPropertySymbol property)
@@ -46,35 +45,30 @@ internal partial class CommandOptionSymbol
var name =
attribute
.ConstructorArguments
.Where(a => a.Type?.SpecialType == SpecialType.System_String)
.ConstructorArguments.Where(a => a.Type?.SpecialType == SpecialType.System_String)
.Select(a => a.Value)
.FirstOrDefault() as string;
var shortName =
attribute
.ConstructorArguments
.Where(a => a.Type?.SpecialType == SpecialType.System_Char)
.ConstructorArguments.Where(a => a.Type?.SpecialType == SpecialType.System_Char)
.Select(a => a.Value)
.FirstOrDefault() as char?;
var isRequired =
attribute
.NamedArguments
.Where(a => a.Key == "IsRequired")
.NamedArguments.Where(a => a.Key == "IsRequired")
.Select(a => a.Value.Value)
.FirstOrDefault() as bool?;
var converter = attribute
.NamedArguments
.Where(a => a.Key == "Converter")
.NamedArguments.Where(a => a.Key == "Converter")
.Select(a => a.Value.Value)
.Cast<ITypeSymbol?>()
.FirstOrDefault();
var validators = attribute
.NamedArguments
.Where(a => a.Key == "Validators")
.NamedArguments.Where(a => a.Key == "Validators")
.SelectMany(a => a.Value.Values)
.Select(c => c.Value)
.Cast<ITypeSymbol>()

19
CliFx.Analyzers/ObjectModel/CommandParameterSymbol.cs
View File

@@ -32,10 +32,9 @@ internal partial class CommandParameterSymbol
private static AttributeData? TryGetParameterAttribute(IPropertySymbol property) =>
property
.GetAttributes()
.FirstOrDefault(
a =>
a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandParameterAttribute)
== true
.FirstOrDefault(a =>
a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandParameterAttribute)
== true
);
public static CommandParameterSymbol? TryResolve(IPropertySymbol property)
@@ -48,28 +47,24 @@ internal partial class CommandParameterSymbol
var name =
attribute
.NamedArguments
.Where(a => a.Key == "Name")
.NamedArguments.Where(a => a.Key == "Name")
.Select(a => a.Value.Value)
.FirstOrDefault() as string;
var isRequired =
attribute
.NamedArguments
.Where(a => a.Key == "IsRequired")
.NamedArguments.Where(a => a.Key == "IsRequired")
.Select(a => a.Value.Value)
.FirstOrDefault() as bool?;
var converter = attribute
.NamedArguments
.Where(a => a.Key == "Converter")
.NamedArguments.Where(a => a.Key == "Converter")
.Select(a => a.Value.Value)
.Cast<ITypeSymbol?>()
.FirstOrDefault();
var validators = attribute
.NamedArguments
.Where(a => a.Key == "Validators")
.NamedArguments.Where(a => a.Key == "Validators")
.SelectMany(a => a.Value.Values)
.Select(c => c.Value)
.Cast<ITypeSymbol>()

7
CliFx.Analyzers/OptionMustBeInsideCommandAnalyzer.cs
View File

@@ -29,10 +29,9 @@ public class OptionMustBeInsideCommandAnalyzer()
if (!CommandOptionSymbol.IsOptionProperty(property))
return;
var isInsideCommand = property
.ContainingType
.AllInterfaces
.Any(i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface));
var isInsideCommand = property.ContainingType.AllInterfaces.Any(i =>
i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
);
if (!isInsideCommand)
{

3
CliFx.Analyzers/OptionMustHaveUniqueNameAnalyzer.cs
View File

@@ -34,8 +34,7 @@ public class OptionMustHaveUniqueNameAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

3
CliFx.Analyzers/OptionMustHaveUniqueShortNameAnalyzer.cs
View File

@@ -33,8 +33,7 @@ public class OptionMustHaveUniqueShortNameAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

17
CliFx.Analyzers/OptionMustHaveValidConverterAnalyzer.cs
View File

@@ -28,13 +28,11 @@ public class OptionMustHaveValidConverterAnalyzer()
return;
var converterValueType = option
.ConverterType
.GetBaseTypes()
.FirstOrDefault(
t => t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass)
.ConverterType.GetBaseTypes()
.FirstOrDefault(t =>
t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass)
)
?.TypeArguments
.FirstOrDefault();
?.TypeArguments.FirstOrDefault();
// Value returned by the converter must be assignable to the property type
var isCompatible =
@@ -45,9 +43,10 @@ public class OptionMustHaveValidConverterAnalyzer()
? context.Compilation.IsAssignable(converterValueType, property.Type)
// Non-scalar (assume we can handle all IEnumerable types for simplicity)
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType
&& context
.Compilation
.IsAssignable(converterValueType, enumerableUnderlyingType)
&& context.Compilation.IsAssignable(
converterValueType,
enumerableUnderlyingType
)
);
if (!isCompatible)

8
CliFx.Analyzers/OptionMustHaveValidValidatorsAnalyzer.cs
View File

@@ -28,12 +28,10 @@ public class OptionMustHaveValidValidatorsAnalyzer()
{
var validatorValueType = validatorType
.GetBaseTypes()
.FirstOrDefault(
t =>
t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass)
.FirstOrDefault(t =>
t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass)
)
?.TypeArguments
.FirstOrDefault();
?.TypeArguments.FirstOrDefault();
// Value passed to the validator must be assignable from the property type
var isCompatible =

7
CliFx.Analyzers/ParameterMustBeInsideCommandAnalyzer.cs
View File

@@ -29,10 +29,9 @@ public class ParameterMustBeInsideCommandAnalyzer()
if (!CommandParameterSymbol.IsParameterProperty(property))
return;
var isInsideCommand = property
.ContainingType
.AllInterfaces
.Any(i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface));
var isInsideCommand = property.ContainingType.AllInterfaces.Any(i =>
i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
);
if (!isInsideCommand)
{

3
CliFx.Analyzers/ParameterMustBeLastIfNonRequiredAnalyzer.cs
View File

@@ -32,8 +32,7 @@ public class ParameterMustBeLastIfNonRequiredAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

3
CliFx.Analyzers/ParameterMustBeLastIfNonScalarAnalyzer.cs
View File

@@ -32,8 +32,7 @@ public class ParameterMustBeLastIfNonScalarAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

3
CliFx.Analyzers/ParameterMustBeSingleIfNonRequiredAnalyzer.cs
View File

@@ -32,8 +32,7 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

3
CliFx.Analyzers/ParameterMustBeSingleIfNonScalarAnalyzer.cs
View File

@@ -32,8 +32,7 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

3
CliFx.Analyzers/ParameterMustHaveUniqueNameAnalyzer.cs
View File

@@ -34,8 +34,7 @@ public class ParameterMustHaveUniqueNameAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

3
CliFx.Analyzers/ParameterMustHaveUniqueOrderAnalyzer.cs
View File

@@ -30,8 +30,7 @@ public class ParameterMustHaveUniqueOrderAnalyzer()
return;
var otherProperties = property
.ContainingType
.GetMembers()
.ContainingType.GetMembers()
.OfType<IPropertySymbol>()
.Where(m => !m.Equals(property))
.ToArray();

17
CliFx.Analyzers/ParameterMustHaveValidConverterAnalyzer.cs
View File

@@ -28,13 +28,11 @@ public class ParameterMustHaveValidConverterAnalyzer()
return;
var converterValueType = parameter
.ConverterType
.GetBaseTypes()
.FirstOrDefault(
t => t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass)
.ConverterType.GetBaseTypes()
.FirstOrDefault(t =>
t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass)
)
?.TypeArguments
.FirstOrDefault();
?.TypeArguments.FirstOrDefault();
// Value returned by the converter must be assignable to the property type
var isCompatible =
@@ -45,9 +43,10 @@ public class ParameterMustHaveValidConverterAnalyzer()
? context.Compilation.IsAssignable(converterValueType, property.Type)
// Non-scalar (assume we can handle all IEnumerable types for simplicity)
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType
&& context
.Compilation
.IsAssignable(converterValueType, enumerableUnderlyingType)
&& context.Compilation.IsAssignable(
converterValueType,
enumerableUnderlyingType
)
);
if (!isCompatible)

8
CliFx.Analyzers/ParameterMustHaveValidValidatorsAnalyzer.cs
View File

@@ -28,12 +28,10 @@ public class ParameterMustHaveValidValidatorsAnalyzer()
{
var validatorValueType = validatorType
.GetBaseTypes()
.FirstOrDefault(
t =>
t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass)
.FirstOrDefault(t =>
t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass)
)
?.TypeArguments
.FirstOrDefault();
?.TypeArguments.FirstOrDefault();
// Value passed to the validator must be assignable from the property type
var isCompatible =

3
CliFx.Analyzers/SystemConsoleShouldBeAvoidedAnalyzer.cs
View File

@@ -52,8 +52,7 @@ public class SystemConsoleShouldBeAvoidedAnalyzer()
// Check if IConsole is available in scope as an alternative to System.Console
var isConsoleInterfaceAvailable = context
.Node
.Ancestors()
.Node.Ancestors()
.OfType<MethodDeclarationSyntax>()
.SelectMany(m => m.ParameterList.Parameters)
.Select(p => p.Type)

12
CliFx.Analyzers/Utils/Extensions/RoslynExtensions.cs
View File

@@ -30,11 +30,10 @@ internal static class RoslynExtensions
}
public static ITypeSymbol? TryGetEnumerableUnderlyingType(this ITypeSymbol type) =>
type.AllInterfaces
.FirstOrDefault(
i =>
i.ConstructedFrom.SpecialType
== SpecialType.System_Collections_Generic_IEnumerable_T
type
.AllInterfaces.FirstOrDefault(i =>
i.ConstructedFrom.SpecialType
== SpecialType.System_Collections_Generic_IEnumerable_T
)
?.TypeArguments[0];
@@ -44,8 +43,7 @@ internal static class RoslynExtensions
property
// Can't rely on the RequiredMemberAttribute because it's generated by the compiler, not added by the user,
// so we have to check for the presence of the `required` modifier in the syntax tree instead.
.DeclaringSyntaxReferences
.Select(r => r.GetSyntax())
.DeclaringSyntaxReferences.Select(r => r.GetSyntax())
.OfType<PropertyDeclarationSyntax>()
.SelectMany(p => p.Modifiers)
.Any(m => m.IsKind((SyntaxKind)8447));

6
CliFx.Benchmarks/CliFx.Benchmarks.csproj
View File

@@ -6,12 +6,12 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="BenchmarkDotNet" Version="0.13.11" />
<PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
<PackageReference Include="clipr" Version="1.6.1" />
<PackageReference Include="Cocona" Version="2.2.0" />
<PackageReference Include="CommandLineParser" Version="2.9.1" />
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.1.0" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.1.1" />
<PackageReference Include="PowerArgs" Version="4.0.3" />
<PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" />
</ItemGroup>

2
CliFx.Demo/CliFx.Demo.csproj
View File

@@ -7,7 +7,7 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
</ItemGroup>

2
CliFx.Tests.Dummy/CliFx.Tests.Dummy.csproj
View File

@@ -7,7 +7,7 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
</ItemGroup>
<ItemGroup>

18
CliFx.Tests/CliFx.Tests.csproj
View File

@@ -9,18 +9,18 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.4.5" />
<PackageReference Include="CliWrap" Version="3.6.4" />
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.7.2" />
<PackageReference Include="CliWrap" Version="3.6.6" />
<PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
<PackageReference Include="FluentAssertions" Version="6.12.0" />
<PackageReference Include="GitHubActionsTestLogger" Version="2.3.3" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.9.2" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="PolyShim" Version="1.8.0" PrivateAssets="all" />
<PackageReference Include="xunit" Version="2.6.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.5" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="PolyShim" Version="1.10.0" PrivateAssets="all" />
<PackageReference Include="xunit" Version="2.8.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.0" PrivateAssets="all" />
</ItemGroup>
<ItemGroup>

13
CliFx.Tests/Utils/DynamicCommandBuilder.cs
View File

@@ -32,8 +32,7 @@ internal static class DynamicCommandBuilder
// Get default CliFx namespaces
var defaultCliFxNamespaces = typeof(ICommand)
.Assembly
.GetTypes()
.Assembly.GetTypes()
.Where(t => t.IsPublic)
.Select(t => t.Namespace)
.Distinct()
@@ -57,9 +56,9 @@ internal static class DynamicCommandBuilder
"CliFxTests_DynamicAssembly_" + Guid.NewGuid(),
[ast],
Net80
.References
.All
.Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location))
.References.All.Append(
MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)
)
.Append(
MetadataReference.CreateFromFile(
typeof(DynamicCommandBuilder).Assembly.Location
@@ -88,8 +87,8 @@ internal static class DynamicCommandBuilder
using var buffer = new MemoryStream();
var emit = compilation.Emit(buffer);
var emitErrors = emit.Diagnostics
.Where(d => d.Severity >= DiagnosticSeverity.Error)
var emitErrors = emit
.Diagnostics.Where(d => d.Severity >= DiagnosticSeverity.Error)
.ToArray();
if (emitErrors.Any())

11
CliFx.Tests/Utils/Extensions/AssertionExtensions.cs
View File

@@ -13,8 +13,7 @@ internal static class AssertionExtensions
IEnumerable<string> lines
) =>
assertions
.Subject
.Split(new[] { '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries)
.Subject.Split(new[] { '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries)
.Should()
.Equal(lines);
@@ -34,11 +33,9 @@ internal static class AssertionExtensions
if (index < 0)
{
Execute
.Assertion
.FailWith(
$"Expected string '{assertions.Subject}' to contain '{value}' after position {lastIndex}."
);
Execute.Assertion.FailWith(
$"Expected string '{assertions.Subject}' to contain '{value}' after position {lastIndex}."
);
}
lastIndex = index;

8
CliFx/CliApplication.cs
View File

@@ -56,11 +56,9 @@ public class CliApplication(
{
using (console.WithForegroundColor(ConsoleColor.Green))
{
console
.Output
.WriteLine(
$"Attach the debugger to process with ID {ProcessEx.GetCurrentProcessId()} to continue."
);
console.Output.WriteLine(
$"Attach the debugger to process with ID {ProcessEx.GetCurrentProcessId()} to continue."
);
}
// Try to also launch the debugger ourselves (only works with Visual Studio)

3
CliFx/CliApplicationBuilder.cs
View File

@@ -186,7 +186,8 @@ public partial class CliApplicationBuilder
/// Configures the application to use the specified service provider for activating types.
/// </summary>
public CliApplicationBuilder UseTypeActivator(IServiceProvider serviceProvider) =>
UseTypeActivator(serviceProvider.GetService);
// Null returns are handled by DelegateTypeActivator
UseTypeActivator(serviceProvider.GetService!);
/// <summary>
/// Configures the application to use the specified service provider for activating types.

4
CliFx/CliFx.csproj
View File

@@ -23,9 +23,9 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="CSharpier.MsBuild" Version="0.26.5" PrivateAssets="all" />
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
<PackageReference Include="PolyShim" Version="1.8.0" PrivateAssets="all" />
<PackageReference Include="PolyShim" Version="1.10.0" PrivateAssets="all" />
<PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
</ItemGroup>

35
CliFx/CommandBinder.cs
View File

@@ -42,13 +42,15 @@ internal class CommandBinder(ITypeActivator typeActivator)
// Special case for DateTimeOffset
if (targetType == typeof(DateTimeOffset))
{
return DateTimeOffset.Parse(rawValue, _formatProvider);
// Null reference exception will be handled upstream
return DateTimeOffset.Parse(rawValue!, _formatProvider);
}
// Special case for TimeSpan
if (targetType == typeof(TimeSpan))
{
return TimeSpan.Parse(rawValue, _formatProvider);
// Null reference exception will be handled upstream
return TimeSpan.Parse(rawValue!, _formatProvider);
}
// Enum
@@ -143,10 +145,8 @@ internal class CommandBinder(ITypeActivator typeActivator)
try
{
// Non-scalar
var enumerableUnderlyingType = memberSchema
.Property
.Type
.TryGetEnumerableUnderlyingType();
var enumerableUnderlyingType =
memberSchema.Property.Type.TryGetEnumerableUnderlyingType();
if (
enumerableUnderlyingType is not null
@@ -244,8 +244,7 @@ internal class CommandBinder(ITypeActivator typeActivator)
// Ensure there are no unexpected parameters and that all parameters are provided
var remainingParameterInputs = commandInput.Parameters.ToList();
var remainingRequiredParameterSchemas = commandSchema
.Parameters
.Where(p => p.IsRequired)
.Parameters.Where(p => p.IsRequired)
.ToList();
var position = 0;
@@ -298,7 +297,9 @@ internal class CommandBinder(ITypeActivator typeActivator)
throw CliFxException.UserError(
$"""
Missing required parameter(s):
{remainingRequiredParameterSchemas.Select(p => p.GetFormattedIdentifier()).JoinToString(" ")}
{remainingRequiredParameterSchemas
.Select(p => p.GetFormattedIdentifier())
.JoinToString(" ")}
"""
);
}
@@ -313,20 +314,18 @@ internal class CommandBinder(ITypeActivator typeActivator)
// Ensure there are no unrecognized options and that all required options are set
var remainingOptionInputs = commandInput.Options.ToList();
var remainingRequiredOptionSchemas = commandSchema
.Options
.Where(o => o.IsRequired)
.Options.Where(o => o.IsRequired)
.ToList();
foreach (var optionSchema in commandSchema.Options)
{
var optionInputs = commandInput
.Options
.Where(o => optionSchema.MatchesIdentifier(o.Identifier))
.Options.Where(o => optionSchema.MatchesIdentifier(o.Identifier))
.ToArray();
var environmentVariableInput = commandInput
.EnvironmentVariables
.FirstOrDefault(e => optionSchema.MatchesEnvironmentVariable(e.Name));
var environmentVariableInput = commandInput.EnvironmentVariables.FirstOrDefault(e =>
optionSchema.MatchesEnvironmentVariable(e.Name)
);
// Direct input
if (optionInputs.Any())
@@ -376,7 +375,9 @@ internal class CommandBinder(ITypeActivator typeActivator)
throw CliFxException.UserError(
$"""
Missing required option(s):
{remainingRequiredOptionSchemas.Select(o => o.GetFormattedIdentifier()).JoinToString(", ")}
{remainingRequiredOptionSchemas
.Select(o => o.GetFormattedIdentifier())
.JoinToString(", ")}
"""
);
}

15
CliFx/Formatting/HelpConsoleFormatter.cs
View File

@@ -99,9 +99,9 @@ internal class HelpConsoleFormatter(ConsoleWriter consoleWriter, HelpContext con
}
// Child command usage
var childCommandSchemas = context
.ApplicationSchema
.GetChildCommands(context.CommandSchema.Name);
var childCommandSchemas = context.ApplicationSchema.GetChildCommands(
context.CommandSchema.Name
);
if (childCommandSchemas.Any())
{
@@ -359,8 +359,7 @@ internal class HelpConsoleFormatter(ConsoleWriter consoleWriter, HelpContext con
private void WriteCommandChildren()
{
var childCommandSchemas = context
.ApplicationSchema
.GetChildCommands(context.CommandSchema.Name)
.ApplicationSchema.GetChildCommands(context.CommandSchema.Name)
.OrderBy(a => a.Name, StringComparer.Ordinal)
.ToArray();
@@ -393,8 +392,7 @@ internal class HelpConsoleFormatter(ConsoleWriter consoleWriter, HelpContext con
// Child commands of child command
var grandChildCommandSchemas = context
.ApplicationSchema
.GetChildCommands(childCommandSchema.Name)
.ApplicationSchema.GetChildCommands(childCommandSchema.Name)
.OrderBy(c => c.Name, StringComparer.Ordinal)
.ToArray();
@@ -418,8 +416,7 @@ internal class HelpConsoleFormatter(ConsoleWriter consoleWriter, HelpContext con
ConsoleColor.Cyan,
// Relative to current command (not the parent)
grandChildCommandSchema
.Name
?.Substring(context.CommandSchema.Name?.Length ?? 0)
.Name?.Substring(context.CommandSchema.Name?.Length ?? 0)
.Trim()
);
}

4
CliFx/Infrastructure/ConsoleWriter.cs
View File

@@ -45,7 +45,7 @@ public class ConsoleWriter : StreamWriter
/// <inheritdoc />
[ExcludeFromCodeCoverage, MethodImpl(MethodImplOptions.Synchronized)]
public override void Write(char[] buffer) => base.Write(buffer);
public override void Write(char[]? buffer) => base.Write(buffer);
/// <inheritdoc />
[ExcludeFromCodeCoverage, MethodImpl(MethodImplOptions.Synchronized)]
@@ -147,7 +147,7 @@ public class ConsoleWriter : StreamWriter
/// <inheritdoc />
[ExcludeFromCodeCoverage, MethodImpl(MethodImplOptions.Synchronized)]
public override void WriteLine(char[] buffer) => base.WriteLine(buffer);
public override void WriteLine(char[]? buffer) => base.WriteLine(buffer);
/// <inheritdoc />
[ExcludeFromCodeCoverage, MethodImpl(MethodImplOptions.Synchronized)]

8
CliFx/Infrastructure/DefaultTypeActivator.cs
View File

@@ -14,7 +14,13 @@ public class DefaultTypeActivator : ITypeActivator
{
try
{
return Activator.CreateInstance(type);
return Activator.CreateInstance(type)
?? throw CliFxException.InternalError(
$"""
Failed to create an instance of type `{type.FullName}`, received <null> instead.
This may be caused by the type's constructor being trimmed away.
"""
);
}
// Only catch MemberAccessException because the constructor can throw for its own reasons too
catch (MemberAccessException ex)

26
CliFx/Infrastructure/DelegateTypeActivator.cs
View File

@@ -9,21 +9,13 @@ namespace CliFx.Infrastructure;
public class DelegateTypeActivator(Func<Type, object> createInstance) : ITypeActivator
{
/// <inheritdoc />
public object CreateInstance(Type type)
{
var instance = createInstance(type);
if (instance is null)
{
throw CliFxException.InternalError(
$"""
Failed to create an instance of type `{type.FullName}`, received <null> instead.
To fix this, ensure that the provided type activator is configured correctly, as it's not expected to return <null>.
If you are relying on a dependency container, this error may indicate that the specified type has not been registered.
"""
);
}
return instance;
}
public object CreateInstance(Type type) =>
createInstance(type)
?? throw CliFxException.InternalError(
$"""
Failed to create an instance of type `{type.FullName}`, received <null> instead.
To fix this, ensure that the provided type activator is configured correctly, as it's not expected to return <null>.
If you are relying on a dependency container, this error may indicate that the specified type has not been registered.
"""
);
}

7
CliFx/Schema/ApplicationSchema.cs
View File

@@ -39,9 +39,10 @@ internal partial class ApplicationSchema(IReadOnlyList<CommandSchema> commands)
string.IsNullOrWhiteSpace(parentCommandName)
||
// Otherwise a command is a descendant if it starts with the same name segments
potentialParentCommandSchema
.Name
.StartsWith(parentCommandName + ' ', StringComparison.OrdinalIgnoreCase);
potentialParentCommandSchema.Name.StartsWith(
parentCommandName + ' ',
StringComparison.OrdinalIgnoreCase
);
if (isDescendant)
result.Add(potentialParentCommandSchema);

12
CliFx/Schema/CommandSchema.cs
View File

@@ -86,10 +86,14 @@ internal partial class CommandSchema
type.GetInterfaces()
// Only interfaces implementing ICommand for explicitness
.Where(i => i != typeof(ICommand) && i.IsAssignableTo(typeof(ICommand)))
.SelectMany(
i =>
i.GetProperties()
.Where(p => !p.GetMethod.IsAbstract && !p.SetMethod.IsAbstract)
.SelectMany(i =>
i.GetProperties()
.Where(p =>
p.GetMethod is not null
&& !p.GetMethod.IsAbstract
&& p.SetMethod is not null
&& !p.SetMethod.IsAbstract
)
)
)
.ToArray();

5
CliFx/Utils/Extensions/CollectionExtensions.cs
View File

@@ -42,10 +42,11 @@ internal static class CollectionExtensions
public static Dictionary<TKey, TValue> ToDictionary<TKey, TValue>(
this IDictionary dictionary,
IEqualityComparer<TKey> comparer
) =>
)
where TKey : notnull =>
dictionary
.Cast<DictionaryEntry>()
.ToDictionary(entry => (TKey)entry.Key, entry => (TValue)entry.Value, comparer);
.ToDictionary(entry => (TKey)entry.Key, entry => (TValue)entry.Value!, comparer);
public static Array ToNonGenericArray<T>(this IEnumerable<T> source, Type elementType)
{

13
CliFx/Utils/Extensions/PropertyExtensions.cs
View File

@@ -10,12 +10,11 @@ internal static class PropertyExtensions
// Match attribute by name to avoid depending on .NET 7.0+ and to allow polyfilling
propertyInfo
.GetCustomAttributes()
.Any(
a =>
string.Equals(
a.GetType().FullName,
"System.Runtime.CompilerServices.RequiredMemberAttribute",
StringComparison.Ordinal
)
.Any(a =>
string.Equals(
a.GetType().FullName,
"System.Runtime.CompilerServices.RequiredMemberAttribute",
StringComparison.Ordinal
)
);
}

2
CliFx/Utils/Extensions/StringExtensions.cs
View File

@@ -15,7 +15,7 @@ internal static class StringExtensions
public static string JoinToString<T>(this IEnumerable<T> source, string separator) =>
string.Join(separator, source);
public static string ToString(
public static string? ToString(
this object obj,
IFormatProvider? formatProvider = null,
string? format = null

54
CliFx/Utils/StackFrame.cs
View File

@@ -41,33 +41,33 @@ internal partial class StackFrame
private static readonly Regex Pattern =
new(
$$"""
^
{{Space}}*
\w+ {{Space}}+
(?<frame>
(?<type> {{NotSpace}}+ ) \.
(?<method> {{NotSpace}}+? ) {{Space}}*
(?<params> \( ( {{Space}}* \)
| (?<pt> .+?) {{Space}}+ (?<pn> .+?)
(, {{Space}}* (?<pt> .+?) {{Space}}+ (?<pn> .+?) )* \) ) )
( {{Space}}+
( # Microsoft .NET stack traces
\w+ {{Space}}+
(?<file> ( [a-z] \: # Windows rooted path starting with a drive letter
| / ) # Unix rooted path starting with a forward-slash
.+? )
\: \w+ {{Space}}+
(?<line> [0-9]+ ) \p{P}?
| # Mono stack traces
\[0x[0-9a-f]+\] {{Space}}+ \w+ {{Space}}+
<(?<file> [^>]+ )>
:(?<line> [0-9]+ )
)
)?
)
\s*
$
""",
^
{{Space}}*
\w+ {{Space}}+
(?<frame>
(?<type> {{NotSpace}}+ ) \.
(?<method> {{NotSpace}}+? ) {{Space}}*
(?<params> \( ( {{Space}}* \)
| (?<pt> .+?) {{Space}}+ (?<pn> .+?)
(, {{Space}}* (?<pt> .+?) {{Space}}+ (?<pn> .+?) )* \) ) )
( {{Space}}+
( # Microsoft .NET stack traces
\w+ {{Space}}+
(?<file> ( [a-z] \: # Windows rooted path starting with a drive letter
| / ) # Unix rooted path starting with a forward-slash
.+? )
\: \w+ {{Space}}+
(?<line> [0-9]+ ) \p{P}?
| # Mono stack traces
\[0x[0-9a-f]+\] {{Space}}+ \w+ {{Space}}+
<(?<file> [^>]+ )>
:(?<line> [0-9]+ )
)
)?
)
\s*
$
""",
RegexOptions.IgnoreCase
| RegexOptions.Multiline
| RegexOptions.ExplicitCapture