Tip: dump-config directive to let users provide troubleshooting help

[drewburlingame]

If you want a way to dump configuration info for your app but don't want to expose it as a command that's printed with help, you can add the following

return new AppRunner<App>()
    .Configure(c => c.UseMiddleware(DumpConfigDirective, MiddlewareStages.PreTokenize))
    .Run(args);

private static Task<int> DumpConfigDirective(CommandContext ctx, ExecutionDelegate next)
{
    if (ctx.Tokens.TryGetDirective("dump-config", out _))
    {
        var appInfo = AppInfo.GetAppInfo();
        ctx.Console.WriteLine($"{appInfo.FileName} v{appInfo.Version}");
        ctx.Console.WriteLine(ctx.AppConfig.ToString());
        return ExitCodes.Success;
    }
    return next(ctx);
}

Use it like this

dotnet ServiceDepends.dll [dump-config]

To output the following

ServiceDepends.dll v1.0.0
AppConfig:
      AppSettings:
    ArgumentTypeDescriptors: ArgumentTypeDescriptors:
      ErrorReportingDescriptor > CommandDotNet.TypeDescriptors.BoolTypeDescriptor
      ErrorReportingDescriptor > CommandDotNet.TypeDescriptors.EnumTypeDescriptor
      ErrorReportingDescriptor > DelegatedTypeDescriptor<String>: 'Text'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Password>: 'Text'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Char>: 'Character'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Int64>: 'Number'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Int32>: 'Number'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Int16>: 'Number'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Decimal>: 'Decimal'
      ErrorReportingDescriptor > DelegatedTypeDescriptor<Double>: 'Double'
      ErrorReportingDescriptor > CommandDotNet.TypeDescriptors.ComponentModelTypeDescriptor
      ErrorReportingDescriptor > CommandDotNet.TypeDescriptors.StringCtorTypeDescriptor
    BooleanMode: Implicit
    DefaultArgumentMode: Operand
    DefaultArgumentSeparatorStrategy: EndOfOptions
    DisableDirectives: False
    Help:       AppHelpSettings:
      ExpandArgumentsInUsage: True
      PrintHelpOption: False
      TextStyle: Detailed
      UsageAppName:
      UsageAppNameStyle: Adaptive
    IgnoreUnexpectedOperands: False
  DependencyResolver:
  HelpProvider: CommandDotNet.Help.HelpTextProvider
  TokenTransformations:
    expand-response-files(1)
  MiddlewarePipeline:
    DebugDirective.AttachDebugger
    Program.DumpConfigDirective
    CancellationMiddleware.AddCancellationTokens
    AppRunner.OnRunCompleted
    HelpMiddleware.PrintHelp
    ParseDirective.ConfigureParseReportByTokenTransform
    TokenizerPipeline.TokenizeInputMiddleware
    ClassModelingMiddleware.CreateRootCommand
    CommandParser.ParseInputMiddleware
    TypoSuggestionsMiddleware.TypoSuggest
    ClassModelingMiddleware.AssembleInvocationPipelineMiddleware
    VersionMiddleware.DisplayVersionIfSpecified
    SetArgumentDefaultsMiddleware.SetDefaults
    HelpMiddleware.CheckIfShouldShowHelp
    PipedInputMiddleware.InjectPipedInputToOperandList
    BindValuesMiddleware.BindValues
    ParseDirective.ParseReportByArg
    ResolveCommandClassesMiddleware.ResolveCommandClassInstances
    DataAnnotationsMiddleware.DataAnnotationsValidation
    ClassModelingMiddleware.InvokeInvocationPipelineMiddleware
  ParameterResolvers:
    CommandDotNet.CommandContext
    CommandDotNet.Rendering.IConsole
    System.Threading.CancellationToken
ServiceDepends.dll

[drewburlingame]

CommandLogger can be configured to give you the same information when a command is run. The command logger will also show how arguments were evaluated and will honor the Password data type to prevent leaking passwords.