Commands for generating shell completion scripts + statically-generated bash script

eng/dependabot/Packages.props

@@ -4,8 +4,8 @@
 
   <ItemGroup>
     <!--Test dependencies-->
-    <PackageVersion Include="Verify.Xunit" Version="25.0.2" />
-    <PackageVersion Include="Verify.DiffPlex" Version="3.0.0" />
+    <PackageVersion Include="Verify.Xunit" Version="28.7.0" />
+    <PackageVersion Include="Verify.DiffPlex" Version="3.1.2" />
     <PackageVersion Include="FakeItEasy" Version="8.0.0" />
     <PackageVersion Include="Wcwidth.Sources" Version="2.0.0" />
   </ItemGroup>

sdk.sln

@@ -509,6 +509,10 @@ Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Microsoft.DotNet.HotReload.
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.DotNet.HotReload.Agent.Package", "src\BuiltInTools\HotReloadAgent\Microsoft.DotNet.HotReload.Agent.Package.csproj", "{2FF79F82-60C1-349A-4726-7783D5A6D5DF}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "System.CommandLine.StaticCompletions", "src\System.CommandLine.StaticCompletions\System.CommandLine.StaticCompletions.csproj", "{B84E0837-40AF-484E-A71D-941595568BE7}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "System.CommandLine.StaticCompletions.Tests", "test\System.CommandLine.StaticCompletions.Tests\System.CommandLine.StaticCompletions.Tests.csproj", "{0C13E7D0-5335-4D60-B0F2-12595E8FC451}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.DotNet.HotReload.Agent.PipeRpc.Package", "src\BuiltInTools\HotReloadAgent.PipeRpc\Microsoft.DotNet.HotReload.Agent.PipeRpc.Package.csproj", "{692B71D8-9C31-D1EE-6C1B-570A12B18E39}"
 EndProject
 Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Microsoft.DotNet.HotReload.Agent.PipeRpc", "src\BuiltInTools\HotReloadAgent.PipeRpc\Microsoft.DotNet.HotReload.Agent.PipeRpc.shproj", "{FA3C7F91-42A2-45AD-897C-F646B081016C}"
@@ -967,6 +971,14 @@ Global
 		{2FF79F82-60C1-349A-4726-7783D5A6D5DF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{2FF79F82-60C1-349A-4726-7783D5A6D5DF}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{2FF79F82-60C1-349A-4726-7783D5A6D5DF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B84E0837-40AF-484E-A71D-941595568BE7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B84E0837-40AF-484E-A71D-941595568BE7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B84E0837-40AF-484E-A71D-941595568BE7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B84E0837-40AF-484E-A71D-941595568BE7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0C13E7D0-5335-4D60-B0F2-12595E8FC451}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0C13E7D0-5335-4D60-B0F2-12595E8FC451}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0C13E7D0-5335-4D60-B0F2-12595E8FC451}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0C13E7D0-5335-4D60-B0F2-12595E8FC451}.Release|Any CPU.Build.0 = Release|Any CPU
 		{692B71D8-9C31-D1EE-6C1B-570A12B18E39}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{692B71D8-9C31-D1EE-6C1B-570A12B18E39}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{692B71D8-9C31-D1EE-6C1B-570A12B18E39}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -1151,6 +1163,8 @@ Global
 		{8D6A9984-118D-4415-A8FA-AB1F26CF5C44} = {3FA6F1CB-295B-4414-B18F-93845917A8CD}
 		{418B10BD-CA42-49F3-8F4A-D8CC90C8A17D} = {71A9F549-0EB6-41F9-BC16-4A6C5007FC91}
 		{2FF79F82-60C1-349A-4726-7783D5A6D5DF} = {71A9F549-0EB6-41F9-BC16-4A6C5007FC91}
+		{B84E0837-40AF-484E-A71D-941595568BE7} = {22AB674F-ED91-4FBC-BFEE-8A1E82F9F05E}
+		{0C13E7D0-5335-4D60-B0F2-12595E8FC451} = {580D1AE7-AA8F-4912-8B76-105594E00B3B}
 		{692B71D8-9C31-D1EE-6C1B-570A12B18E39} = {71A9F549-0EB6-41F9-BC16-4A6C5007FC91}
 		{FA3C7F91-42A2-45AD-897C-F646B081016C} = {71A9F549-0EB6-41F9-BC16-4A6C5007FC91}
 		{3DF5A9B8-6F90-4CFB-4518-0E97982B6748} = {71A9F549-0EB6-41F9-BC16-4A6C5007FC91}

src/Cli/Microsoft.TemplateEngine.Cli/Commands/SharedOptionsFactory.cs

@@ -121,7 +121,7 @@ internal static CliOption<bool> CreateColumnsAllOption()
         {
             return new("--columns-all")
             {
-                Arity = new ArgumentArity(0, 1),
+                Arity = ArgumentArity.Zero,
                 Description = SymbolStrings.Option_ColumnsAll
             };
         }

src/Cli/Microsoft.TemplateEngine.Cli/Commands/list/BaseListCommand.cs

