add copyright and authors to json report #22
Conversation
|
Latest commits addresses your comments. But are you sure you want all properties in text-output also(?), it does not necessarily scale very well since it potentially make a very 'wide' output ; Arguably the tab-output and json-output could be different : json is 'complete' while tab-output is only a summary of most relevant props - but I am not sure what is best way here. |
|
@notofug I'm fully aware of this and have been debating whether it's worth to add a command line flag that allows to enable/disable this. In general I'm not at all a fan of too many flags. I'm also not sure whether the tabular output should be moving towards a markdown compatible output which in turn will allow for the table to be rendered as html and thus avoiding the issues you describe. If the tabular output does not provide all of the information I'd at least have this deviation documented in the readme so that it is obvious to users that the two do not provide equivalent information..... |
src/NuGetUtility/Wrapper/NuGetWrapper/Protocol/WrappedPackageMetadata.cs
Show resolved
Hide resolved
tests/NuGetUtility.Test/LicenseValidator/LicenseValidatorTest.cs
Outdated
Show resolved
Hide resolved
| LicenseInformationOrigin.Ignored) | ||
| }) | ||
| .Using(new LicenseValidationResultValueEqualityComparer())); | ||
| } |
There was a problem hiding this comment.
I'm missing a test with multiple authors here.... With AutoData you should be able to easily create an array of strings
| @@ -21,13 +21,17 @@ public void SetUp() | |||
| new NuGetVersion(f.System.Semver()), | |||
| f.Internet.Url(), | |||
| f.Hacker.Phrase(), | |||
| null, | |||
There was a problem hiding this comment.
Can you please add tests for the filed formatting here as well?
There was a problem hiding this comment.
I had a go at this but have dont know how this stuff works so dont think I am right person for this ; otherwise believe I covered your requests
There was a problem hiding this comment.
I'll take a look when I get time....
|
@notofug would you mind putting in some documentation on what is supported for which output variant? |
|
All output-variants are extended with 'Copyright' and 'Authors'. Should that be mentioned in the readme, or is it something else you have in mind? |
|
Oh, right - I forgot that you added that. I think it's a good idea to add some documentation about c++ project support. However this belongs in a different PR... |
notofug
force-pushed
the
print_copyright_and_authors
branch
from
f05b4ba to
c50a02c
Compare
|
|
OK that set off merge problems so now it doesnt work aparently. Maybe it is better i you cherry-pick it into your project so you get it as you prefer to have it? |
| @@ -22,6 +22,9 @@ public async Task Write(Stream stream, IList<LicenseValidationResult> results) | |||
| new ColumnDefinition("Version", license => license.PackageVersion, license => true, true), | |||
| new ColumnDefinition("License Information Origin", license => license.LicenseInformationOrigin, license => true, true), | |||
| new ColumnDefinition("License Expression", license => license.License, license => license.License != null), | |||
| new ColumnDefinition("Copyright", license => license.Copyright, license => license.Copyright != null), | |||
| new ColumnDefinition("Copyrigth", license => license.Copyright, license => license.Copyright != null), | |||
There was a problem hiding this comment.
@notofug
This is a problem... this adds a copyright column with a typo
There was a problem hiding this comment.
yeah, was fixed already but came in again in megamerge.
There are so many changes in this PR now that I dont really trust it to be correct or reviewable anymore so maybe better if you cherry-pick if you want to bring it into main?
There was a problem hiding this comment.
Most changes are expected output... if you ignore all .txt files, things are not bad anymore
sensslen
force-pushed
the
main
branch
16 times, most recently
from
f54a3de to
7ca6e5d
Compare
|
This PR has been superseeded by #50 |
This PR adds 'copyright' and 'authors' to the json output for use in post-processing to generate complete list of third-party components. I hope this is in line with your plan for the tool
Another thing I would like in the json is a 'pointer' to the associated downloaded license.html but that is not included here.