Skip to content
This repository has been archived by the owner on Feb 18, 2021. It is now read-only.

Commit

Permalink
fix documentation / oxford comma
Browse files Browse the repository at this point in the history
  • Loading branch information
ntindall committed Aug 26, 2017
1 parent 1915eb5 commit 8d44197
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,9 @@ Options:

#### `npm-shrinkwrap check`

Asserts that your `npm-shrinkwrap.json` file and node_modules
directory are in sync. If any excess modules are in your
node_modules folder, `check` will return an error and print
a list of the excess dependencies that are installed.
Asserts that your `npm-shrinkwrap.json` file, `package.json` file,
and node_modules directory are in sync. If any inconsistency
is found, an error is returned.

Options:
--dirname sets the directory of the npm-shrinkwrap.json
Expand Down
5 changes: 1 addition & 4 deletions bin/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,8 @@ function main(opts, callback) {
'into node_modules');
});
} else if (command === 'check') {
// Otherwise, we check to see if any erroneous dependencies are
// installed.
//
// We set opts.dry to true, which suppresses all side effects in the
// shrinkShrinkwrap routine.
// syncShrinkwrap routine.
opts.dry = true;

return syncShrinkwrap(opts, function (err, errorReport) {
Expand Down
7 changes: 3 additions & 4 deletions bin/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ Options:

## `{cmd} check`

Asserts that your `npm-shrinkwrap.json` file and node_modules
directory are in sync. If any excess modules are in your
node_modules folder, `check` will return an error and print
a list of the excess dependencies that are installed.
Asserts that your `npm-shrinkwrap.json` file, `package.json` file,
and node_modules directory are in sync. If any inconsistency
is found, an error is returned.

Options:
--dirname sets the directory of the npm-shrinkwrap.json
Expand Down

0 comments on commit 8d44197

Please sign in to comment.