Adding support for json output

[priorax]

At the moment this project only supports output to a table. While fantastic for human readability, it leads something to be desired when it comes to machine readability.

Use:

• dotnet libyear > Prints using table output in console dotnet libyear -o console > Prints using table output in console
• dotnet run -o json > Prints indented json
• dotnet libyear -o json -q > Prints non-indented json

This is currently useful to me as I would like to be able to run this project against several code bases in a single parse and easily collate the results.

Ideal state may also include hiding the progress bar when searching for results, but I was unsure if that would be valuable/helpful at all.

[SteveDesmond-ca]

Hi Doug, thanks for taking the time to submit this PR!

Something of this size will likely have multiple iterations of review, just letting you know up front so there is a mutual understanding of commitment.

The big note to start off with is test coverage: can you please ensure that all new code branches have a unit test showing their intended correctness?

[SteveDesmond-ca]

Thanks for these changes, we're getting there! I resolved a bunch of conversations and left the outstanding ones open.

[SteveDesmond-ca]

Looking good, almost there!

[SteveDesmond-ca]

Can we invert these ternaries (... is not null) to keep them in line with the others?

[SteveDesmond-ca]

(this one might be moot now if the whole class disappears)

[SteveDesmond-ca]

Let's add some tests for this bad boy as well

[SteveDesmond-ca]

Could we also name it DoubleConverter to match the convention of the base class and DateTimeConverter?

[SteveDesmond-ca]

Can we just use the underlying Release here? Might require a JsonConverter<PackageVersion> that returns its ToString()

[priorax]

Happy to put full release there, but given everything is currently public, everything would get included
That would currently look like

{
  "YearsBehind": 0,
  "DaysBehind": 0,
  "Projects": [
    {
      "Project": "test project 1",
      "YearsBehind": 0,
      "Packages": [
        {
          "PackageName": "test1",
          "CurrentVersion": {
            "versionNumber": "1.2.3",
            "releaseDate": "2024-05-30",
            "Release": {
              "Version": {
                "WildcardType": 0,
                "Version": "1.2.3.0",
                "IsLegacyVersion": false,
                "Revision": 0,
                "IsSemVer2": false,
                "OriginalVersion": null,
                "Major": 1,
                "Minor": 2,
                "Patch": 3,
                "ReleaseLabels": [],
                "Release": "",
                "IsPrerelease": false,
                "HasMetadata": false,
                "Metadata": null
              },
              "Date": "2024-05-30",
              "IsPublished": true
            }
          }
        }
      ]
    }
  ]
}

Is there anything that would to be removed/hidden/etc

[SteveDesmond-ca]

Sorry, should have been clearer here. Can we just use more of the existing model objects/classes in the JSON above?

• Packages becomes an array of Result
• Release (of which Result has 2, Installed and Latest) contains a PackageVersion
• Could that PackageVersion use a JsonConverter<PackageVersion> that returns just the ToString() interpretation of the version? (I may not have a proper understanding of JsonConverter<T>)

So the JSON from above would look like:

{
  "YearsBehind": 0,
  "Projects": [
    {
      "Project": "test project 1",
      "YearsBehind": 0,
      "Packages": [
        {
          "Name": "test1",
          "Installed": {
            "Version": "1.2.3",
            "Date": "2024-05-30",
            "IsPublished": true
          },
          "Latest": {
            "Version": "1.2.3",
            "Date": "2024-05-30",
            "IsPublished": true
          }
        }
      ]
    }
  ]
}

[SteveDesmond-ca]

So close, a big potential cleanup if my understanding is correct 🤞🏻

[SteveDesmond-ca]

Can we make sure the month and day are different numbers, just to ensure that a change to yyyy-dd-MM should fail the tests

[SteveDesmond-ca]

Looks like this has a bunch of copypasta leftovers from DateTimeConverterTests 😅

Can we also make sure the test object contains a number with more than one decimal, so that we're testing the rounding properly?

[SteveDesmond-ca]

(this one might be moot now if the whole class disappears)