Skip to content

Conversation

@ghost
Copy link

@ghost ghost commented Oct 9, 2025

Closes #460

What does this PR do?

This PR implements the requested feature to disable the large Guidance and Appendices sections in the generated HTML reports to significantly reduce file size.

A new optional boolean CLI flag, --disable-report-tabs (-dRT), has been added to the scan command.

When the flag is used:

  1. The large static content for the Guidance and Appendices sections is excluded from the HTML file via logic added to report.py.
  2. The navigation links for these tabs are hidden.

This is a performance and workflow enhancement, as it allows users to generate much smaller HTML reports, which is beneficial for automated processes and storage.


What gif best describes this PR or how it makes you feel?


Completion checklist

  • Additions and changes have unit tests
  • The pull request has been appropriately labeled using the provided PR labels (e.g., feature, enhancement)
  • GitHub actions automation is passing (make test, make lint, make security-test, make test-js) (Assuming the tests pass once the maintainer runs them)
  • If the UI contents or JavaScript files have been modified, generate a new example report:
    # Generated updated Javascript bundle
    npm run build
    
    # Generated the example report
    python -m cloudsplaining.bin.cli scan -i test/files/example-authz-details.json -o .. -s --disable-report-tabs

@salesforce-cla
Copy link

salesforce-cla bot commented Oct 9, 2025

Thanks for the contribution! Before we can merge this, we need @kaiprvn to sign the Salesforce Inc. Contributor License Agreement.

@gruebel
Copy link
Collaborator

gruebel commented Oct 9, 2025

Done via #475

@gruebel gruebel closed this Oct 9, 2025
@ghost ghost deleted the disable-report-tabs branch October 11, 2025 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature request: Option to disable Guidance and Appendices tabs in reports

1 participant