Skip to content

Improve the Comprehensibility of Code Snippets in Quality Report View

🚀 Feature Request

Summary

Improve the comprehensibility of code snippets in the Quality Report View by implementing formatting enhancements. This will make incidents easier to understand and analyze.

Problem to Solve / User Story

As a Constrainify user, I want to quickly comprehend the relevant code snippet for reported incident so that I can efficiently identify the issue to solve.

Proposed Solution

To enhance comprehensibility, consider implementing the following improvements:

  1. Adding Line Numbers: Display line numbers alongside the code snippets to provide better reference points.
  2. Highlighting Key Elements: Emphasize the specific attribute or element related to the incident using background highlighting.

Benefits

  • Improved clarity and focus on relevant parts of the code snippet.
  • Better user experience.

Possible Drawbacks

  • JSON Schema of quality report by QPM may change and require adaption
  • Technical limitations of approach used by QPM

Alternatives Considered

  • Keeping the current format and reduce output only the line containing the element or attribute and line number