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

For discussion: outdated information in docs #89

Closed
DanielRuf opened this issue May 20, 2019 · 1 comment · Fixed by #98
Closed

For discussion: outdated information in docs #89

DanielRuf opened this issue May 20, 2019 · 1 comment · Fixed by #98
Assignees
Labels

Comments

@DanielRuf
Copy link
Collaborator

DanielRuf commented May 20, 2019

I was checking the current version of the docs and found some possibly outdated information.

npm audit is reserved for npm

This is not the case anymore, see yarnpkg/yarn#5808 and yarnpkg/yarn@49a157c

We just need a JSON representation of yarn.lock which is already possible.
https://github.com/npm/cli/blob/36682d4482cddee0acc55e8d75b3bee6e78fff37/lib/audit.js

npm audit installs a module even if it has vulnerabilities

Not really correct. You can run npm audit with only a lockfile. It does not install any package by itself. It just runs after a normal npm install when it can get the full deptree from the lockfile. See https://travis-ci.com/DanielRuf/audit-test/builds/112367931
https://github.com/imsnif/synp does the conversion for example

➜  test-npq rm -rf node_modules 
➜  test-npq npm audit
                                                                                
                       === npm audit security report ===                        
                                                                                
found 0 vulnerabilities
 in 196 scanned packages
➜  test-npq ll
total 120
-rw-r--r--  1 druf  UEBERBIT\Domänen-Benutzer    28K May 20 09:00 package-lock.json
-rw-r--r--  1 druf  UEBERBIT\Domänen-Benutzer   163B May 20 08:59 package.json
-rw-r--r--  1 druf  UEBERBIT\Domänen-Benutzer    27K May 20 08:59 yarn.lock

➜  test-npq yarn audit
yarn audit v1.15.2
0 vulnerabilities found - Packages audited: 196
✨  Done in 0.64s.
➜  test-npq ll
total 120
-rw-r--r--  1 druf  UEBERBIT\Domänen-Benutzer    28K May 20 09:00 package-lock.json
-rw-r--r--  1 druf  UEBERBIT\Domänen-Benutzer   163B May 20 08:59 package.json
-rw-r--r--  1 druf  UEBERBIT\Domänen-Benutzer    27K May 20 08:59 yarn.lock

Maybe we can improve these parts in the docs =)

@lirantal
Copy link
Owner

lirantal commented Jun 8, 2019

🎉 This issue has been resolved in version 1.14.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants