Adding support for json output

README.md

@@ -36,10 +36,11 @@ A simple measure of dependency freshness
 
 `-r`, `--recursive`: search recursively for all compatible files, even if one is found in a directory passed as an argument
 
+`-o`, `--output`: sets how the output is displayed, valid options are `table` (default) or `json`. If `json` is selected, `--quiet` minifies the outputted JSON.
+
 #### Limits:
 
 `-l`, `--limit`: exits with error code if total libyears behind is greater than this value
 
 `-p`, `--limit-project`: exits with error code if any project is more libyears behind than this value
-
 `-a`, `--limit-any`: exits with error code if any dependency is more libyears behind than this value

src/LibYear.Core/LibYear.Core.csproj

@@ -19,7 +19,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
-		<PackageReference Include="NuGet.Protocol" Version="6.9.1" />
+		<PackageReference Include="NuGet.Protocol" Version="6.10.0" />
 		<None Include="../../README.md" CopyToOutputDirectory="PreserveNewest" Pack="true" PackagePath="." />
 		<PackageReference Include="System.IO.Abstractions" Version="21.0.2" />
 	</ItemGroup>

src/LibYear/App.cs

@@ -1,4 +1,7 @@
 using LibYear.Core;
+using LibYear.Output;
+using LibYear.Output.Json;
+using LibYear.Output.Table;
 using Spectre.Console;
 
 namespace LibYear;
@@ -27,7 +30,8 @@ public async Task<int> Run(Settings settings)
 		}
 
 		var result = await _checker.GetPackages(projects);
-		DisplayAllResultsTables(result, settings.QuietMode);
+		var output = GetOutputMethod(settings);
+		output.DisplayAllResults(result, settings.QuietMode);
 
 		if (settings.Update)
 		{
@@ -44,63 +48,11 @@ public async Task<int> Run(Settings settings)
 			: 0;
 	}
 
-	private void DisplayAllResultsTables(SolutionResult allResults, bool quietMode)
-	{
-		if (!allResults.Details.Any())
-			return;
-
-		int MaxLength(Func<Result, int> field) => allResults.Details.Max(results => results.Details.Any() ? results.Details.Max(field) : 0);
-		var namePad = Math.Max("Package".Length, MaxLength(r => r.Name.Length));
-		var installedPad = Math.Max("Installed".Length, MaxLength(r => r.Installed?.Version.ToString().Length ?? 0));
-		var latestPad = Math.Max("Latest".Length, MaxLength(r => r.Latest?.Version.ToString().Length ?? 0));
-
-		var width = allResults.Details.Max(r => r.ProjectFile.FileName.Length);
-		foreach (var results in allResults.Details)
-			GetResultsTable(results, width, namePad, installedPad, latestPad, quietMode);
-
-		if (allResults.Details.Count > 1)
-		{
-			_console.WriteLine($"Total is {allResults.YearsBehind:F1} libyears behind");
-		}
-	}
-
-	private void GetResultsTable(ProjectResult results, int titlePad, int namePad, int installedPad, int latestPad, bool quietMode)
-	{
-		if (results.Details.Count == 0)
-			return;
-
-		var width = Math.Max(titlePad + 2, namePad + installedPad + latestPad + 48) + 2;
-		var table = new Table
+	private IOutput GetOutputMethod(Settings settings) =>
+		settings.Output switch
 		{
-			Title = new TableTitle($"  {results.ProjectFile.FileName}".PadRight(width)),
-			Caption = new TableTitle(($"  Project is {results.YearsBehind:F1} libyears behind").PadRight(width)),
-			Width = width
+			OutputOption.Table => new TableOutput(_console),
+			OutputOption.Json => new JsonOutput(_console),
+			_ => throw new NotImplementedException()
 		};
-		table.AddColumn(new TableColumn("Package").Width(namePad));
-		table.AddColumn(new TableColumn("Installed").Width(installedPad));
-		table.AddColumn(new TableColumn("Released"));
-		table.AddColumn(new TableColumn("Latest").Width(latestPad));
-		table.AddColumn(new TableColumn("Released"));
-		table.AddColumn(new TableColumn("Age (y)"));
-
-		foreach (var result in results.Details.Where(r => !quietMode || r.YearsBehind > 0))
-		{
-			table.AddRow(
-				result.Name,
-				result.Installed?.Version.ToString() ?? string.Empty,
-				result.Installed?.Date.ToString("yyyy-MM-dd") ?? string.Empty,
-				result.Latest?.Version.ToString() ?? string.Empty,
-				result.Latest?.Date.ToString("yyyy-MM-dd") ?? string.Empty,
-				result.YearsBehind.ToString("F1")
-			);
-		}
-
-		if (quietMode && Math.Abs(results.YearsBehind) < double.Epsilon)
-		{
-			table.ShowHeaders = false;
-		}
-
-		_console.Write(table);
-		_console.WriteLine();
-	}
 }

src/LibYear/LibYear.csproj

