Upgrade HTML output to support various CLI options #4682

uttam282005 · 2026-01-15T10:29:52Z

Description

This PR adds support for additional CLI options in HTML output to match the functionality available in JSON/YAML formats:

--license-text: Display matched license text
--license-text-diagnostics: Show diagnostic information for license matches
--summary: Display scan summary with declared license and holder information
--license-clarity-score: Show license clarity score breakdown

Changes Made

Template Changes (`src/formattedcode/templates/html/template.html`)

Added Scan Summary section displaying:
- Declared license expression
- Declared holder
- Primary language
- Other license expressions (with counts)
- Other holders
Added License Clarity Score table showing:
- Overall score (0-100)
- Component metrics (declared_license, identification_precision, has_license_text, etc.)
Enhanced Copyrights and Licenses table:
- Added new column for matched text and diagnostics
- Used HTML5 <details>/<summary> elements for collapsible sections
- Display matched text when --license-text is used
- Display diagnostics when --license-text-diagnostics is used
Added CSS styling for new elements

Code Changes (`src/formattedcode/output_html.py`)

Modified generate_output() to pass summary parameter to template.generate()
Summary data already being collected in process_codebase() - just needed to be passed through

Testing

Tested with various command combinations:

# License text
scancode --license --license-text test_dir/ --html output.html

# License text with diagnostics
scancode --license --license-text --license-text-diagnostics test_dir/ --html output.html

# Summary and clarity score
scancode --license --classify --summary --license-clarity-score test_dir/ --html output.html

# All options combined
scancode --license --license-text --license-text-diagnostics --classify --summary --license-clarity-score --license-references test_dir/ --html output.html

…license-clarity-score in HTML output The HTML output now supports --license-text, --license-text-diagnostics, --summary,--license-clarity-score Signed-off-by: uttam282005 <uttam282005@gmail.com>

Signed-off-by: uttam282005 <uttam282005@gmail.com>

Copilot

Pull request overview

This PR adds support for additional CLI options (--license-text, --license-text-diagnostics, --summary, --license-clarity-score) in HTML output to match functionality available in JSON/YAML formats.

Changes:

Added template sections for Scan Summary and License Clarity Score display
Enhanced Copyrights and Licenses table with new column for matched text and diagnostics using collapsible HTML5 details/summary elements
Modified output_html.py to pass summary parameter through the template generation pipeline

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.

File	Description
src/formattedcode/templates/html/template.html	Added Scan Summary section, License Clarity Score table, and matched text/diagnostics column with collapsible display
src/formattedcode/output_html.py	Modified to extract and pass summary data, matched_text, and matched_text_diagnostics to template
tests/formattedcode/test_output_templated.py	Added integration tests for the new HTML output features

Comments suppressed due to low confidence (2)

src/formattedcode/output_html.py:160

Outdated docstring. The function signature includes a summary parameter, but the docstring doesn't document it. Update the docstring to describe the summary parameter.

    """
    Write scan output `results` to the `output_file` opened file using a template
    file at `template_loc`.
    Raise an exception on errors.
    """

src/formattedcode/output_html.py:200

Outdated docstring. The function signature includes license_references and summary parameters, but the docstring only mentions results and version. Update the docstring to describe all parameters including license_references and summary.

    """
    Yield unicode strings from incrementally rendering `results` and `version`
    with the Jinja `template` object.
    """

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/formattedcode/output_html.py

src/formattedcode/templates/html/template.html

Copilot · 2026-01-15T10:35:43Z

src/formattedcode/templates/html/template.html

+      <p><strong>Other Holders:</strong></p>
+      <ul>
+        {% for holder in summary.other_holders %}
+        <li>{{ holder }}</li>


Incorrect template variable access. The other_holders list contains dictionary objects with 'value' and 'count' keys (similar to other_license_expressions), but the template is rendering the holder object directly instead of accessing holder.value. Change the line to display holder.value and optionally holder.count to match the format used for other_license_expressions.

Suggested change

<li>{{ holder }}</li>

<li>{{ holder.value }}{% if holder.count is not none %} (count: {{ holder.count }}){% endif %}</li>

src/formattedcode/templates/html/template.html

Copilot · 2026-01-15T10:35:43Z

tests/formattedcode/test_output_templated.py

+    test_file = test_env.get_test_loc('templated/simple-license.txt')
+    result_file = test_env.get_temp_file('html')
+    run_scan_click(['--license', '--license-text', test_file, '--html', result_file])
+    results = open(result_file).read()


File is opened but is not closed.

Copilot · 2026-01-15T10:35:44Z

tests/formattedcode/test_output_templated.py

+    result_file = test_env.get_temp_file('html')
+    run_scan_click(['--license', '--license-text', '--license-text-diagnostics', 
+                    test_file, '--html', result_file])
+    results = open(result_file).read()


File is opened but is not closed.

Copilot · 2026-01-15T10:35:44Z

tests/formattedcode/test_output_templated.py

+    result_file = test_env.get_temp_file('html')
+    run_scan_click(['--license', '--classify', '--license-clarity-score', 
+                    test_dir, '--html', result_file])
+    results = open(result_file).read()


File is opened but is not closed.

Copilot · 2026-01-15T10:35:44Z

tests/formattedcode/test_output_templated.py

+    result_file = test_env.get_temp_file('html')
+    run_scan_click(['--license', '--classify', '--summary', 
+                    test_dir, '--html', result_file])
+    results = open(result_file).read()


File is opened but is not closed.

Signed-off-by: uttam282005 <uttam282005@gmail.com>

uttam282005 added 3 commits January 15, 2026 15:18

Add support for license-text, license-text-diagnostics, summary, and …

9ee0b38

…license-clarity-score in HTML output The HTML output now supports --license-text, --license-text-diagnostics, --summary,--license-clarity-score Signed-off-by: uttam282005 <uttam282005@gmail.com>

add tests

2a3b647

Signed-off-by: uttam282005 <uttam282005@gmail.com>

turn off trace and remove debug logs

32520d4

Signed-off-by: uttam282005 <uttam282005@gmail.com>

Copilot AI review requested due to automatic review settings January 15, 2026 10:29

Copilot started reviewing on behalf of uttam282005 January 15, 2026 10:30 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

uttam282005 added 2 commits January 15, 2026 16:41

apply suggestions that makes sense

884db4d

Signed-off-by: uttam282005 <uttam282005@gmail.com>

fix table misallignement

297bca6

Signed-off-by: uttam282005 <uttam282005@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Upgrade HTML output to support various CLI options #4682

Upgrade HTML output to support various CLI options #4682

uttam282005 commented Jan 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 15, 2026

Uh oh!

Uh oh!

Copilot AI Jan 15, 2026

Uh oh!

Copilot AI Jan 15, 2026

Uh oh!

Copilot AI Jan 15, 2026

Uh oh!

Copilot AI Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	<li>{{ holder }}</li>
	<li>{{ holder.value }}{% if holder.count is not none %} (count: {{ holder.count }}){% endif %}</li>

Uh oh!

Upgrade HTML output to support various CLI options #4682

Are you sure you want to change the base?

Upgrade HTML output to support various CLI options #4682

Conversation

uttam282005 commented Jan 15, 2026

Description

Changes Made

Template Changes (src/formattedcode/templates/html/template.html)

Code Changes (src/formattedcode/output_html.py)

Testing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Template Changes (`src/formattedcode/templates/html/template.html`)

Code Changes (`src/formattedcode/output_html.py`)