Fix licenses in HTML output

[AyanSinhaMahapatra]

Fixes #3272

Tasks

• Reviewed contribution guidelines
• PR is descriptively titled 📑 and links the original issue above 🔗
• Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
  Run tests locally to check for errors.
• Commits are in uniquely-named feature branch and has no merge conflicts 📁

[pombredanne]

LGTM, but we need a test

[jbohrmann]

Hi, license text is not included in HTML-output. As I am new to scancode I am not sure if this is expected behavior.
I run scancode under windows (py 3.9).
I call it this way (--license-text-diagnostics also does not change the output):
scancode.bat -cleui -n 2 --html output.html . --license-score 2 --license-text --license-text-diagnostics

[AyanSinhaMahapatra]

@jbohrmann can you confirm that you used the checkout of this branch?

git clone https://github.com/nexB/scancode-toolkit.git
git checkout fix-html-output
./configure --dev
 scancode -clipeu --html output.html samples/

I seem to have licenses fine from this branch, attaching here the output.html file I generated using these commands above:
output.html

Also --html is a very basic output format, and does not have support for most of the advanced CLI options such as the one you have used:

• --license-score
• --license-text
• --license-text-diagnostics
  Use --json or --yaml to use all the supported CLI options.

[jbohrmann]

@jbohrmann can you confirm that you used the checkout of this branch?

git clone https://github.com/nexB/scancode-toolkit.git
git checkout fix-html-output
./configure --dev
 scancode -clipeu --html output.html samples/

I seem to have licenses fine from this branch, attaching here the output.html file I generated using these commands above: output.html

Also --html is a very basic output format, and does not have support for most of the advanced CLI options such as the one you have used:

• --license-score
• --license-text
• --license-text-diagnostics
  Use --json or --yaml to use all the supported CLI options.

Yes I can confirm.
Here is the info from my .VERSION file:

refs=refs/pull/3275/head, fix-html-output

I preferred HTML as I can pass the output easily to get legal advice.

[AyanSinhaMahapatra]

@jbohrmann what is your OS? also what is your installation process? Is it a git checkout or an app archive download? the .VERSION file looks like this https://github.com/nexB/scancode-toolkit/blob/develop/.VERSION when you are installing from a git checkout, what do you mean info from this file?
Can you do a git describe --tag for me and confirm that the output is v32.0.0rc2-2-g76795acd45 which is the last commit here?

See above the commit with added test for licenses in html, looks like they work fine now after these changes ^

[pombredanne]

@AyanSinhaMahapatra @jbohrmann said it was Windows and Python 3.9 ;)

I run scancode under windows (py 3.9).

[pombredanne]

but afaics, we do not include the license text be it the matched text or the reference text in the standard HTML output. Maybe we should. HTML is nicer than JSON for sure.

[AyanSinhaMahapatra]

@pombredanne We could have support for license-text, summary, license-clarity-score and others too in the HTML output, I opened an issue for this: #3281.

[jbohrmann]

I downloaded the branch as zip over Github. OS is Windows 10.
Maybe it would be helpful to mention in the documentation that at the moment --html does not support all features.

[pombredanne]

Maybe it would be helpful to mention in the documentation that at the moment --html does not support all features.

@jbohrmann you are right! Note that there are a few alternatives:

• scancode.io provides a web ui to display the matched license text
• it is possible otherwise to create a custom HTML template that would include the matched text

[JonoYang]

LGTM. I've tested out the HTML output on a scan of the samples directory and the results look great. Thanks!

[AyanSinhaMahapatra]

Thanks @JonoYang , merging!