@@ -43,7 +43,7 @@ internal BaseListCommand(
         internal static CliOption<bool> IgnoreConstraintsOption { get; } = new("--ignore-constraints")
         {
             Description = SymbolStrings.ListCommand_Option_IgnoreConstraints,
-            Arity = new ArgumentArity(0, 1)
+            Arity = ArgumentArity.Zero
         };
 
         internal static CliArgument<string> NameArgument { get; } = new("template-name")

src/Cli/Microsoft.TemplateEngine.Cli/Commands/update/UpdateCommand.cs

@@ -20,7 +20,8 @@ public UpdateCommand(
 
         internal static CliOption<bool> CheckOnlyOption { get; } = new("--check-only", "--dry-run")
         {
-            Description = SymbolStrings.Command_Update_Option_CheckOnly
+            Description = SymbolStrings.Command_Update_Option_CheckOnly,
+            Arity = ArgumentArity.Zero
         };
 
         protected override async Task<NewCommandStatus> ExecuteAsync(

src/Cli/dotnet/CommonOptions.cs

@@ -4,6 +4,7 @@
 using System.CommandLine;
 using System.CommandLine.Completions;
 using System.CommandLine.Parsing;
+using System.CommandLine.StaticCompletions;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.Tools;
 using Microsoft.DotNet.Tools.Common;
@@ -36,13 +37,13 @@ internal static class CommonOptions
             }.ForwardAsSingle(o => $"-verbosity:{o}");
 
         public static CliOption<string> FrameworkOption(string description) =>
-            new ForwardedOption<string>("--framework", "-f")
+            new DynamicForwardedOption<string>("--framework", "-f")
             {
                 Description = description,
                 HelpName = CommonLocalizableStrings.FrameworkArgumentName
-
-            }.ForwardAsSingle(o => $"-property:TargetFramework={o}")
-            .AddCompletions(Complete.TargetFrameworksFromProjectFile);
+            }
+            .AddCompletions(Complete.TargetFrameworksFromProjectFile)
+            .ForwardAsSingle(o => $"-property:TargetFramework={o}");
 
         public static CliOption<string> ArtifactsPathOption =
             new ForwardedOption<string>(
@@ -64,14 +65,14 @@ public static IEnumerable<string> RuntimeArgFunc(string rid)
         }
 
         public static CliOption<string> RuntimeOption =
-            new ForwardedOption<string>("--runtime", "-r")
+            new DynamicForwardedOption<string>("--runtime", "-r")
             {
                 HelpName = RuntimeArgName
             }.ForwardAsMany(RuntimeArgFunc)
             .AddCompletions(Complete.RunTimesFromProjectFile);
 
         public static CliOption<string> LongFormRuntimeOption =
-            new ForwardedOption<string>("--runtime")
+            new DynamicForwardedOption<string>("--runtime")
             {
                 HelpName = RuntimeArgName
             }.ForwardAsMany(RuntimeArgFunc)
@@ -80,11 +81,12 @@ public static IEnumerable<string> RuntimeArgFunc(string rid)
         public static CliOption<bool> CurrentRuntimeOption(string description) =>
             new ForwardedOption<bool>("--use-current-runtime", "--ucr")
             {
-                Description = description
+                Description = description,
+                Arity = ArgumentArity.Zero
             }.ForwardAs("-property:UseCurrentRuntimeIdentifier=True");
 
         public static CliOption<string> ConfigurationOption(string description) =>
-            new ForwardedOption<string>("--configuration", "-c")
+            new DynamicForwardedOption<string>("--configuration", "-c")
             {
                 Description = description,
                 HelpName = CommonLocalizableStrings.ConfigurationArgumentName
@@ -110,25 +112,22 @@ public static CliArgument<string> DefaultToCurrentDirectory(this CliArgument<str
 
         public static CliOption<bool> NoRestoreOption = new ForwardedOption<bool>("--no-restore")
         {
-            Description = CommonLocalizableStrings.NoRestoreDescription
+            Description = CommonLocalizableStrings.NoRestoreDescription,
+            Arity = ArgumentArity.Zero
         }.ForwardAs("-restore:false");
 
         public static CliOption<bool> InteractiveMsBuildForwardOption =
             new ForwardedOption<bool>("--interactive")
             {
-                Description = CommonLocalizableStrings.CommandInteractiveOptionDescription
+                Description = CommonLocalizableStrings.CommandInteractiveOptionDescription,
+                Arity = ArgumentArity.Zero
             }.ForwardAs("-property:NuGetInteractive=true");
 
-        public static CliOption<bool> InteractiveOption =
-            new("--interactive")
-            {
-                Description = CommonLocalizableStrings.CommandInteractiveOptionDescription
-            };
-
         public static CliOption<bool> DisableBuildServersOption =
             new ForwardedOption<bool>("--disable-build-servers")
             {
-                Description = CommonLocalizableStrings.DisableBuildServersOptionDescription
+                Description = CommonLocalizableStrings.DisableBuildServersOptionDescription,
+                Arity = ArgumentArity.Zero
             }
             .ForwardAsMany(_ => ["--property:UseRazorBuildServer=false", "--property:UseSharedCompilation=false", "/nodeReuse:false"]);
 
@@ -158,7 +157,10 @@ internal static string ArchOptionValue(ParseResult parseResult) =>
                 HelpName = CommonLocalizableStrings.OSArgumentName
             }.SetForwardingFunction(ResolveOsOptionToRuntimeIdentifier);
 
-        public static CliOption<bool> DebugOption = new("--debug");
+        public static CliOption<bool> DebugOption = new("--debug")
+        {
+            Arity = ArgumentArity.Zero,
+        };
 
         public static CliOption<bool> SelfContainedOption =
             new ForwardedOption<bool>("--self-contained", "--sc")
@@ -170,10 +172,10 @@ internal static string ArchOptionValue(ParseResult parseResult) =>
         public static CliOption<bool> NoSelfContainedOption =
             new ForwardedOption<bool>("--no-self-contained")
             {
-                Description = CommonLocalizableStrings.FrameworkDependentOptionDescription
+                Description = CommonLocalizableStrings.FrameworkDependentOptionDescription,
+                Arity = ArgumentArity.Zero
             }
-            // Flip the argument so that if this option is specified we get selfcontained=false
-            .SetForwardingFunction((arg, p) => ForwardSelfContainedOptions(!arg, p));
+            .SetForwardingFunction((_, p) => ForwardSelfContainedOptions(false, p));
 
         public static readonly CliOption<IReadOnlyDictionary<string, string>> EnvOption = new("--environment", "-e")
         {
@@ -317,6 +319,18 @@ internal static CliArgument<T> AddCompletions<T>(this CliArgument<T> argument, F
             argument.CompletionSources.Add(completionSource);
             return argument;
         }
+
+        internal static DynamicOption<T> AddCompletions<T>(this DynamicOption<T> option, Func<CompletionContext, IEnumerable<CompletionItem>> completionSource)
+        {
+            option.CompletionSources.Add(completionSource);
+            return option;
+        }
+
+        internal static DynamicForwardedOption<T> AddCompletions<T>(this DynamicForwardedOption<T> option, Func<CompletionContext, IEnumerable<CompletionItem>> completionSource)
+        {
+            option.CompletionSources.Add(completionSource);
+            return option;
+        }
     }
 
     public enum VerbosityOptions
@@ -332,4 +346,14 @@ public enum VerbosityOptions
         diagnostic,
         diag
     }
+
+    public class DynamicOption<T> : CliOption<T>, IDynamicOption
+    {
+        public DynamicOption(string name, params string[] aliases) : base(name, aliases) { }
+    }
+
+    public class DynamicArgument<T> : CliArgument<T>, IDynamicArgument
+    {
+        public DynamicArgument(string name) : base(name) { }
+    }
 }

