From 5d2c2609888035b5495d3794564261fa416169bf Mon Sep 17 00:00:00 2001 From: Artur Stolear Date: Sat, 31 May 2025 22:42:38 +0200 Subject: [PATCH] Updates help writer to include all arguments Updates the help writer tests to verify that all arguments are present in the help output. This ensures that users have access to comprehensive information about available command-line options. --- src/GitVersion.App.Tests/HelpWriterTests.cs | 28 +++++++++++++++------ src/GitVersion.App/Arguments.cs | 3 +-- 2 files changed, 21 insertions(+), 10 deletions(-) diff --git a/src/GitVersion.App.Tests/HelpWriterTests.cs b/src/GitVersion.App.Tests/HelpWriterTests.cs index 785f7a8ef6..bf962ea97f 100644 --- a/src/GitVersion.App.Tests/HelpWriterTests.cs +++ b/src/GitVersion.App.Tests/HelpWriterTests.cs @@ -19,21 +19,33 @@ public void AllArgsAreInHelp() { var lookup = new Dictionary { + { nameof(Arguments.IsHelp), "/?" }, + { nameof(Arguments.IsVersion), "/version" }, + { nameof(Arguments.TargetUrl), "/url" }, { nameof(Arguments.TargetBranch), "/b" }, + { nameof(Arguments.ClonePath), "/dynamicRepoLocation" }, + { nameof(Arguments.CommitId), "/c" }, + { nameof(Arguments.LogFilePath) , "/l" }, + { nameof(Arguments.Verbosity), "/verbosity" }, + { nameof(Arguments.Output) , "/output" }, { nameof(Arguments.OutputFile) , "/outputfile" }, - { nameof(Arguments.ClonePath), "/dynamicRepoLocation" }, - { nameof(Arguments.IsHelp), "/?" }, - { nameof(Arguments.IsVersion), "/version" }, + { nameof(Arguments.ShowVariable), "/showvariable" }, + { nameof(Arguments.Format), "/format" }, + { nameof(Arguments.UpdateWixVersionFile), "/updatewixversionfile" }, + { nameof(Arguments.UpdateProjectFiles), "/updateprojectfiles" }, + { nameof(Arguments.UpdateAssemblyInfo), "/updateassemblyinfo" }, + { nameof(Arguments.EnsureAssemblyInfo), "/ensureassemblyinfo" }, + { nameof(Arguments.ConfigurationFile), "/config" }, - { nameof(Arguments.Verbosity), "/verbosity" }, - { nameof(Arguments.CommitId), "/c" }, { nameof(Arguments.ShowConfiguration), "/showconfig" }, { nameof(Arguments.OverrideConfiguration), "/overrideconfig" }, - { nameof(Arguments.ShowVariable), "/showvariable" }, - { nameof(Arguments.Format), "/format" } + + { nameof(Arguments.NoCache), "/nocache" }, + { nameof(Arguments.NoFetch), "/nofetch" }, + { nameof(Arguments.NoNormalize), "/nonormalize" }, }; var helpText = string.Empty; @@ -42,7 +54,7 @@ public void AllArgsAreInHelp() var ignored = new[] { nameof(Arguments.Authentication), - nameof(Arguments.UpdateAssemblyInfoFileName) + nameof(Arguments.UpdateAssemblyInfoFileName), }; typeof(Arguments).GetFields() .Select(p => p.Name) diff --git a/src/GitVersion.App/Arguments.cs b/src/GitVersion.App/Arguments.cs index 8f5f977a67..5d619a5248 100644 --- a/src/GitVersion.App/Arguments.cs +++ b/src/GitVersion.App/Arguments.cs @@ -13,8 +13,6 @@ internal class Arguments public string? TargetPath; - public bool UpdateWixVersionFile; - public string? TargetUrl; public string? TargetBranch; public string? CommitId; @@ -35,6 +33,7 @@ internal class Arguments public ISet Output = new HashSet(); public Verbosity Verbosity = Verbosity.Normal; + public bool UpdateWixVersionFile; public bool UpdateProjectFiles; public bool UpdateAssemblyInfo; public bool EnsureAssemblyInfo;