Skip to content

Support CLI alias overrides in docs #10197

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 4 commits into from
Jan 13, 2026
Merged

Support CLI alias overrides in docs #10197

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
68b050d
Support CLI alias overrides
rubo Jan 12, 2026
2e60bfb
Merge branch 'master' into feature/docgen-cli-alias
LukaszRozmej Jan 12, 2026
7b16e4e
Update dictionary
rubo Jan 12, 2026
3c56df5
Remove redundant deletes
rubo Jan 13, 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
1 change: 1 addition & 0 deletions cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"aspnetcore",
"assertoor",
"autofac",
"autogen",
"auxdata",
"badreq",
"barebone",
Expand Down
13 changes: 8 additions & 5 deletions tools/DocGen/ConfigGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,15 @@ private static void WriteMarkdown(StreamWriter file, Type configType)

foreach (var prop in props)
{
var itemAttr = prop.GetCustomAttribute<ConfigItemAttribute>();
var configAttr = prop.GetCustomAttribute<ConfigItemAttribute>();

if (itemAttr?.HiddenFromDocs ?? true)
if (configAttr?.HiddenFromDocs ?? true)
continue;

var description = itemAttr.Description.Replace("\n", "\n ").TrimEnd(' ');
var description = configAttr.Description.Replace("\n", "\n ").TrimEnd(' ');
var cliAlias = string.IsNullOrWhiteSpace(configAttr.CliOptionAlias)
? $"{moduleName}-{prop.Name}"
: configAttr.CliOptionAlias;
(string value, string cliValue) = GetValue(prop);

file.Write($$"""
Expand All @@ -110,7 +113,7 @@ private static void WriteMarkdown(StreamWriter file, Type configType)
<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--{{moduleName.ToLowerInvariant()}}-{{prop.Name.ToLowerInvariant()}} {{cliValue}}
--{{cliAlias.ToLowerInvariant()}} {{cliValue}}
--{{moduleName}}.{{prop.Name}} {{cliValue}}
```
</TabItem>
Expand All @@ -135,7 +138,7 @@ private static void WriteMarkdown(StreamWriter file, Type configType)

var startsFromNewLine = WriteAllowedValues(file, prop.PropertyType) || description.EndsWith('\n');

WriteDefaultValue(file, itemAttr, startsFromNewLine);
WriteDefaultValue(file, configAttr, startsFromNewLine);

file.WriteLine();
file.WriteLine();
Expand Down