Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sorting audits in stdout and MD format #210

Closed
Tlacenka opened this issue Nov 9, 2023 · 1 comment · Fixed by #302
Closed

Sorting audits in stdout and MD format #210

Tlacenka opened this issue Nov 9, 2023 · 1 comment · Fixed by #302
Assignees
Labels
➕ enhancement new feature or request 🧩 utils

Comments

@Tlacenka
Copy link
Collaborator

Tlacenka commented Nov 9, 2023

As a CLI only user, I want to make sense of my text output. Currently, I have to skim through the whole list of audits as they are not ordered in any obvious way.

This ordering could be inspired by the one in portal where we also want to ensure simple access to what user needs. We could maybe even create a separate argument which would accept an enumerated value which would be used for the ordering.

Implementation details

  • Primarily based on weight in descending order - users will most likely want to prioritise seeing the biggest score contributors.
  • Secondarily based on score in the ascenading order - errors first.
  • Tertiary ordering is based on value in descending order - usually bigger value means worse.
  • Lastly the alphabetical order for the title.
@Tlacenka Tlacenka added the ➕ enhancement new feature or request label Nov 9, 2023
@Tlacenka Tlacenka changed the title Sorting stdout and MD output Sorting audits in stdout and MD format Nov 9, 2023
@kristihoskova kristihoskova added this to the 2. Integration milestone Nov 13, 2023
@MishaSeredenkoPushBased
Copy link
Contributor

Clarified requirements with @Tlacenka -

  1. For MD, in Audits section keep separation by plugins. Sort audits inside, skip sorting by weight as it's not present.
    Same for stdout.
  2. Keep categories at MD unsorted, in the order as defined at config. Sort groups and audits at the categories by the order defined in the description.

MishaSeredenkoPushBased added a commit that referenced this issue Nov 23, 2023
Added audits sorting for both reports, md and stdout, added sorting of
audits at the categories and groups.
Closes #210
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
➕ enhancement new feature or request 🧩 utils
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants