Skip to content

Commit

Permalink
feat: update npm outdated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiahdz committed May 1, 2020
1 parent b641d44 commit d12038a
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions docs/content/cli-commands/npm-outdated.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,11 @@ In the output:
with a dist-tag of `latest`. This may or may not be the maximum version of
the package, or the most-recently published version of the package, depending
on how the package's developer manages the latest [dist-tag](npm-dist-tag).
* `location` is where in the dependency tree the package is located. Note that
`npm outdated` defaults to a depth of 0, so unless you override that, you'll
always be seeing only top-level dependencies that are outdated.
* `location` is where in the physical tree the package is located.
* `package type` (when using `--long` / `-l`) tells you whether this package is
a `dependency` or a `devDependency`. Packages not included in `package.json`
a `dependency` or a dev/peer/optional dependency. Packages not included in `package.json`
are always marked `dependencies`.
* `homepage` (when using `--long` / `-l`) is the `homepage` value contained in the package's `package.json`
* `homepage` (when using `--long` / `-l`) is the `homepage` value contained in the package's packument
* Red means there's a newer version matching your semver requirements, so you should update now.
* Yellow indicates that there's a newer version above your semver requirements (usually new major, or new 0.x minor) so proceed with caution.

Expand All @@ -45,11 +43,11 @@ In the output:
```bash
$ npm outdated
Package Current Wanted Latest Location
glob 5.0.15 5.0.15 6.0.1 test-outdated-output
nothingness 0.0.3 git git test-outdated-output
npm 3.5.1 3.5.2 3.5.1 test-outdated-output
local-dev 0.0.3 linked linked test-outdated-output
once 1.3.2 1.3.3 1.3.3 test-outdated-output
glob 5.0.15 5.0.15 6.0.1 node_modules/glob
nothingness 0.0.3 git git node_modules/nothingness
npm 3.5.1 3.5.2 3.5.1 node_modules/npm
local-dev 0.0.3 linked linked local-dev
once 1.3.2 1.3.3 1.3.3 node_modules/once
```

With these `dependencies`:
Expand Down Expand Up @@ -109,12 +107,12 @@ Show parseable output instead of tree view.
Check packages in the global install prefix instead of in the current
project.

#### depth
#### all

* Default: 0
* Type: Int
* Default: false
* Type: Boolean

Max depth for checking dependency tree.
Display all outdated dependencies on the tree.

### See Also

Expand Down

0 comments on commit d12038a

Please sign in to comment.