src/Cli/dotnet/CommonOptionsFactory.cs

@@ -11,12 +11,13 @@ namespace Microsoft.DotNet.Cli
     internal static class CommonOptionsFactory
     {
         /// <summary>
-        /// Creates common diagnositcs option (-d|--diagnostics).
+        /// Creates common diagnostics option (-d|--diagnostics).
         /// </summary>
         public static CliOption<bool> CreateDiagnosticsOption(bool recursive) => new("--diagnostics", "-d")
         {
             Description = Tools.Help.LocalizableStrings.SDKDiagnosticsCommandDefinition,
-            Recursive = recursive
+            Recursive = recursive,
+            Arity = ArgumentArity.Zero
         };
     }
 }

src/Cli/dotnet/OptionForwardingExtensions.cs

@@ -3,6 +3,7 @@
 
 using System.CommandLine;
 using System.CommandLine.Parsing;
+using System.CommandLine.StaticCompletions;
 
 namespace Microsoft.DotNet.Cli
 {
@@ -149,4 +150,14 @@ public Func<ParseResult, IEnumerable<string>> GetForwardingFunction()
             return ForwardingFunction;
         }
     }
+
+    public class DynamicForwardedOption<T> : ForwardedOption<T>, IDynamicOption
+    {
+        public DynamicForwardedOption(string name, Func<ArgumentResult, T> parseArgument, string description = null)
+            : base(name, parseArgument, description)
+        {
+        }
+
+        public DynamicForwardedOption(string name, params string[] aliases) : base(name, aliases) { }
+    }
 }

src/Cli/dotnet/Parser.cs

@@ -54,18 +54,31 @@ public static class Parser
             HelpCommandParser.GetCommand(),
             SdkCommandParser.GetCommand(),
             InstallSuccessCommand,
-            WorkloadCommandParser.GetCommand()
+            WorkloadCommandParser.GetCommand(),
+            new System.CommandLine.StaticCompletions.CompletionsCommand()
         };
 
         public static readonly CliOption<bool> DiagOption = CommonOptionsFactory.CreateDiagnosticsOption(recursive: false);
 
-        public static readonly CliOption<bool> VersionOption = new("--version");
+        public static readonly CliOption<bool> VersionOption = new("--version")
+        {
+            Arity = ArgumentArity.Zero,
+        };
 
-        public static readonly CliOption<bool> InfoOption = new("--info");
+        public static readonly CliOption<bool> InfoOption = new("--info")
+        {
+            Arity = ArgumentArity.Zero,
+        };
 
-        public static readonly CliOption<bool> ListSdksOption = new("--list-sdks");
+        public static readonly CliOption<bool> ListSdksOption = new("--list-sdks")
+        {
+            Arity = ArgumentArity.Zero,
+        };
 
