From 0ee06096d4037eae0ce36703de5d32b8950ea809 Mon Sep 17 00:00:00 2001 From: Nathan James Tindall Date: Sat, 26 Aug 2017 00:51:18 -0700 Subject: [PATCH] fix documentation / oxford comma --- README.md | 7 +++---- bin/cli.js | 3 --- bin/usage.md | 7 +++---- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0c9972c..6e150b3 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/bin/cli.js b/bin/cli.js index ad6bb22..ce63bf0 100755 --- a/bin/cli.js +++ b/bin/cli.js @@ -75,9 +75,6 @@ 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. opts.dry = true; diff --git a/bin/usage.md b/bin/usage.md index 6e54271..acc026a 100644 --- a/bin/usage.md +++ b/bin/usage.md @@ -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