-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Isaacs/docs lockfile #2475
Isaacs/docs lockfile #2475
Conversation
@@ -190,5 +190,4 @@ $ npm audit --audit-level=moderate | |||
### See Also | |||
|
|||
* [npm install](/commands/npm-install) | |||
* [package-locks](/configuring-npm/package-locks) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
isn’t this still relevant, since npm audit still unfortunately requires a lockfile?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It just felt somewhat out of place, especially in the "configuring-npm" section, since it's much more conceptual.
Maybe it should be brought back in (and updated for correctness) in the using-npm section?
Also, maybe Arborist.audit() should do this.loadVirtual().catch(() => this.loadActual())
or .catch(() => this.buildIdealTree())
, so a lockfile isn't required? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Screw the docs, yes please do that :-D
- [Checking your version of npm and Node.js](#checking-your-version-of-npm-and-node-js) | ||
- [Using a Node version manager to install Node.js and npm](#using-a-node-version-manager-to-install-node-js-and-npm) | ||
- [Using a Node installer to install Node.js and npm](#using-a-node-installer-to-install-node-js-and-npm) | ||
- [Checking your version of npm and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the hard wraps make it very awkward to review and presumably edit the text, and also makes git diffs much noisier; is there a reason it doesn’t soft wrap?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do hard wraps everywhere else in the docs. In vim, it definitely makes it easier to edit, and gq{
will re-wrap an entire paragraph easily. I typically view markdown diffs with the "rich diff" mode, so whitespace is ignored and you can just read the rendered text more easily.
I would only be mildly opposed to moving to soft wraps (since I'd have to retrain some vim settings and muscle memory) but that's a separate conversation, and in the meantime, consistency is the way to go, imo.
no statistically significant performance changes detected timing results
|
75c26ac
to
09df82c
Compare
Updated docs to be correct and consistent, that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok the shrinkwrap stuff is consistent now
docs for the locks
References