summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-outdated.1
blob: aa22c22bad114d6d69a963f9963921f9be4247d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
.TH "NPM\-OUTDATED" "1" "October 2020" "" ""
.SH "NAME"
\fBnpm-outdated\fR \- Check for outdated packages
.SS Synopsis
.P
.RS 2
.nf
npm outdated [[<@scope>/]<pkg> \.\.\.]
.fi
.RE
.SS Description
.P
This command will check the registry to see if any (or, specific) installed
packages are currently outdated\.
.P
In the output:
.RS 0
.IP \(bu 2
\fBwanted\fP is the maximum version of the package that satisfies the semver
range specified in \fBpackage\.json\fP\|\. If there's no available semver range (i\.e\.
you're running \fBnpm outdated \-\-global\fP, or the package isn't included in
\fBpackage\.json\fP), then \fBwanted\fP shows the currently\-installed version\.
.IP \(bu 2
\fBlatest\fP is the version of the package tagged as latest in the registry\.
Running \fBnpm publish\fP with no special configuration will publish the package
with a dist\-tag of \fBlatest\fP\|\. 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 \fInpm\-dist\-tag\fR\|\.
.IP \(bu 2
\fBlocation\fP is where in the physical tree the package is located\.
.IP \(bu 2
\fBdepended by\fP shows which package depends on the displayed dependency
.IP \(bu 2
\fBpackage type\fP (when using \fB\-\-long\fP / \fB\-l\fP) tells you whether this package is
a \fBdependency\fP or a dev/peer/optional dependency\. Packages not included in \fBpackage\.json\fP
are always marked \fBdependencies\fP\|\.
.IP \(bu 2
\fBhomepage\fP (when using \fB\-\-long\fP / \fB\-l\fP) is the \fBhomepage\fP value contained in the package's packument
.IP \(bu 2
Red means there's a newer version matching your semver requirements, so you should update now\.
.IP \(bu 2
Yellow indicates that there's a newer version above your semver requirements (usually new major, or new 0\.x minor) so proceed with caution\.

.RE
.SS An example
.P
.RS 2
.nf
$ npm outdated
Package      Current   Wanted   Latest  Location                  Depended by
glob          5\.0\.15   5\.0\.15    6\.0\.1  node_modules/glob         dependent\-package\-name
nothingness    0\.0\.3      git      git  node_modules/nothingness  dependent\-package\-name
npm            3\.5\.1    3\.5\.2    3\.5\.1  node_modules/npm          dependent\-package\-name
local\-dev      0\.0\.3   linked   linked  local\-dev                 dependent\-package\-name
once           1\.3\.2    1\.3\.3    1\.3\.3  node_modules/once         dependent\-package\-name
.fi
.RE
.P
With these \fBdependencies\fP:
.P
.RS 2
.nf
{
  "glob": "^5\.0\.15",
  "nothingness": "github:othiym23/nothingness#master",
  "npm": "^3\.5\.1",
  "once": "^1\.3\.1"
}
.fi
.RE
.P
A few things to note:
.RS 0
.IP \(bu 2
\fBglob\fP requires \fB^5\fP, which prevents npm from installing \fBglob@6\fP, which is
outside the semver range\.
.IP \(bu 2
Git dependencies will always be reinstalled, because of how they're specified\.
The installed committish might satisfy the dependency specifier (if it's
something immutable, like a commit SHA), or it might not, so \fBnpm outdated\fP and
\fBnpm update\fP have to fetch Git repos to check\. This is why currently doing a
reinstall of a Git dependency always forces a new clone and install\.
.IP \(bu 2
\fBnpm@3\.5\.2\fP is marked as "wanted", but "latest" is \fBnpm@3\.5\.1\fP because npm
uses dist\-tags to manage its \fBlatest\fP and \fBnext\fP release channels\. \fBnpm update\fP
will install the \fInewest\fR version, but \fBnpm install npm\fP (with no semver range)
will install whatever's tagged as \fBlatest\fP\|\.
.IP \(bu 2
\fBonce\fP is just plain out of date\. Reinstalling \fBnode_modules\fP from scratch or
running \fBnpm update\fP will bring it up to spec\.

.RE
.SS Configuration
.SS json
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean

.RE
.P
Show information in JSON format\.
.SS long
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean

.RE
.P
Show extended information\.
.SS parseable
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean

.RE
.P
Show parseable output instead of tree view\.
.SS global
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean

.RE
.P
Check packages in the global install prefix instead of in the current
project\.
.SS all
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean

.RE
.P
Display all outdated dependencies on the tree\.
.SS See Also
.RS 0
.IP \(bu 2
npm help update
.IP \(bu 2
npm help dist\-tag
.IP \(bu 2
npm help registry
.IP \(bu 2
npm help folders

.RE