@@ -22,7 +22,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
-		<PackageReference Include="Spectre.Console.Cli" Version="0.48.0" />
+		<PackageReference Include="Spectre.Console.Cli" Version="0.49.1" />
 		<ProjectReference Include="../LibYear.Core/LibYear.Core.csproj" />
 		<None Include="../../README.md" CopyToOutputDirectory="PreserveNewest" Pack="true" PackagePath="." />
 	</ItemGroup>

src/LibYear/Output/IOutput.cs

@@ -0,0 +1,8 @@
+using LibYear.Core;
+
+namespace LibYear.Output;
+
+public interface IOutput
+{
+	public void DisplayAllResults(SolutionResult allResults, bool quietMode);
+}

src/LibYear/Output/Json/DateTimeConverter.cs

@@ -0,0 +1,22 @@
+using System.Globalization;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace LibYear.Output.Json;
+
+public sealed class DateTimeConverter : JsonConverter<DateTime>
+{
+	public override DateTime Read(
+		ref Utf8JsonReader reader,
+		Type typeToConvert,
+		JsonSerializerOptions options) =>
+		DateTime.ParseExact(reader.GetString()!,
+			"yyyy-MM-dd", CultureInfo.InvariantCulture);
+
+	public override void Write(
+		Utf8JsonWriter writer,
+		DateTime dateTimeValue,
+		JsonSerializerOptions options) =>
+		writer.WriteStringValue(dateTimeValue.ToString(
+			"yyyy-MM-dd", CultureInfo.InvariantCulture));
+}

src/LibYear/Output/Json/DisplayVersion.cs

@@ -0,0 +1,15 @@
+using System.Text.Json.Serialization;
+using LibYear.Core;
+
+namespace LibYear.Output.Json;
+
+internal sealed record DisplayVersion
+{
+	public string VersionNumber { get; init; } = string.Empty;
+	public DateTime ReleaseDate { get; init; }
+	public DisplayVersion(Release release)
+	{
+		VersionNumber = release.Version.ToString();
+		ReleaseDate = release.Date;
+	}
+}

src/LibYear/Output/Json/DoubleFormatter.cs

@@ -0,0 +1,18 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace LibYear.Output.Json;
+
+internal sealed class DoubleFormatter : JsonConverter<double>
+{
+	public override double Read(
+		ref Utf8JsonReader reader,
+		Type typeToConvert,
+		JsonSerializerOptions options) => reader.GetDouble();
+
+	public override void Write(
+		Utf8JsonWriter writer,
+		double value,
+		JsonSerializerOptions options) =>
+		writer.WriteNumberValue(Math.Round(value, 1));
+}

src/LibYear/Output/Json/JsonOutput.cs

@@ -0,0 +1,39 @@
+using System.Text.Json;
+using LibYear.Core;
+using Spectre.Console;
+
+namespace LibYear.Output.Json;
+
+public sealed class JsonOutput : IOutput
+{
+	private readonly IAnsiConsole _console;
+
+	public JsonOutput(IAnsiConsole console)
+	{
+		_console = console;
+	}
+
+	public void DisplayAllResults(SolutionResult allResults, bool quietMode)
+	{
+		if (allResults.Details.Count == 0)
+			return;
+		var output = FormatOutput(allResults, quietMode);
+		_console.WriteLine(output);
+	}
+
+	public static string FormatOutput(SolutionResult allResults, bool quietMode)
+	{
+		var model = new ResultOutput(allResults);
+		var serializerOptions = new JsonSerializerOptions
+		{
+			Converters =
+			{
+				new DoubleFormatter(),
+				new DateTimeConverter()
+			},
+			WriteIndented = !quietMode
+		};
+		var output = JsonSerializer.Serialize(model, serializerOptions);
+		return output;
+	}
+}

src/LibYear/Output/Json/PackageResult.cs

@@ -0,0 +1,20 @@
+using System.Text.Json.Serialization;
+using LibYear.Core;
+
+namespace LibYear.Output.Json;
+
+internal sealed record PackageResult
+{
+	public string PackageName { get; set; } = string.Empty;
+	public DisplayVersion? CurrentVersion { get; init; }
+	public DisplayVersion? LatestVersion { get; init; }
+	public double YearsBehind { get; init; }
+
+	public PackageResult(Result result)
+	{
+		PackageName = result.Name;
+		YearsBehind = result.YearsBehind;
+		CurrentVersion = result.Installed is null ? null : new DisplayVersion(result.Installed);
+		LatestVersion = result.Latest is null ? null : new DisplayVersion(result.Latest);
+	}
+}

src/LibYear/Output/Json/ProjectFormatResult.cs

@@ -0,0 +1,17 @@
+using LibYear.Core;
+
+namespace LibYear.Output.Json;
+
+internal sealed record ProjectFormatResult
+{
+	public string Project { get; init; } = string.Empty;
+	public double YearsBehind { get; init; }
+	public IReadOnlyCollection<PackageResult> Packages { get; init; } = [];
+
+	public ProjectFormatResult(ProjectResult projectResult)
+	{
+		Project = projectResult.ProjectFile.FileName;
+		YearsBehind = projectResult.YearsBehind;
+		Packages = projectResult.Details.Select(result => new PackageResult(result)).ToArray();
+	}
+}

