Skip to content

Override default CLI option alias #10148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rubo merged 2 commits into from
Jan 12, 2026
Merged

Override default CLI option alias #10148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1a132b
Add ability to rename plugin config CLI options
ArtiomTr Jan 8, 2026
d986f17
Revise CLI option alias handling
rubo Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions src/Nethermind/Nethermind.Config/ConfigItemAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@

using System;

namespace Nethermind.Config
namespace Nethermind.Config;

[AttributeUsage(AttributeTargets.Property)]
public class ConfigItemAttribute : Attribute
{
public class ConfigItemAttribute : Attribute
{
public string Description { get; set; }
public string Description { get; set; }

public string DefaultValue { get; set; }

public string DefaultValue { get; set; }
public bool HiddenFromDocs { get; set; }

public bool HiddenFromDocs { get; set; }
public bool DisabledForCli { get; set; }

public bool DisabledForCli { get; set; }
public string EnvironmentVariable { get; set; }

public string EnvironmentVariable { get; set; }
public bool IsPortOption { get; set; }

public bool IsPortOption { get; set; }
}
public string CliOptionAlias { get; set; }
}
29 changes: 16 additions & 13 deletions src/Nethermind/Nethermind.Runner/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,10 +213,13 @@ async Task<int> RunAsync(ParseResult parseResult, PluginLoader pluginLoader, Can

void AddConfigurationOptions(Command command)
{
static Option CreateOption<T>(string name, Type configType) =>
new Option<T>(
$"--{ConfigExtensions.GetCategoryName(configType)}.{name}",
$"--{ConfigExtensions.GetCategoryName(configType)}-{name}".ToLowerInvariant());
static Option CreateOption<T>(Type configType, string name, string? alias)
{
var category = ConfigExtensions.GetCategoryName(configType);
alias = string.IsNullOrWhiteSpace(alias) ? name : alias;

return new Option<T>($"--{category}.{name}", $"--{category}-{alias}".ToLowerInvariant());
}

IEnumerable<Type> configTypes = TypeDiscovery
.FindNethermindBasedTypes(typeof(IConfig))
Expand All @@ -238,19 +241,19 @@ static Option CreateOption<T>(string name, Type configType) =>
foreach (PropertyInfo prop in
configType.GetProperties(BindingFlags.Public | BindingFlags.Instance).OrderBy(p => p.Name))
{
ConfigItemAttribute? configItemAttribute = prop.GetCustomAttribute<ConfigItemAttribute>();
ConfigItemAttribute? configItemAttr = prop.GetCustomAttribute<ConfigItemAttribute>();

if (configItemAttribute?.DisabledForCli != true)
if (configItemAttr?.DisabledForCli != true)
{
Option option = prop.PropertyType == typeof(bool)
? CreateOption<bool>(prop.Name, configType)
: CreateOption<string>(prop.Name, configType);
? CreateOption<bool>(configType, prop.Name, configItemAttr?.CliOptionAlias)
: CreateOption<string>(configType, prop.Name, configItemAttr?.CliOptionAlias);

string? description = configItemAttribute?.Description;
string? description = configItemAttr?.Description;

if (!string.IsNullOrEmpty(configItemAttribute?.DefaultValue))
if (!string.IsNullOrEmpty(configItemAttr?.DefaultValue))
{
string defaultValue = $"Defaults to `{configItemAttribute.DefaultValue}`.";
string defaultValue = $"Defaults to `{configItemAttr.DefaultValue}`.";

description = string.IsNullOrEmpty(description)
? defaultValue
Expand All @@ -259,12 +262,12 @@ static Option CreateOption<T>(string name, Type configType) =>

option.Description = description;
option.HelpName = "value";
option.Hidden = categoryHidden || configItemAttribute?.HiddenFromDocs == true;
option.Hidden = categoryHidden || configItemAttr?.HiddenFromDocs == true;

command.Add(option);
}

if (configItemAttribute?.IsPortOption == true)
if (configItemAttr?.IsPortOption == true)
ConfigExtensions.AddPortOptionName(configType, prop.Name);
}
}
Expand Down