yesiscan icon indicating copy to clipboard operation
yesiscan copied to clipboard

Reports need a higher signal to noise ratio

Open ajorg-aws opened this issue 2 years ago • 1 comments

The current draft HTML reports have a summary at the top that's a count of licenses found, and then the rest of the report is a detailed file-by-file account of everything. I think what we need is to summarize more, but not totally, with the option to drill deeper into the details as needed.

For example, if every license found under a subdirectory is the same license, list the directory instead of the files, but with the ability to drill into files.

If every file in a directory has the same license(s), except one (or few) file is an exception, list the directory and its license, followed by the specific file that didn't match. Again with the ability to drill deeper.

If two scanners agree, instead of listing both, with their weights and confidence percentages, show the license but allow the viewer to drill deeper into the details.

In general the report should contain the data, but should present information that's useful to the viewer first. A project will millions of files would be a deluge of data that would be very hard to find any information in, and we'd have to write another tool to parse the data and give information as an output. I think it makes more sense for yesiscan to do that directly.

ajorg-aws avatar Aug 16 '22 18:08 ajorg-aws