From 5a15c0a5d295aca6f85d49c8ffe5241e30c7eb38 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Sat, 14 Nov 2026 08:31:48 +0100 Subject: [PATCH] Name the enum member a parameter's default refers to A command parameter whose default was an enum member with a non-zero value did not compile: the generator wrote the member's value as a bare integer, and C# converts only the literal 0 to an enum implicitly. The default now names the member, or casts when no member has that value. Fixes #75. Co-Authored-By: Claude Opus 5.5 --- .../CliParserGenerator.ParameterModel.cs | 22 ++++++ .../EnumDefaultTests.cs | 67 +++++++++++++++++++ .../Nullean.Argh.Generator.Tests.csproj | 2 + 3 files changed, 91 insertions(+) create mode 100644 tests/Nullean.Argh.Generator.Tests/EnumDefaultTests.cs diff --git a/src/Nullean.Argh.Generator/CliParserGenerator.ParameterModel.cs b/src/Nullean.Argh.Generator/CliParserGenerator.ParameterModel.cs index 40a4d9e..207e5c2 100644 --- a/src/Nullean.Argh.Generator/CliParserGenerator.ParameterModel.cs +++ b/src/Nullean.Argh.Generator/CliParserGenerator.ParameterModel.cs @@ -1282,6 +1282,18 @@ private static bool ComputeRequired(IParameterSymbol p, BoolSpecialKind bs) if (v is null) return p.Type.IsReferenceType ? "null" : "default"; + // C# converts only the literal 0 to an enum implicitly, so an enum default names its member, or casts + if (EnumTypeOf(p.Type) is { } enumType) + { + var enumFq = enumType.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat); + foreach (var member in enumType.GetMembers()) + { + if (member is IFieldSymbol { HasConstantValue: true } field && Equals(field.ConstantValue, v)) + return enumFq + "." + field.Name; + } + return $"({enumFq})({SymbolDisplay.FormatPrimitive(v, quoteStrings: false, useHexadecimalNumbers: false)})"; + } + return v switch { string s => SymbolDisplay.FormatPrimitive(s, quoteStrings: true, useHexadecimalNumbers: false), @@ -1292,6 +1304,16 @@ private static bool ComputeRequired(IParameterSymbol p, BoolSpecialKind bs) }; } + private static INamedTypeSymbol? EnumTypeOf(ITypeSymbol type) => type switch + { + INamedTypeSymbol { TypeKind: TypeKind.Enum } e => e, + INamedTypeSymbol { OriginalDefinition.SpecialType: SpecialType.System_Nullable_T } n when n.TypeArguments[0] is INamedTypeSymbol + { + TypeKind: TypeKind.Enum + } e => e, + _ => null, + }; + private static string SafeLocalName(string name) { var k = Naming.ToCliLongName(name).Replace("-", "_"); diff --git a/tests/Nullean.Argh.Generator.Tests/EnumDefaultTests.cs b/tests/Nullean.Argh.Generator.Tests/EnumDefaultTests.cs new file mode 100644 index 0000000..830101b --- /dev/null +++ b/tests/Nullean.Argh.Generator.Tests/EnumDefaultTests.cs @@ -0,0 +1,67 @@ +using System.Text; +using AwesomeAssertions; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.Text; + +namespace Nullean.Argh.Generator.Tests; + +/// +/// A command parameter whose default is an enum member must compile whatever that member's value is: C# converts only +/// the literal 0 to an enum implicitly (https://github.com/nullean/argh/issues/75). +/// +public class EnumDefaultTests +{ + private static string Source(string parameter) => + $$""" + using Nullean.Argh; + using Nullean.Argh.Builder; + + namespace App + { + public enum OneBased { None = 1, A = 2 } + + public static class Handlers + { + public static void Run({{parameter}}) { } + } + + public static class CliRegistration + { + public static void Configure(IArghRootBuilder app) => app.Map("run", Handlers.Run); + } + } + """; + + private static List GeneratedCompilationErrors(string source) + { + var tpaPaths = ((string)AppContext.GetData("TRUSTED_PLATFORM_ASSEMBLIES")!).Split(Path.PathSeparator); + var references = tpaPaths.Select(p => (MetadataReference)MetadataReference.CreateFromFile(p)).ToList(); + references.Add(MetadataReference.CreateFromFile(typeof(Nullean.Argh.Builder.IArghBuilder).Assembly.Location)); + references.Add(MetadataReference.CreateFromFile(typeof(Nullean.Argh.ArghApp).Assembly.Location)); + + var tree = CSharpSyntaxTree.ParseText(SourceText.From(source, Encoding.UTF8), path: "App.cs"); + var compilation = CSharpCompilation.Create( + "App", + [tree], + references, + new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary, nullableContextOptions: NullableContextOptions.Enable) + ); + + var driver = CSharpGeneratorDriver.Create(new CliParserGenerator()); + driver.RunGeneratorsAndUpdateCompilation(compilation, out var output, out _); + return output.GetDiagnostics().Where(d => d.Severity == DiagnosticSeverity.Error).ToList(); + } + + [Test] + [Arguments("OneBased level = OneBased.None")] + [Arguments("OneBased level = OneBased.A")] + [Arguments("OneBased? level = OneBased.A")] + [Arguments("OneBased level = (OneBased)7")] + public void Default_of_a_non_zero_enum_member_compiles(string parameter) + { + var errors = GeneratedCompilationErrors(Source(parameter)); + + errors.Should().BeEmpty(string.Join(Environment.NewLine, errors)); + } +} diff --git a/tests/Nullean.Argh.Generator.Tests/Nullean.Argh.Generator.Tests.csproj b/tests/Nullean.Argh.Generator.Tests/Nullean.Argh.Generator.Tests.csproj index 105c786..7021ad2 100644 --- a/tests/Nullean.Argh.Generator.Tests/Nullean.Argh.Generator.Tests.csproj +++ b/tests/Nullean.Argh.Generator.Tests/Nullean.Argh.Generator.Tests.csproj @@ -18,6 +18,8 @@ + +