src/LibYear/Output/Json/ResultOutput.cs

@@ -0,0 +1,22 @@
+using System.Text.Json.Serialization;
+using LibYear.Core;
+
+namespace LibYear.Output.Json;
+
+internal sealed record ResultOutput
+{
+	public double YearsBehind { get; init; }
+	public double DaysBehind { get; init; }
+	public IReadOnlyCollection<ProjectFormatResult> Projects { get; set; } = [];
+
+	public ResultOutput()
+	{
+	}
+
+	public ResultOutput(SolutionResult solutionResult)
+	{
+		YearsBehind = solutionResult.YearsBehind;
+		DaysBehind = solutionResult.DaysBehind;
+		Projects = solutionResult.Details?.Select(project => new ProjectFormatResult(project)).ToArray() ?? Array.Empty<ProjectFormatResult>();
+	}
+}

src/LibYear/Output/OutputOption.cs

@@ -0,0 +1,7 @@
+namespace LibYear.Output;
+
+public enum OutputOption
+{
+	Table,
+	Json
+}

src/LibYear/Output/Table/TableOutput.cs

@@ -0,0 +1,73 @@
+using LibYear.Core;
+using Spectre.Console;
+
+namespace LibYear.Output.Table;
+
+public sealed class TableOutput : IOutput
+{
+	private readonly IAnsiConsole _console;
+
+	public TableOutput(IAnsiConsole console)
+	{
+		_console = console;
+	}
+
+	public void DisplayAllResults(SolutionResult allResults, bool quietMode)
+	{
+		if (!allResults.Details.Any())
+			return;
+
+		int MaxLength(Func<Result, int> field) => allResults.Details.Max(results => results.Details.Any() ? results.Details.Max(field) : 0);
+		var namePad = Math.Max("Package".Length, MaxLength(r => r.Name.Length));
+		var installedPad = Math.Max("Installed".Length, MaxLength(r => r.Installed?.Version.ToString().Length ?? 0));
+		var latestPad = Math.Max("Latest".Length, MaxLength(r => r.Latest?.Version.ToString().Length ?? 0));
+		var width = allResults.Details.Max(r => r.ProjectFile.FileName.Length);
+		foreach (var results in allResults.Details)
+			GetResultsTable(results, width, namePad, installedPad, latestPad, quietMode);
+
+		if (allResults.Details.Count > 1)
+		{
+			_console.WriteLine($"Total is {allResults.YearsBehind:F1} libyears behind");
+		}
+	}
+
+	private void GetResultsTable(ProjectResult results, int titlePad, int namePad, int installedPad, int latestPad, bool quietMode)
+	{
+		if (results.Details.Count == 0)
+			return;
+
+		var width = Math.Max(titlePad + 2, namePad + installedPad + latestPad + 48) + 2;
+		var table = new Spectre.Console.Table
+		{
+			Title = new TableTitle($"  {results.ProjectFile.FileName}".PadRight(width)),
+			Caption = new TableTitle(($"  Project is {results.YearsBehind:F1} libyears behind").PadRight(width)),
+			Width = width
+		};
+		table.AddColumn(new TableColumn("Package").Width(namePad));
+		table.AddColumn(new TableColumn("Installed").Width(installedPad));
+		table.AddColumn(new TableColumn("Released"));
+		table.AddColumn(new TableColumn("Latest").Width(latestPad));
+		table.AddColumn(new TableColumn("Released"));
+		table.AddColumn(new TableColumn("Age (y)"));
+
+		foreach (var result in results.Details.Where(r => !quietMode || r.YearsBehind > 0))
+		{
+			table.AddRow(
+				result.Name,
+				result.Installed?.Version.ToString() ?? string.Empty,
+				result.Installed?.Date.ToString("yyyy-MM-dd") ?? string.Empty,
+				result.Latest?.Version.ToString() ?? string.Empty,
+				result.Latest?.Date.ToString("yyyy-MM-dd") ?? string.Empty,
+				result.YearsBehind.ToString("F1")
+			);
+		}
+
+		if (quietMode && Math.Abs(results.YearsBehind) < double.Epsilon)
+		{
+			table.ShowHeaders = false;
+		}
+
+		_console.Write(table);
+		_console.WriteLine();
+	}
+}

src/LibYear/Settings.cs

@@ -1,4 +1,5 @@
 using System.ComponentModel;
+using LibYear.Output;
 using Spectre.Console.Cli;
 
 namespace LibYear;
@@ -32,4 +33,8 @@ public class Settings : CommandSettings
 	[CommandOption("-r|--recursive")]
 	[Description("search recursively for all compatible files, even if one is found in a directory passed as an argument")]
 	public bool Recursive { get; set; }
-}
+
+	[CommandOption("-o|--output")]
+	[Description("output format (table or JSON)")]
+	public OutputOption Output { get; set; } = OutputOption.Table;
+}