Skip to content

Design: Improve stdout for CLI #151

Closed

Description

@matejchalk

PoC for how CLI's stdout should look and description for follow-up issue.

  • category title and scores should be included and clearly highlighted
  • each plugin's audit results should be listed on a single line (title: result - no descriptions, no weights)
  • should display status of each stage (spinner, then completed)
    • parsing configuration (print if verbose?)
    • executing plugin X - title, number of audits, duration once completed
    • creating report file(s)
    • uploading to portal
  • TBD: should stdout really be a format? --verbose is more usual way of limiting stdout

Current version (for reference)

Image

Activity

  1. self-assigned this
    on Oct 25, 2023
  2. changed the title [-]Improve stdout for CLI[/-] [+]Design: Improve stdout for CLI[/+] on Oct 25, 2023
  3. added this to the 1. Internal MVP milestone on Oct 25, 2023
  4. matejchalk commented on Oct 27, 2023

    @matejchalk
    CollaboratorAuthor

    Update so far:

    • came up with a compact layout I like for audits and categories, PoC implemented with chalk, cliui and cli-table3 (see screenshot)
    • found @poppinss/cliui, which looks amazing - I plan to try it out next

    Image

  5. matejchalk commented on Oct 31, 2023

    @matejchalk
    CollaboratorAuthor

    Submitted draft PR to demo stdout formatting:

    Created follow-up issues to be refined:

  6. matejchalk commented on Nov 2, 2023

    @matejchalk
    CollaboratorAuthor

    Closing as the follow-up issues have been refined and prioritized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions