Fix --version and --help being too noisy

Author: Mpdreamz

src/Elastic.Documentation.ServiceDefaults/AppDefaultsExtensions.cs

@@ -13,6 +13,8 @@
 
 namespace Elastic.Documentation.ServiceDefaults;
 
+public record CliInvocation(bool IsHelpOrVersion);
+
 public static class AppDefaultsExtensions
 {
 	public static TBuilder AddDocumentationServiceDefaults<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
@@ -26,7 +28,7 @@ public static TBuilder AddDocumentationServiceDefaults<TBuilder>(this TBuilder b
 	public static TBuilder AddDocumentationServiceDefaults<TBuilder>(this TBuilder builder, ref string[] args, LogLevel? defaultLogLevel = null, Action<IServiceCollection, ConfigurationFileProvider>? configure = null) where TBuilder : IHostApplicationBuilder
 	{
 		var logLevel = defaultLogLevel ?? LogLevel.Information;
-		GlobalCommandLine.Process(ref args, ref logLevel, out var skipPrivateRepositories);
+		GlobalCommandLine.Process(ref args, ref logLevel, out var skipPrivateRepositories, out var isHelpOrVersion);
 
 		var services = builder.Services;
 		_ = services
@@ -36,6 +38,7 @@ public static TBuilder AddDocumentationServiceDefaults<TBuilder>(this TBuilder b
 				configure?.Invoke(s, p);
 			});
 		_ = builder.Services.AddElasticDocumentationLogging(logLevel);
+		_ = services.AddSingleton(new CliInvocation(isHelpOrVersion));
 
 		return builder.AddServiceDefaults();
 	}

src/Elastic.Documentation/GlobalCommandLine.cs

@@ -8,9 +8,15 @@ namespace Elastic.Documentation;
 
 public static class GlobalCommandLine
 {
-	public static void Process(ref string[] args, ref LogLevel defaultLogLevel, out bool skipPrivateRepositories)
+	public static void Process(
+		ref string[] args,
+		ref LogLevel defaultLogLevel,
+		out bool skipPrivateRepositories,
+		out bool isHelpOrVersion
+	)
 	{
 		skipPrivateRepositories = false;
+		isHelpOrVersion = false;
 		var newArgs = new List<string>();
 		for (var i = 0; i < args.Length; i++)
 		{
@@ -22,8 +28,11 @@ public static void Process(ref string[] args, ref LogLevel defaultLogLevel, out
 			}
 			else if (args[i] == "--skip-private-repositories")
 				skipPrivateRepositories = true;
-			else if (args[i] == "--inject")
-				skipPrivateRepositories = true;
+			else if (args[i] is "--help" or "--version")
+			{
+				isHelpOrVersion = true;
+				newArgs.Add(args[i]);
+			}
 			else
 				newArgs.Add(args[i]);
 		}

src/tooling/Elastic.Documentation.Tooling/DocumentationTooling.cs

@@ -9,6 +9,7 @@
 using Elastic.Documentation.Configuration;
 using Elastic.Documentation.Configuration.Versions;
 using Elastic.Documentation.Diagnostics;
+using Elastic.Documentation.ServiceDefaults;
 using Elastic.Documentation.Tooling.Diagnostics.Console;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -33,9 +34,12 @@ public static TBuilder AddDocumentationToolingDefaults<TBuilder>(this TBuilder b
 			{
 				var logFactory = sp.GetRequiredService<ILoggerFactory>();
 				var githubActionsService = sp.GetRequiredService<ICoreService>();
+				var isHelp = sp.GetRequiredService<CliInvocation>();
+				if (isHelp.IsHelpOrVersion)
+					return new DiagnosticsCollector([]);
 				return new ConsoleDiagnosticsCollector(logFactory, githubActionsService)
 				{
-					NoHints = true
+					NoHints = false
 				};
 			})
 			.AddSingleton(sp =>

src/tooling/Elastic.Documentation.Tooling/Filters/InfoLoggerFilter.cs

@@ -5,19 +5,31 @@
 using System.Reflection;
 using ConsoleAppFramework;
 using Elastic.Documentation.Configuration;
+using Elastic.Documentation.ServiceDefaults;
 using Microsoft.Extensions.Logging;
 
 namespace Elastic.Documentation.Tooling.Filters;
 
-public class InfoLoggerFilter(ConsoleAppFilter next, ILogger<InfoLoggerFilter> logger, ConfigurationFileProvider fileProvider) : ConsoleAppFilter(next)
+public class InfoLoggerFilter(
+	ConsoleAppFilter next,
+	ILogger<InfoLoggerFilter> logger,
+	ConfigurationFileProvider fileProvider,
+	CliInvocation cliInvocation
+)
+	: ConsoleAppFilter(next)
 {
 	public override async Task InvokeAsync(ConsoleAppContext context, Cancel cancellationToken)
 	{
+		var assemblyVersion = Assembly.GetExecutingAssembly().GetCustomAttributes<AssemblyInformationalVersionAttribute>()
+			.FirstOrDefault()?.InformationalVersion;
+		if (cliInvocation.IsHelpOrVersion)
+		{
+			await Next.InvokeAsync(context, cancellationToken);
+			return;
+		}
 		logger.LogInformation("Configuration source: {ConfigurationSource}", fileProvider.ConfigurationSource.ToStringFast(true));
 		if (fileProvider.ConfigurationSource == ConfigurationSource.Checkout)
 			logger.LogInformation("Configuration source git reference: {ConfigurationSourceGitReference}", fileProvider.GitReference);
-		var assemblyVersion = Assembly.GetExecutingAssembly().GetCustomAttributes<AssemblyInformationalVersionAttribute>()
-			.FirstOrDefault()?.InformationalVersion;
 		logger.LogInformation("Version: {Version}", assemblyVersion);
 		await Next.InvokeAsync(context, cancellationToken);
 	}

src/tooling/docs-assembler/Program.cs

@@ -46,14 +46,17 @@
 
 await app.RunAsync(args);
 
-internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger)
+internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger, CliInvocation cli)
 	: ConsoleAppFilter(next)
 {
 	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
 	public override Task InvokeAsync(ConsoleAppContext context, Cancel cancellationToken)
 	{
-		ConsoleApp.Log = msg => logger.LogInformation(msg);
-		ConsoleApp.LogError = msg => logger.LogError(msg);
+		if (!cli.IsHelpOrVersion)
+		{
+			ConsoleApp.Log = msg => logger.LogInformation(msg);
+			ConsoleApp.LogError = msg => logger.LogError(msg);
+		}
 
 		return Next.InvokeAsync(context, cancellationToken);
 	}

src/tooling/docs-builder/Filters/CheckForUpdatesFilter.cs

@@ -6,10 +6,11 @@
 using ConsoleAppFramework;
 using Elastic.Documentation;
 using Elastic.Documentation.Configuration;
+using Elastic.Documentation.ServiceDefaults;
 
 namespace Documentation.Builder.Filters;
 
-internal sealed class CheckForUpdatesFilter(ConsoleAppFilter next) : ConsoleAppFilter(next)
+internal sealed class CheckForUpdatesFilter(ConsoleAppFilter next, CliInvocation cliInvocation) : ConsoleAppFilter(next)
 {
 	private readonly FileInfo _stateFile = new(Path.Combine(Paths.ApplicationData.FullName, "docs-build-check.state"));
 
@@ -18,6 +19,8 @@ public override async Task InvokeAsync(ConsoleAppContext context, Cancel ctx)
 		await Next.InvokeAsync(context, ctx);
 		if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("CI")))
 			return;
+		if (cliInvocation.IsHelpOrVersion)
+			return;
 
 		var latestVersionUrl = await GetLatestVersion(ctx);
 		if (latestVersionUrl is null)

src/tooling/docs-builder/Filters/ReplaceLogFilter.cs

@@ -4,18 +4,22 @@
 
 using System.Diagnostics.CodeAnalysis;
 using ConsoleAppFramework;
+using Elastic.Documentation.ServiceDefaults;
 using Microsoft.Extensions.Logging;
 
 namespace Documentation.Builder.Filters;
 
-internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger)
+internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger, CliInvocation cli)
 	: ConsoleAppFilter(next)
 {
 	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
 	public override Task InvokeAsync(ConsoleAppContext context, Cancel cancellationToken)
 	{
-		ConsoleApp.Log = msg => logger.LogInformation(msg);
-		ConsoleApp.LogError = msg => logger.LogError(msg);
+		if (!cli.IsHelpOrVersion)
+		{
+			ConsoleApp.Log = msg => logger.LogInformation(msg);
+			ConsoleApp.LogError = msg => logger.LogError(msg);
+		}
 
 		return Next.InvokeAsync(context, cancellationToken);
 	}