(chocolatey#2591) Add headers to limit output commands

When a user asks for limited output from Chocolatey, it is not uncommon
to pipe that output to `ConvertFrom-String` or `ConvertFrom-Csv` and
manually add headers to get back an object. This allows for getting a
header row back so that the end user doesn't need to add their own
headers and discern what they are.

This also adds a StringResources static class that allows us to store
constant strings in and use them across the code to reduce duplication.

Author: corbob

src/chocolatey/StringResources.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace chocolatey
+{
+    public static class StringResources
+    {
+        public static class OptionDescriptions
+        {
+            public const string DISPLAY_HEADERS = "Display headers - Display headers when limit-output is used. Requires <INSERT RELEASED VERSION HERE>";
+        }
+
+        public static class Options
+        {
+            public const string DISPLAY_HEADERS = "display-headers|use-headers";
+        }
+    }
+}

src/chocolatey/chocolatey.csproj

@@ -360,6 +360,7 @@
     <Compile Include="ObjectExtensions.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="StringExtensions.cs" />
+    <Compile Include="StringResources.cs" />
     <Compile Include="TypeExtensions.cs" />
   </ItemGroup>
   <ItemGroup>

src/chocolatey/infrastructure.app/ApplicationParameters.cs

@@ -208,6 +208,7 @@ public static class Features
             public static readonly string LogValidationResultsOnWarnings = "logValidationResultsOnWarnings";
             public static readonly string UsePackageRepositoryOptimizations = "usePackageRepositoryOptimizations";
             public static readonly string DisableCompatibilityChecks = "disableCompatibilityChecks";
+            public static readonly string AlwaysDisplayHeaders = "alwaysDisplayHeaders";
         }
 
         public static class Messages

src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs

@@ -318,7 +318,8 @@ private static void set_feature_flags(ChocolateyConfiguration config, ConfigFile
             config.Features.LogValidationResultsOnWarnings = set_feature_flag(ApplicationParameters.Features.LogValidationResultsOnWarnings, configFileSettings, defaultEnabled: true, description: "Log validation results on warnings - Should the validation results be logged if there are warnings? Available in 0.10.12+.");
             config.Features.UsePackageRepositoryOptimizations = set_feature_flag(ApplicationParameters.Features.UsePackageRepositoryOptimizations, configFileSettings, defaultEnabled: true, description: "Use Package Repository Optimizations - Turn on optimizations for reducing bandwidth with repository queries during package install/upgrade/outdated operations. Should generally be left enabled, unless a repository needs to support older methods of query. When disabled, this makes queries similar to the way they were done in Chocolatey v0.10.11 and before. Available in 0.10.14+.");
             config.PromptForConfirmation = !set_feature_flag(ApplicationParameters.Features.AllowGlobalConfirmation, configFileSettings, defaultEnabled: false, description: "Prompt for confirmation in scripts or bypass.");
-            config.DisableCompatibilityChecks = set_feature_flag(ApplicationParameters.Features.DisableCompatibilityChecks, configFileSettings, defaultEnabled: false, description: "Disable Compatibility Checks - Should a warning we shown, before and after command execution, when a runtime compatibility check determines that there is an incompatibility between Chocolatey and Chocolatey Licensed Extension. Available in 1.1.0+");
+            config.DisableCompatibilityChecks = set_feature_flag(ApplicationParameters.Features.DisableCompatibilityChecks, configFileSettings, defaultEnabled: false, description: "Disable Compatibility Checks - Should a warning be shown, before and after command execution, when a runtime compatibility check determines that there is an incompatibility between Chocolatey and Chocolatey Licensed Extension. Available in 1.1.0+");
+            config.DisplayHeaders = set_feature_flag(ApplicationParameters.Features.AlwaysDisplayHeaders, configFileSettings, defaultEnabled: false, description: StringResources.OptionDescriptions.DISPLAY_HEADERS);
         }
 
         private static bool set_feature_flag(string featureName, ConfigFileSettings configFileSettings, bool defaultEnabled, string description)

src/chocolatey/infrastructure.app/commands/ChocolateyApiKeyCommand.cs

@@ -51,6 +51,9 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon
                 .Add("rem|remove",
                     "Removes an API key from Chocolatey",
                     option => configuration.ApiKeyCommand.Remove = true)
+                .Add(StringResources.Options.DISPLAY_HEADERS,
+                    StringResources.OptionDescriptions.DISPLAY_HEADERS,
+                    option => configuration.DisplayHeaders = true)
                 ;
         }
 
@@ -156,6 +159,11 @@ public virtual void run(ChocolateyConfiguration configuration)
             }
             else if (string.IsNullOrWhiteSpace(configuration.ApiKeyCommand.Key))
             {
+                if (!configuration.RegularOutput && configuration.DisplayHeaders)
+                {
+                    this.Log().Info("Source|Key");
+                }
+
                 _configSettingsService.get_api_key(configuration, (key) =>
                     {
                         string authenticatedString = string.IsNullOrWhiteSpace(key.Key) ? string.Empty : "(Authenticated)";

src/chocolatey/infrastructure.app/commands/ChocolateyConfigCommand.cs

@@ -51,6 +51,9 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon
                     "value=",
                     "Value - the value of the config setting. Required with some actions. Defaults to empty.",
                     option => configuration.ConfigCommand.ConfigValue = option.remove_surrounding_quotes())
+                .Add(StringResources.Options.DISPLAY_HEADERS,
+                    StringResources.OptionDescriptions.DISPLAY_HEADERS,
+                    option => configuration.DisplayHeaders = true)
                 ;
         }
 

src/chocolatey/infrastructure.app/commands/ChocolateyFeatureCommand.cs

@@ -47,6 +47,9 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon
                 .Add("n=|name=",
                      "Name - the name of the source. Required with actions other than list. Defaults to empty.",
                      option => configuration.FeatureCommand.Name = option.remove_surrounding_quotes())
+                .Add(StringResources.Options.DISPLAY_HEADERS,
+                    StringResources.OptionDescriptions.DISPLAY_HEADERS,
+                    option => configuration.DisplayHeaders = true)
                 ;
         }
 

src/chocolatey/infrastructure.app/commands/ChocolateyInfoCommand.cs

@@ -73,6 +73,9 @@ public override void configure_argument_parser(OptionSet optionSet, ChocolateyCo
                             configuration.Features.UsePackageRepositoryOptimizations = false;
                         }
                     })
+                .Add(StringResources.Options.DISPLAY_HEADERS,
+                    StringResources.OptionDescriptions.DISPLAY_HEADERS,
+                    option => configuration.DisplayHeaders = true)
                 ;
         }
 

src/chocolatey/infrastructure.app/commands/ChocolateyListCommand.cs

@@ -136,6 +136,9 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon
                             configuration.Features.UsePackageRepositoryOptimizations = false;
                         }
                     })
+                .Add(StringResources.Options.DISPLAY_HEADERS,
+                    StringResources.OptionDescriptions.DISPLAY_HEADERS,
+                    option => configuration.DisplayHeaders = true)
                 ;
         }
 

src/chocolatey/infrastructure.app/commands/ChocolateyOutdatedCommand.cs

@@ -71,6 +71,9 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon
                             configuration.Features.UsePackageRepositoryOptimizations = false;
                         }
                     })
+                .Add(StringResources.Options.DISPLAY_HEADERS,
+                    StringResources.OptionDescriptions.DISPLAY_HEADERS,
+                    option => configuration.DisplayHeaders = true)
                 ;
         }