-        public static readonly CliOption<bool> ListRuntimesOption = new("--list-runtimes");
+        public static readonly CliOption<bool> ListRuntimesOption = new("--list-runtimes")
+        {
+            Arity = ArgumentArity.Zero,
+        };
 
         // Argument
         public static readonly CliArgument<string> DotnetSubCommand = new("subcommand") { Arity = ArgumentArity.ZeroOrOne, Hidden = true };

src/Cli/dotnet/commands/dotnet-build/BuildCommandParser.cs

@@ -24,16 +24,22 @@ internal static class BuildCommandParser
             HelpName = LocalizableStrings.OutputOptionName
         }.ForwardAsOutputPath("OutputPath");
 
-        public static readonly CliOption<bool> NoIncrementalOption = new("--no-incremental") { Description = LocalizableStrings.NoIncrementalOptionDescription };
+        public static readonly CliOption<bool> NoIncrementalOption = new("--no-incremental")
+        {
+            Description = LocalizableStrings.NoIncrementalOptionDescription,
+            Arity = ArgumentArity.Zero
+        };
 
         public static readonly CliOption<bool> NoDependenciesOption = new ForwardedOption<bool>("--no-dependencies")
         {
-            Description = LocalizableStrings.NoDependenciesOptionDescription
+            Description = LocalizableStrings.NoDependenciesOptionDescription,
+            Arity = ArgumentArity.Zero
         }.ForwardAs("-property:BuildProjectReferences=false");
 
         public static readonly CliOption<bool> NoLogoOption = new ForwardedOption<bool>("--nologo")
         {
-            Description = LocalizableStrings.CmdNoLogo
+            Description = LocalizableStrings.CmdNoLogo,
+            Arity = ArgumentArity.Zero
         }.ForwardAs("-nologo");
 
         public static readonly CliOption<bool> NoRestoreOption = CommonOptions.NoRestoreOption;

src/Cli/dotnet/commands/dotnet-buildserver/shutdown/BuildServerShutdownCommandParser.cs

@@ -9,9 +9,23 @@ namespace Microsoft.DotNet.Cli
 {
     internal static class ServerShutdownCommandParser
     {
-        public static readonly CliOption<bool> MSBuildOption = new("--msbuild") { Description = LocalizableStrings.MSBuildOptionDescription };
-        public static readonly CliOption<bool> VbcsOption = new("--vbcscompiler") { Description = LocalizableStrings.VBCSCompilerOptionDescription };
-        public static readonly CliOption<bool> RazorOption = new("--razor") { Description = LocalizableStrings.RazorOptionDescription };
+        public static readonly CliOption<bool> MSBuildOption = new("--msbuild")
+        {
+            Description = LocalizableStrings.MSBuildOptionDescription,
+            Arity = ArgumentArity.Zero
+        };
+
+        public static readonly CliOption<bool> VbcsOption = new("--vbcscompiler")
+        {
+            Description = LocalizableStrings.VBCSCompilerOptionDescription,
+            Arity = ArgumentArity.Zero
+        };
+
+        public static readonly CliOption<bool> RazorOption = new("--razor")
+        {
+            Description = LocalizableStrings.RazorOptionDescription,
+            Arity = ArgumentArity.Zero
+        };
 
         private static readonly CliCommand Command = ConstructCommand();
 

src/Cli/dotnet/commands/dotnet-clean/CleanCommandParser.cs

@@ -26,7 +26,8 @@ internal static class CleanCommandParser
 
         public static readonly CliOption<bool> NoLogoOption = new ForwardedOption<bool>("--nologo")
         {
-            Description = LocalizableStrings.CmdNoLogo
+            Description = LocalizableStrings.CmdNoLogo,
+            Arity = ArgumentArity.Zero
         }.ForwardAs("-nologo");
 
         public static readonly CliOption FrameworkOption = CommonOptions.FrameworkOption(LocalizableStrings.FrameworkOptionDescription);