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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
// show the installed versions of packages
//
// --parseable creates output like this:
// <fullpath>:<name@ver>:<realpath>:<flags>
// Flags are a :-separated list of zero or more indicators
module.exports = exports = ls
var path = require('path')
var url = require('url')
var readPackageTree = require('read-package-tree')
var log = require('npmlog')
var archy = require('archy')
var semver = require('semver')
var color = require('ansicolors')
var npa = require('npm-package-arg')
var iferr = require('iferr')
var npm = require('./npm.js')
var mutateIntoLogicalTree = require('./install/mutate-into-logical-tree.js')
var recalculateMetadata = require('./install/deps.js').recalculateMetadata
var packageId = require('./utils/package-id.js')
ls.usage = 'npm ls [[<@scope>/]<pkg> ...]' +
'\n\naliases: list, la, ll'
ls.completion = require('./utils/completion/installed-deep.js')
function ls (args, silent, cb) {
if (typeof cb !== 'function') {
cb = silent
silent = false
}
var dir = path.resolve(npm.dir, '..')
readPackageTree(dir, andRecalculateMetadata(iferr(cb, function (physicalTree) {
lsFromTree(dir, physicalTree, args, silent, cb)
})))
}
function andRecalculateMetadata (next) {
return function (er, tree) {
recalculateMetadata(tree || {}, log, next)
}
}
var lsFromTree = ls.fromTree = function (dir, physicalTree, args, silent, cb) {
if (typeof cb !== 'function') {
cb = silent
silent = false
}
// npm ls 'foo@~1.3' bar 'baz@<2'
if (!args) {
args = []
} else {
args = args.map(function (a) {
var p = npa(a)
var name = p.name
var ver = semver.validRange(p.rawSpec) || ''
return [ name, ver ]
})
}
var data = mutateIntoLogicalTree.asReadInstalled(physicalTree)
pruneNestedExtraneous(data)
filterByEnv(data)
var bfs = filterFound(bfsify(data), args)
var lite = getLite(bfs)
if (silent) return cb(null, data, lite)
var long = npm.config.get('long')
var json = npm.config.get('json')
var out
if (json) {
var seen = []
var d = long ? bfs : lite
// the raw data can be circular
out = JSON.stringify(d, function (k, o) {
if (typeof o === 'object') {
if (seen.indexOf(o) !== -1) return '[Circular]'
seen.push(o)
}
return o
}, 2)
} else if (npm.config.get('parseable')) {
out = makeParseable(bfs, long, dir)
} else if (data) {
out = makeArchy(bfs, long, dir)
}
console.log(out)
if (args.length && !data._found) process.exitCode = 1
var er
// if any errors were found, then complain and exit status 1
if (lite.problems && lite.problems.length) {
er = lite.problems.join('\n')
}
cb(er, data, lite)
}
function pruneNestedExtraneous (data, visited) {
visited = visited || []
visited.push(data)
for (var i in data.dependencies) {
if (data.dependencies[i].extraneous) {
data.dependencies[i].dependencies = {}
} else if (visited.indexOf(data.dependencies[i]) === -1) {
pruneNestedExtraneous(data.dependencies[i], visited)
}
}
}
function filterByEnv (data) {
var dev = npm.config.get('dev') || /^dev(elopment)?$/.test(npm.config.get('only'))
var production = npm.config.get('production') || /^prod(uction)?$/.test(npm.config.get('only'))
var dependencies = {}
var devDependencies = data.devDependencies || []
Object.keys(data.dependencies).forEach(function (name) {
var keys = Object.keys(devDependencies)
if (production && !dev && keys.indexOf(name) !== -1) return
if (dev && !production && keys.indexOf(name) === -1) return
if (!dev && keys.indexOf(name) !== -1 && data.dependencies[name].missing) return
dependencies[name] = data.dependencies[name]
})
data.dependencies = dependencies
}
function alphasort (a, b) {
a = a.toLowerCase()
b = b.toLowerCase()
return a > b ? 1
: a < b ? -1 : 0
}
function isCruft (data) {
return data.extraneous && data.error && data.error.code === 'ENOTDIR'
}
function getLite (data, noname) {
var lite = {}
if (isCruft(data)) return lite
var maxDepth = npm.config.get('depth')
if (!noname && data.name) lite.name = data.name
if (data.version) lite.version = data.version
if (data.extraneous) {
lite.extraneous = true
lite.problems = lite.problems || []
lite.problems.push('extraneous: ' + packageId(data) + ' ' + (data.path || ''))
}
if (data.error && data.path !== path.resolve(npm.globalDir, '..') &&
(data.error.code !== 'ENOENT' || noname)) {
lite.invalid = true
lite.problems = lite.problems || []
var message = data.error.message
lite.problems.push('error in ' + data.path + ': ' + message)
}
if (data._from) {
lite.from = data._from
}
if (data._resolved) {
lite.resolved = data._resolved
}
if (data.invalid) {
lite.invalid = true
lite.problems = lite.problems || []
lite.problems.push('invalid: ' +
packageId(data) +
' ' + (data.path || ''))
}
if (data.peerInvalid) {
lite.peerInvalid = true
lite.problems = lite.problems || []
lite.problems.push('peer dep not met: ' +
packageId(data) +
' ' + (data.path || ''))
}
var deps = (data.dependencies && Object.keys(data.dependencies)) || []
if (deps.length) {
lite.dependencies = deps.map(function (d) {
var dep = data.dependencies[d]
if (dep.missing && !dep.optional) {
lite.problems = lite.problems || []
var p
if (data.depth > maxDepth) {
p = 'max depth reached: '
} else {
p = 'missing: '
}
p += d + '@' + dep.requiredBy +
', required by ' +
packageId(data)
lite.problems.push(p)
return [d, { required: dep.requiredBy, missing: true }]
} else if (dep.peerMissing) {
lite.problems = lite.problems || []
dep.peerMissing.forEach(function (missing) {
var pdm = 'peer dep missing: ' +
missing.requires +
', required by ' +
missing.requiredBy
lite.problems.push(pdm)
})
return [d, { required: dep, peerMissing: true }]
}
return [d, getLite(dep, true)]
}).reduce(function (deps, d) {
if (d[1].problems) {
lite.problems = lite.problems || []
lite.problems.push.apply(lite.problems, d[1].problems)
}
deps[d[0]] = d[1]
return deps
}, {})
}
return lite
}
function bfsify (root) {
// walk over the data, and turn it from this:
// +-- a
// | `-- b
// | `-- a (truncated)
// `--b (truncated)
// into this:
// +-- a
// `-- b
// which looks nicer
var queue = [root]
var seen = [root]
while (queue.length) {
var current = queue.shift()
var deps = current.dependencies = current.dependencies || {}
Object.keys(deps).forEach(function (d) {
var dep = deps[d]
if (dep.missing) return
if (seen.indexOf(dep) !== -1) {
if (npm.config.get('parseable') || !npm.config.get('long')) {
delete deps[d]
return
} else {
dep = deps[d] = Object.create(dep)
dep.dependencies = {}
}
}
queue.push(dep)
seen.push(dep)
})
}
return root
}
function filterFound (root, args) {
if (!args.length) return root
var deps = root.dependencies
if (deps) {
Object.keys(deps).forEach(function (d) {
var dep = filterFound(deps[d], args)
if (dep.peerMissing) return
// see if this one itself matches
var found = false
for (var i = 0; !found && i < args.length; i++) {
if (d === args[i][0]) {
found = semver.satisfies(dep.version, args[i][1], true)
}
}
// included explicitly
if (found) dep._found = true
// included because a child was included
if (dep._found && !root._found) root._found = 1
// not included
if (!dep._found) delete deps[d]
})
}
if (!root._found) root._found = false
return root
}
function makeArchy (data, long, dir) {
var out = makeArchy_(data, long, dir, 0)
return archy(out, '', { unicode: npm.config.get('unicode') })
}
function makeArchy_ (data, long, dir, depth, parent, d) {
if (data.missing) {
if (depth - 1 <= npm.config.get('depth')) {
// just missing
var unmet = 'UNMET ' + (data.optional ? 'OPTIONAL ' : '') + 'DEPENDENCY'
if (npm.color) {
if (data.optional) {
unmet = color.bgBlack(color.yellow(unmet))
} else {
unmet = color.bgBlack(color.red(unmet))
}
}
data = unmet + ' ' + d + '@' + data.requiredBy
} else {
data = d + '@' + data.requiredBy
}
return data
}
var out = {}
// the top level is a bit special.
out.label = data._id || ''
if (data._found === true && data._id) {
if (npm.color) {
out.label = color.bgBlack(color.yellow(out.label.trim())) + ' '
} else {
out.label = out.label.trim() + ' '
}
}
if (data.link) out.label += ' -> ' + data.link
if (data.invalid) {
if (data.realName !== data.name) out.label += ' (' + data.realName + ')'
var invalid = 'invalid'
if (npm.color) invalid = color.bgBlack(color.red(invalid))
out.label += ' ' + invalid
}
if (data.peerInvalid) {
var peerInvalid = 'peer invalid'
if (npm.color) peerInvalid = color.bgBlack(color.red(peerInvalid))
out.label += ' ' + peerInvalid
}
if (data.peerMissing) {
var peerMissing = 'UNMET PEER DEPENDENCY'
if (npm.color) peerMissing = color.bgBlack(color.red(peerMissing))
out.label = peerMissing + ' ' + out.label
}
if (data.extraneous && data.path !== dir) {
var extraneous = 'extraneous'
if (npm.color) extraneous = color.bgBlack(color.green(extraneous))
out.label += ' ' + extraneous
}
if (data.error && depth) {
var message = data.error.message
if (message.indexOf('\n')) message = message.slice(0, message.indexOf('\n'))
var error = 'error: ' + message
if (npm.color) error = color.bgRed(color.brightWhite(error))
out.label += ' ' + error
}
// add giturl to name@version
if (data._resolved) {
try {
var type = npa(data._resolved).type
var isGit = type === 'git' || type === 'hosted'
if (isGit) {
out.label += ' (' + data._resolved + ')'
}
} catch (ex) {
// npa threw an exception then it ain't git so whatev
}
}
if (long) {
if (dir === data.path) out.label += '\n' + dir
out.label += '\n' + getExtras(data, dir)
} else if (dir === data.path) {
if (out.label) out.label += ' '
out.label += dir
}
// now all the children.
out.nodes = []
if (depth <= npm.config.get('depth')) {
out.nodes = Object.keys(data.dependencies || {})
.sort(alphasort).filter(function (d) {
return !isCruft(data.dependencies[d])
}).map(function (d) {
return makeArchy_(data.dependencies[d], long, dir, depth + 1, data, d)
})
}
if (out.nodes.length === 0 && data.path === dir) {
out.nodes = ['(empty)']
}
return out
}
function getExtras (data) {
var extras = []
if (data.description) extras.push(data.description)
if (data.repository) extras.push(data.repository.url)
if (data.homepage) extras.push(data.homepage)
if (data._from) {
var from = data._from
if (from.indexOf(data.name + '@') === 0) {
from = from.substr(data.name.length + 1)
}
var u = url.parse(from)
if (u.protocol) extras.push(from)
}
return extras.join('\n')
}
function makeParseable (data, long, dir, depth, parent, d) {
depth = depth || 0
return [ makeParseable_(data, long, dir, depth, parent, d) ]
.concat(Object.keys(data.dependencies || {})
.sort(alphasort).map(function (d) {
return makeParseable(data.dependencies[d], long, dir, depth + 1, data, d)
}))
.filter(function (x) { return x })
.join('\n')
}
function makeParseable_ (data, long, dir, depth, parent, d) {
if (data.hasOwnProperty('_found') && data._found !== true) return ''
if (data.missing) {
if (depth < npm.config.get('depth')) {
data = npm.config.get('long')
? path.resolve(parent.path, 'node_modules', d) +
':' + d + '@' + JSON.stringify(data.requiredBy) + ':INVALID:MISSING'
: ''
} else {
data = path.resolve(dir || '', 'node_modules', d || '') +
(npm.config.get('long')
? ':' + d + '@' + JSON.stringify(data.requiredBy) +
':' + // no realpath resolved
':MAXDEPTH'
: '')
}
return data
}
if (!npm.config.get('long')) return data.path
return data.path +
':' + (data._id || '') +
':' + (data.realPath !== data.path ? data.realPath : '') +
(data.extraneous ? ':EXTRANEOUS' : '') +
(data.error && data.path !== path.resolve(npm.globalDir, '..') ? ':ERROR' : '') +
(data.invalid ? ':INVALID' : '') +
(data.peerInvalid ? ':PEERINVALID' : '') +
(data.peerMissing ? ':PEERINVALID:MISSING' : '')
}
|