question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[Feature] Package names in summary audit report

See original GitHub issue

Hi, I think it would be useful to include a summary of affected packages in the audit report much like how yarn audit displays it. My issue is the audit summary displays too little information, but the full report displays too much. Thank you for considering, and more than happy to put in a PR if needed.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:2
  • Comments:10 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
quinnturnercommented, Apr 3, 2019

Note that I revised the potential approach in a new comment: https://github.com/IBM/audit-ci/pull/74#issuecomment-479696523

Exerpt:

One alternative that I am interested in as well would be adding the flag --report-type {summary, important, full}. This set up could support different report types in the future. I suggest we would default to important, which is the behaviour in the current PR. We would continue by deprecating the existing --summary and --report flags but continue to support them for “a while”, piping them to the associated --report-type (summary --> summary and report --> full) and console.warn the deprecation and potential future removal.

This approach would be a major bump to the version and would include documentation in the README for upgrading an upgrading strategy.

Open to discussion and preferences!

0reactions
quinnturnercommented, May 29, 2019

I have released v2.0.0 which addresses this issue by adding the --report-type option; which defaults to a new setting important. important shows the audit summary as well as relevant vulnerabilities instead of the full audit report or no relevant vulnerabilities. For now, I will close this. I see the value of adding a different way of formatting the output, but the original issue of adding package names in the summary audit report has been addressed. Feel free to open another issue for formatting the output if you feel that it would provide significant value.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Sample audit model and audit reports - IBM
Lists the executed reports, timestamps, and the associated package names for a tenant. This report provides a summary of total activity and the...
Read more >
Auditing Standard No. 3 - PCAOB
This standard establishes general requirements for documentation the auditor should prepare and retain in connection with engagements conducted pursuant to the ...
Read more >
Auditing package dependencies for security vulnerabilities
Running npm audit will produce a report of security vulnerabilities with the affected package name, vulnerability severity and description, path, ...
Read more >
NPM Audit: How to Scan Packages for Security Vulnerabilities
npm audit is a built-in security feature that scans your project for security ... Review the generated vulnerability report and take action, ...
Read more >
DCAA CONTRACT AUDIT MANUAL Chapter 10 Report Writing
characteristics of a quality audit report. It also includes a brief discussion of some important report writing techniques to assist auditors in preparing ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found