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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
|
// npm view [pkg [pkg ...]]
const color = require('ansicolors')
const columns = require('cli-columns')
const fs = require('fs')
const jsonParse = require('json-parse-even-better-errors')
const log = require('npmlog')
const npa = require('npm-package-arg')
const { resolve } = require('path')
const formatBytes = require('./utils/format-bytes.js')
const relativeDate = require('tiny-relative-date')
const semver = require('semver')
const style = require('ansistyles')
const { inspect, promisify } = require('util')
const { packument } = require('pacote')
const readFile = promisify(fs.readFile)
const readJson = async file => jsonParse(await readFile(file, 'utf8'))
const Queryable = require('./utils/queryable.js')
const BaseCommand = require('./base-command.js')
class View extends BaseCommand {
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get description () {
return 'View registry info'
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get params () {
return [
'json',
'workspace',
'workspaces',
'include-workspace-root',
]
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get name () {
return 'view'
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get usage () {
return ['[<@scope>/]<pkg>[@<version>] [<field>[.subfield]...]']
}
async completion (opts) {
if (opts.conf.argv.remain.length <= 2) {
// There used to be registry completion here, but it stopped
// making sense somewhere around 50,000 packages on the registry
return
}
// have the package, get the fields
const config = {
...this.npm.flatOptions,
fullMetadata: true,
preferOnline: true,
}
const spec = npa(opts.conf.argv.remain[2])
const pckmnt = await packument(spec, config)
const defaultTag = this.npm.config.get('tag')
const dv = pckmnt.versions[pckmnt['dist-tags'][defaultTag]]
pckmnt.versions = Object.keys(pckmnt.versions).sort(semver.compareLoose)
return getFields(pckmnt).concat(getFields(dv))
function getFields (d, f, pref) {
f = f || []
if (!d)
return f
pref = pref || []
Object.keys(d).forEach((k) => {
if (k.charAt(0) === '_' || k.indexOf('.') !== -1)
return
const p = pref.concat(k).join('.')
f.push(p)
if (Array.isArray(d[k])) {
d[k].forEach((val, i) => {
const pi = p + '[' + i + ']'
if (val && typeof val === 'object')
getFields(val, f, [p])
else
f.push(pi)
})
return
}
if (typeof d[k] === 'object')
getFields(d[k], f, [p])
})
return f
}
}
exec (args, cb) {
this.view(args).then(() => cb()).catch(cb)
}
execWorkspaces (args, filters, cb) {
this.viewWorkspaces(args, filters).then(() => cb()).catch(cb)
}
async view (args) {
if (!args.length)
args = ['.']
let pkg = args.shift()
const local = /^\.@/.test(pkg) || pkg === '.'
if (local) {
if (this.npm.config.get('global'))
throw new Error('Cannot use view command in global mode.')
const dir = this.npm.prefix
const manifest = await readJson(resolve(dir, 'package.json'))
if (!manifest.name)
throw new Error('Invalid package.json, no "name" field')
// put the version back if it existed
pkg = `${manifest.name}${pkg.slice(1)}`
}
let wholePackument = false
if (!args.length) {
args = ['']
wholePackument = true
}
const [pckmnt, data] = await this.getData(pkg, args)
if (!this.npm.config.get('json') && wholePackument) {
// pretty view (entire packument)
data.map((v) => this.prettyView(pckmnt, v[Object.keys(v)[0]]['']))
} else {
// JSON formatted output (JSON or specific attributes from packument)
let reducedData = data.reduce(reducer, {})
if (wholePackument) {
// No attributes
reducedData = cleanBlanks(reducedData)
log.silly('view', reducedData)
}
// disable the progress bar entirely, as we can't meaningfully update it
// if we may have partial lines printed.
log.disableProgress()
const msg = await this.jsonData(reducedData, pckmnt._id)
if (msg !== '')
console.log(msg)
}
}
async viewWorkspaces (args, filters) {
if (!args.length)
args = ['.']
const pkg = args.shift()
const local = /^\.@/.test(pkg) || pkg === '.'
if (!local) {
this.npm.log.warn('Ignoring workspaces for specified package(s)')
return this.view([pkg, ...args])
}
let wholePackument = false
if (!args.length) {
wholePackument = true
args = [''] // getData relies on this
}
const results = {}
await this.setWorkspaces(filters)
for (const name of this.workspaceNames) {
const wsPkg = `${name}${pkg.slice(1)}`
const [pckmnt, data] = await this.getData(wsPkg, args)
let reducedData = data.reduce(reducer, {})
if (wholePackument) {
// No attributes
reducedData = cleanBlanks(reducedData)
log.silly('view', reducedData)
}
if (!this.npm.config.get('json')) {
if (wholePackument)
data.map((v) => this.prettyView(pckmnt, v[Object.keys(v)[0]]['']))
else {
console.log(`${name}:`)
const msg = await this.jsonData(reducedData, pckmnt._id)
if (msg !== '')
console.log(msg)
}
} else {
const msg = await this.jsonData(reducedData, pckmnt._id)
if (msg !== '')
results[name] = JSON.parse(msg)
}
}
if (Object.keys(results).length > 0)
console.log(JSON.stringify(results, null, 2))
}
async getData (pkg, args) {
const opts = {
...this.npm.flatOptions,
preferOnline: true,
fullMetadata: true,
}
const spec = npa(pkg)
// get the data about this package
let version = this.npm.config.get('tag')
// rawSpec is the git url if this is from git
if (spec.type !== 'git' && spec.rawSpec)
version = spec.rawSpec
const pckmnt = await packument(spec, opts)
if (pckmnt['dist-tags'] && pckmnt['dist-tags'][version])
version = pckmnt['dist-tags'][version]
if (pckmnt.time && pckmnt.time.unpublished) {
const u = pckmnt.time.unpublished
const er = new Error('Unpublished by ' + u.name + ' on ' + u.time)
er.statusCode = 404
er.code = 'E404'
er.pkgid = pckmnt._id
throw er
}
const data = []
const versions = pckmnt.versions || {}
pckmnt.versions = Object.keys(versions).sort(semver.compareLoose)
// remove readme unless we asked for it
if (args.indexOf('readme') === -1)
delete pckmnt.readme
Object.keys(versions).forEach((v) => {
if (semver.satisfies(v, version, true)) {
args.forEach(arg => {
// remove readme unless we asked for it
if (args.indexOf('readme') !== -1)
delete versions[v].readme
data.push(showFields(pckmnt, versions[v], arg))
})
}
})
if (
!this.npm.config.get('json') &&
args.length === 1 &&
args[0] === ''
)
pckmnt.version = version
return [pckmnt, data]
}
async jsonData (data, name) {
const versions = Object.keys(data)
let msg = ''
let msgJson = []
const includeVersions = versions.length > 1
let includeFields
const json = this.npm.config.get('json')
versions.forEach((v) => {
const fields = Object.keys(data[v])
includeFields = includeFields || (fields.length > 1)
if (json)
msgJson.push({})
fields.forEach((f) => {
let d = cleanup(data[v][f])
if (fields.length === 1 && json)
msgJson[msgJson.length - 1][f] = d
if (includeVersions || includeFields || typeof d !== 'string') {
if (json)
msgJson[msgJson.length - 1][f] = d
else {
d = inspect(d, {
showHidden: false,
depth: 5,
colors: this.npm.color,
maxArrayLength: null,
})
}
} else if (typeof d === 'string' && json)
d = JSON.stringify(d)
if (!json) {
if (f && includeFields)
f += ' = '
msg += (includeVersions ? name + '@' + v + ' ' : '') +
(includeFields ? f : '') + d + '\n'
}
})
})
if (json) {
if (msgJson.length && Object.keys(msgJson[0]).length === 1) {
const k = Object.keys(msgJson[0])[0]
msgJson = msgJson.map(m => m[k])
}
if (msgJson.length === 1)
msg = JSON.stringify(msgJson[0], null, 2) + '\n'
else if (msgJson.length > 1)
msg = JSON.stringify(msgJson, null, 2) + '\n'
}
return msg.trim()
}
prettyView (packument, manifest) {
// More modern, pretty printing of default view
const unicode = this.npm.config.get('unicode')
const tags = []
Object.keys(packument['dist-tags']).forEach((t) => {
const version = packument['dist-tags'][t]
tags.push(`${style.bright(color.green(t))}: ${version}`)
})
const unpackedSize = manifest.dist.unpackedSize &&
formatBytes(manifest.dist.unpackedSize, true)
const licenseField = manifest.license || 'Proprietary'
const info = {
name: color.green(manifest.name),
version: color.green(manifest.version),
bins: Object.keys(manifest.bin || {}).map(color.yellow),
versions: color.yellow(packument.versions.length + ''),
description: manifest.description,
deprecated: manifest.deprecated,
keywords: (packument.keywords || []).map(color.yellow),
license: typeof licenseField === 'string'
? licenseField
: (licenseField.type || 'Proprietary'),
deps: Object.keys(manifest.dependencies || {}).map((dep) => {
return `${color.yellow(dep)}: ${manifest.dependencies[dep]}`
}),
publisher: manifest._npmUser && unparsePerson({
name: color.yellow(manifest._npmUser.name),
email: color.cyan(manifest._npmUser.email),
}),
modified: !packument.time ? undefined
: color.yellow(relativeDate(packument.time[manifest.version])),
maintainers: (packument.maintainers || []).map((u) => unparsePerson({
name: color.yellow(u.name),
email: color.cyan(u.email),
})),
repo: (
manifest.bugs && (manifest.bugs.url || manifest.bugs)
) || (
manifest.repository && (manifest.repository.url || manifest.repository)
),
site: (
manifest.homepage && (manifest.homepage.url || manifest.homepage)
),
tags,
tarball: color.cyan(manifest.dist.tarball),
shasum: color.yellow(manifest.dist.shasum),
integrity:
manifest.dist.integrity && color.yellow(manifest.dist.integrity),
fileCount:
manifest.dist.fileCount && color.yellow(manifest.dist.fileCount),
unpackedSize: unpackedSize && color.yellow(unpackedSize),
}
if (info.license.toLowerCase().trim() === 'proprietary')
info.license = style.bright(color.red(info.license))
else
info.license = color.green(info.license)
console.log('')
console.log(
style.underline(style.bright(`${info.name}@${info.version}`)) +
' | ' + info.license +
' | deps: ' + (info.deps.length ? color.cyan(info.deps.length) : color.green('none')) +
' | versions: ' + info.versions
)
info.description && console.log(info.description)
if (info.repo || info.site)
info.site && console.log(color.cyan(info.site))
const warningSign = unicode ? ' ⚠️ ' : '!!'
info.deprecated && console.log(
`\n${style.bright(color.red('DEPRECATED'))}${
warningSign
} - ${info.deprecated}`
)
if (info.keywords.length) {
console.log('')
console.log('keywords:', info.keywords.join(', '))
}
if (info.bins.length) {
console.log('')
console.log('bin:', info.bins.join(', '))
}
console.log('')
console.log('dist')
console.log('.tarball:', info.tarball)
console.log('.shasum:', info.shasum)
info.integrity && console.log('.integrity:', info.integrity)
info.unpackedSize && console.log('.unpackedSize:', info.unpackedSize)
const maxDeps = 24
if (info.deps.length) {
console.log('')
console.log('dependencies:')
console.log(columns(info.deps.slice(0, maxDeps), { padding: 1 }))
if (info.deps.length > maxDeps)
console.log(`(...and ${info.deps.length - maxDeps} more.)`)
}
if (info.maintainers && info.maintainers.length) {
console.log('')
console.log('maintainers:')
info.maintainers.forEach((u) => console.log('-', u))
}
console.log('')
console.log('dist-tags:')
console.log(columns(info.tags))
if (info.publisher || info.modified) {
let publishInfo = 'published'
if (info.modified)
publishInfo += ` ${info.modified}`
if (info.publisher)
publishInfo += ` by ${info.publisher}`
console.log('')
console.log(publishInfo)
}
}
}
module.exports = View
function cleanBlanks (obj) {
const clean = {}
Object.keys(obj).forEach((version) => {
clean[version] = obj[version]['']
})
return clean
}
// takes an array of objects and merges them into one object
function reducer (acc, cur) {
if (cur) {
Object.keys(cur).forEach((v) => {
acc[v] = acc[v] || {}
Object.keys(cur[v]).forEach((t) => {
acc[v][t] = cur[v][t]
})
})
}
return acc
}
// return whatever was printed
function showFields (data, version, fields) {
const o = {}
;[data, version].forEach((s) => {
Object.keys(s).forEach((k) => {
o[k] = s[k]
})
})
const queryable = new Queryable(o)
const s = queryable.query(fields)
const res = { [version.version]: s }
if (s)
return res
}
function cleanup (data) {
if (Array.isArray(data))
return data.map(cleanup)
if (!data || typeof data !== 'object')
return data
const keys = Object.keys(data)
if (keys.length <= 3 &&
data.name &&
(keys.length === 1 ||
(keys.length === 3 && data.email && data.url) ||
(keys.length === 2 && (data.email || data.url))))
data = unparsePerson(data)
return data
}
function unparsePerson (d) {
return d.name +
(d.email ? ' <' + d.email + '>' : '') +
(d.url ? ' (' + d.url + ')' : '')
}
|