Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 6595b27

Browse files
committed
Remove "only usable with --unused" from docs
1 parent 8602942 commit 6595b27

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

cli.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ if (args.help || args._.length === 0) {
2828
console.log('\nOptions:')
2929
console.log('--missing (default) Check to make sure that all modules in your code are listed in your package.json')
3030
console.log('--unused, --extra The inverse of the --missing check and will tell you which modules in your package.json *were not* used in your code')
31-
console.log("--no-dev Won't tell you about which devDependencies in your package.json dependencies that were not used in your code. Only usable with --unused")
32-
console.log("--ignore-module, -i Won't tell you about module names passed in as --ignore-module / -i. Only usable with --unused")
31+
console.log("--no-dev Won't tell you about devDependencies that are missing or unused")
32+
console.log("--ignore-module, -i Won't tell you about these module names when missing or unused")
3333
console.log('--entry By default your main and bin entries from package.json will be parsed, but you can add more the list of entries by passing them in as --entry')
3434
console.log("--no-default-entries Won't parse your main and bin entries from package.json will be parsed")
3535
console.log('--detective Requireable path containing an alternative implementation of the detective module that supports alternate syntaxes')

readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ checks which modules you have used in your code and then makes sure they are lis
1616

1717
the goal of this module is to simply check that all non-relative modules that get `require()`'d are in package.json, which prevents people from getting 'module not found' errors when they install your module that has missing deps which was accidentally published to NPM (happened to me all the time, hence the impetus to write this module).
1818

19-
## CLI usage
19+
## cli usage
2020

2121
```
2222
$ npm install dependency-check -g
@@ -44,11 +44,11 @@ running `dependency-check ./package.json --unused` will do the inverse of the de
4444

4545
### --no-dev
4646

47-
running `dependency-check ./package.json --unused --no-dev` will not tell you if any devDependencies in your package.json were not used in your code. Only usable with `--unused`
47+
running `dependency-check ./package.json --unused --no-dev` will not tell you if any devDependencies in your package.json were missing or unused
4848

4949
### --ignore-module, -i
5050

51-
running `dependency-check ./package.json --unused --ignore-module foo` will not tell you if the `foo` module was not used in your code. You can specify as many separate `--ignore-module` arguments as you want. Only usable with `--unused`
51+
running `dependency-check ./package.json --unused --ignore-module foo` will not tell you if the `foo` module was not used in your code. You can specify as many separate `--ignore-module` arguments as you want
5252

5353
### --entry
5454

0 commit comments

Comments
 (0)