Skip to content

Implement HTML output for validation report (MVP) #1126

@maximearmstrong

Description

@maximearmstrong

Feature request

Currently, the validation report is only available as a JSON file. Adding an HTML output would improve the user experience.

Is your feature request related to a problem? Please describe.
Browsing through the JSON validation report can be complicated and tedious, especially for user with low to mid technical knowledge. This is an obstacle to the use of the product.

Proposed solution
Inspired by Trillium work in PR #1119, we suggest implement a lean HTML + CSS + JavaScript output. The file will be self-contained so it can live on its own. We suggest using jQuery instead of a front-end framework like React or Snabbdom as we are no longer going for a local/hosted web UI app.

Steps:

  • Output prototype
  • Add the jQuery dependency
  • Add the components to generate the HTML output
  • Modify the validator main to add the generation of the HTML output during the export of the validation report.
  • Add tests.

Describe alternatives you've considered
We considered using React or Snabbdom at first. The initial idea was to create a local web UI, then to host it. This is not a feature we are considering doing anymore.

Additional context
Trillium did great work in PR #1119 to implement a front-end framework and a UI.
Issue #1112 explains the previous feature we were considering, the local web UI.
Epic #1124 explains the current feature we are considering, a packaged executable and an HTML output.

Metadata

Metadata

Labels

enhancementNew feature request or improvement on an existing feature

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions