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

report screen confusing #112

Open
juliangruber opened this Issue Mar 13, 2019 · 0 comments

Comments

Projects
None yet
1 participant
@juliangruber
Copy link
Member

juliangruber commented Mar 13, 2019

Can we improve the UX of the report screen?

0 critical risk

This looks slightly confusing because there's a red exclamation mark before the 0 critical risk, although there's no module with critical risk.

What about either removing that exclamation mark or removing the whole line if there's no module with that risk level?

Screenshot 2019-03-13 at 09 58 33

grouping of results

What I also find confusing is the ! 5 noncompliant modules found |➔ Runncm report --filter=compliance for a list section, because it's unweighted. I don't know if this is a problem or not. Thinking about it more of course I know that a bad license is a deal breaker, but I wonder if it's obvious that noncompliant means bad license. What about adding headings to this output, to give more meaning to the the blocks? Eg


╔════════════════╗
║ ncm-cli Report ║
╚════════════════╝

608 packages checked

# Risk

  ! 0 critical risk
    22 high risk
    71 medium risk
    156 low risk

# Vulnerabilities

  ✓ No security vulnerabilities found

# Licenses

  ! 5 noncompliant modules found
    |➔ Run `ncm report --filter=compliance` for a list

highest risk modules

The order of output is confusing when there's noncompliant modules:

...
  ! 5 noncompliant modules found
    |➔ Run `ncm report --filter=compliance` for a list

─────────────────────────────────────────────────────────────────────────────────────────────────
  Top 5: Highest Risk Modules
-------------------------------------------------------------------------------------------------
  Module Name                               Risk         License                 Security
┌──────────────────────────────────────────┬────────────┬───────────────────────┬───────────────┐
│ @yarnpkg/lockfile @ 1.1.0                │ |||| High  │ ✓ BSD-2-Clause        │ ✓ 0           │
│ async @ 2.6.2                            │ |||| High  │ ✓ MIT                 │ ✓ 0           │
│ circular-json @ 0.3.3                    │ |||| High  │ ✓ MIT                 │ ✓ 0           │
│ depd @ 1.1.2                             │ |||| High  │ ✓ MIT                 │ ✓ 0           │
│ es-abstract @ 1.12.0                     │ |||| High  │ ✓ MIT                 │ ✓ 0           │
└──────────────────────────────────────────┴────────────┴───────────────────────┴───────────────┘

If I wasn't to read the heading Top 5: Highest Risk Modules I would have expected this list to contain the 5 noncompliant modules mentioned above. This section in this report isn't even adding any value I think, because 1) it confuses 2) it mentions which packages have a high risk score but not why. What about just removing that section?

@juliangruber juliangruber changed the title red exclamation mark although no critical risk report screen confusing Mar 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.