diff --git a/cspell.json b/cspell.json index 053b4563bcd..160440cf2f4 100644 --- a/cspell.json +++ b/cspell.json @@ -45,6 +45,7 @@ "aspnetcore", "assertoor", "autofac", + "autogen", "auxdata", "badreq", "barebone", diff --git a/tools/DocGen/ConfigGenerator.cs b/tools/DocGen/ConfigGenerator.cs index 4ef93e62645..414b3d4c2ba 100644 --- a/tools/DocGen/ConfigGenerator.cs +++ b/tools/DocGen/ConfigGenerator.cs @@ -96,12 +96,15 @@ private static void WriteMarkdown(StreamWriter file, Type configType) foreach (var prop in props) { - var itemAttr = prop.GetCustomAttribute(); + var configAttr = prop.GetCustomAttribute(); - 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($$""" @@ -110,7 +113,7 @@ private static void WriteMarkdown(StreamWriter file, Type configType) ``` - --{{moduleName.ToLowerInvariant()}}-{{prop.Name.ToLowerInvariant()}} {{cliValue}} + --{{cliAlias.ToLowerInvariant()}} {{cliValue}} --{{moduleName}}.{{prop.Name}} {{cliValue}} ``` @@ -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(); diff --git a/tools/DocGen/DBSizeGenerator.cs b/tools/DocGen/DBSizeGenerator.cs index db8c77ecc54..6987321701e 100644 --- a/tools/DocGen/DBSizeGenerator.cs +++ b/tools/DocGen/DBSizeGenerator.cs @@ -97,7 +97,6 @@ private static void GenerateFile(string docsPath, string dbSizeSourcePath, IList writeStream.Close(); File.Move(tempFileName, fileName, true); - File.Delete(tempFileName); AnsiConsole.MarkupLine($"[green]Updated[/] {fileName}"); } diff --git a/tools/DocGen/MetricsGenerator.cs b/tools/DocGen/MetricsGenerator.cs index 697b0381772..72b19253585 100644 --- a/tools/DocGen/MetricsGenerator.cs +++ b/tools/DocGen/MetricsGenerator.cs @@ -70,7 +70,6 @@ internal static void Generate(string path) writeStream.Close(); File.Move(tempFileName, fileName, true); - File.Delete(tempFileName); AnsiConsole.MarkupLine($"[green]Updated[/] {fileName}"); }