Skip to content

Implement stdout report formatting #190

Closed

Description

@matejchalk

Follow-up to:

PoC:

Structure

For visual details (alignment, spacing, colors, etc.), refer to PoC implementation linked above.

  • for each plugin:
    • plugin title as heading (with audits suffix)
    • list plugin's audits:
      • ● colored red/yellow/green based on audit's score (thresholds are 50 and 90, same as for Implement report.md formatting #148)
      • audit title
      • audit display value (or raw value if missing) - highlighted (bright cyan)
  • Categories heading
  • table with each category:
    • category title
    • formatted score (0-100) in bold with red/yellow/green coloring
    • total number of audits (from category refs with "expanded" groups - same as Implement report.md formatting #148)

Implementation notes

Design

Image

Activity

  1. BioPhoton commented on Nov 1, 2023

    @BioPhoton
    Collaborator

    ● colored red/yellow/green based on audit's score (thresholds are 50 and 90, same as for #148)

    I miss informative audits in ⚪️ color

  2. matejchalk commented on Nov 1, 2023

    @matejchalk
    CollaboratorAuthor

    ● colored red/yellow/green based on audit's score (thresholds are 50 and 90, same as for #148)

    I miss informative audits in ⚪️ color

    It can't apply here, because all audits are listed irrespective of which categories reference them. Audit weight 0 only applies when referenced in a category. It could apply to a category detail section, but I didn't include that in the stdout, I wanted to keep it more streamlined (stdout is most concise representation of the data, markdown is richer and portal is most rich), but also have useful information when a user hasn't configured categories yet (seeing the stdout is part of the 1st contact).

  3. BioPhoton commented on Nov 1, 2023

    @BioPhoton
    Collaborator

    seeing the stdout is part of the 1st contact
    Yes

  4. added this to the 1. Internal MVP milestone on Nov 1, 2023
  5. self-assigned this
    on Nov 3, 2023
  6. added 3 commits that reference this issue on Nov 6, 2023
    5d88568
    96cfa7c
    493946b
  7. added a commit that references this issue on Nov 13, 2023
    84b8c28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions