Breaking change: enforce construction-time metadata

Author: xoofx

src/XenoAtom.CommandLine.Terminal.Tests/TerminalMarkupCommandOutputTests.cs

@@ -24,16 +24,12 @@ public async Task Help_IsRendered_WithMarkupOutput()
                 {
                     UseTerminalWindowWidth = false,
                 })
-            })
-        {
-            new CommandUsage(),
-            "Options:",
-            { "n|name=", "The {NAME}", _ => { } },
-            new HelpOption(),
-            (ctx, _) => ValueTask.FromResult(0)
-        };
-
-        app.Options["name"].EnvironmentVariable = "APP_NAME";
+            });
+        app.Add(new CommandUsage());
+        app.Add("Options:");
+        app.Add("n|name=", "The {NAME}", _ => { }, envVar: "APP_NAME", hidden: false);
+        app.Add(new HelpOption());
+        app.Add((ctx, _) => ValueTask.FromResult(0));
 
         var result = await app.RunAsync(["--help"], new CommandRunConfig(Width: 80));
         Assert.AreEqual(0, result);
@@ -120,12 +116,9 @@ public async Task Error_ContainsEnvironmentVariableSourceContext()
             {
                 EnvironmentVariableResolver = _ => "oops",
                 OutputFactory = _ => new TerminalMarkupCommandOutput()
-            })
-        {
-            { "a|age=", "Age", (int _) => { } },
-            (ctx, _) => ValueTask.FromResult(0)
-        };
-        app.Options["age"].EnvironmentVariable = "APP_AGE";
+            });
+        app.Add("a|age=", "Age", (int _) => { }, envVar: "APP_AGE");
+        app.Add((ctx, _) => ValueTask.FromResult(0));
 
         var result = await app.RunAsync([]);
         Assert.AreEqual(1, result);
@@ -149,9 +142,9 @@ public async Task Help_DoesNotRenderHiddenOptionsArgumentsAndCommands()
 
         var hiddenCommand = new Command("hidden-cmd", hiddenCommandDescription)
         {
-            (ctx, _) => ValueTask.FromResult(0)
+            Hidden = true,
         };
-        hiddenCommand.Hidden = true;
+        hiddenCommand.Add((ctx, _) => ValueTask.FromResult(0));
 
         var app = new CommandApp(
             "app",

src/XenoAtom.CommandLine.Terminal.Tests/TerminalVisualCommandOutputTests.cs

@@ -238,9 +238,9 @@ public async Task VisualOutput_Help_DoesNotRenderHiddenOptionsArgumentsAndComman
 
         var hiddenCommand = new Command("hidden-cmd", hiddenCommandDescription)
         {
-            (ctx, _) => ValueTask.FromResult(0)
+            Hidden = true,
         };
-        hiddenCommand.Hidden = true;
+        hiddenCommand.Add((ctx, _) => ValueTask.FromResult(0));
 
         var app = new CommandApp(
             "app",

src/XenoAtom.CommandLine/Command.cs

@@ -54,7 +54,7 @@ public Command(string name, string? help = null, Func<bool>? active = null) : ba
     /// <summary>
     /// Gets or sets a boolean indicating if this command is hidden from help.
     /// </summary>
-    public bool Hidden { get; set; }
+    public bool Hidden { get; init; }
 
     /// <summary>
     /// Gets the description of this command.
@@ -69,7 +69,7 @@ public Command(string name, string? help = null, Func<bool>? active = null) : ba
     /// <summary>
     /// Gets the name of the options used when creating the usage help for this command.
     /// </summary>
-    public string OptionsSectionName { get; set; }
+    public string OptionsSectionName { get; init; }
 
     /// <summary>
     /// Gets the sub-commands of this command.

src/XenoAtom.CommandLine/CommandExtensions.cs

@@ -217,8 +217,12 @@ public static TCommand Add<TCommand>(
         if (CommandArgument.IsArgumentPrototype(prototype))
             throw new ArgumentException("Environment variable fallback is only supported for options, not positional arguments.", nameof(prototype));
 
-        var option = new ActionOption(prototype, description, 1, delegate (OptionValueCollection v) { action(v[0]); }, hidden);
-        ConfigureOptionEnvironment(option, envVar, envVarDelimiter);
+        ArgumentException.ThrowIfNullOrWhiteSpace(envVar);
+        var option = new ActionOption(prototype, description, 1, delegate (OptionValueCollection v) { action(v[0]); }, hidden)
+        {
+            EnvironmentVariable = envVar,
+            EnvironmentVariableDelimiter = envVarDelimiter
+        };
         command.Add(option);
         return command;
     }
@@ -260,11 +264,12 @@ public static TCommand Add<TCommand>(
             return command;
         }
 
-        var option = new ActionOption(prototype, description, 1, delegate (OptionValueCollection v) { action(v[0]); }, hidden, validate);
-        if (!string.IsNullOrWhiteSpace(envVar))
+        var normalizedEnvVar = string.IsNullOrWhiteSpace(envVar) ? null : envVar;
+        var option = new ActionOption(prototype, description, 1, delegate (OptionValueCollection v) { action(v[0]); }, hidden, validate)
         {
-            ConfigureOptionEnvironment(option, envVar, envVarDelimiter);
-        }
+            EnvironmentVariable = normalizedEnvVar,
+            EnvironmentVariableDelimiter = normalizedEnvVar is null ? null : envVarDelimiter
+        };
         command.Add(option);
         return command;
     }
@@ -747,11 +752,12 @@ private static TCommand AddTypedAction<TCommand, T>(
             return command;
         }
 
-        var option = new ActionOption<T>(prototype, description, action, validate, hidden);
-        if (!string.IsNullOrWhiteSpace(envVar))
+        var normalizedEnvVar = string.IsNullOrWhiteSpace(envVar) ? null : envVar;
+        var option = new ActionOption<T>(prototype, description, action, validate, hidden)
         {
-            ConfigureOptionEnvironment(option, envVar, envVarDelimiter);
-        }
+            EnvironmentVariable = normalizedEnvVar,
+            EnvironmentVariableDelimiter = normalizedEnvVar is null ? null : envVarDelimiter
+        };
 
         command.Add(option);
         return command;
@@ -781,11 +787,12 @@ private static TCommand AddTypedList<TCommand, T>(
             return command;
         }
 
-        var option = new ActionOption<T>(prototype, description, list.Add, validate, hidden);
-        if (!string.IsNullOrWhiteSpace(envVar))
+        var normalizedEnvVar = string.IsNullOrWhiteSpace(envVar) ? null : envVar;
+        var option = new ActionOption<T>(prototype, description, list.Add, validate, hidden)
         {
-            ConfigureOptionEnvironment(option, envVar, envVarDelimiter);
-        }
+            EnvironmentVariable = normalizedEnvVar,
+            EnvironmentVariableDelimiter = normalizedEnvVar is null ? null : envVarDelimiter
+        };
 
         command.Add(option);
         return command;
@@ -800,14 +807,6 @@ private static void EnsurePrototypeIsNotRemainder(string prototype, bool isListB
         }
     }
 
-    private static void ConfigureOptionEnvironment(Option option, string envVar, char? envVarDelimiter)
-    {
-        ArgumentNullException.ThrowIfNull(option);
-        ArgumentException.ThrowIfNullOrWhiteSpace(envVar);
-        option.EnvironmentVariable = envVar;
-        option.EnvironmentVariableDelimiter = envVarDelimiter;
-    }
-    
     private sealed class ActionOption<T> : Option
         where T : ISpanParsable<T>
     {

src/XenoAtom.CommandLine/Option.cs

@@ -123,7 +123,7 @@ public string[] GetValueSeparators()
     /// Gets or sets the environment variable used as a fallback when this option
     /// is not provided explicitly on the command line.
     /// </summary>
-    public string? EnvironmentVariable { get; set; }
+    public string? EnvironmentVariable { get; init; }
 
     /// <summary>
     /// Gets or sets the delimiter used to split an environment variable value into
@@ -132,7 +132,7 @@ public string[] GetValueSeparators()
     /// <remarks>
     /// When null, the environment variable value is treated as a single occurrence.
     /// </remarks>
-    public char? EnvironmentVariableDelimiter { get; set; }
+    public char? EnvironmentVariableDelimiter { get; init; }
 
     internal bool WasSetOnCommandLine { get; set; }