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
|
const log = require('npmlog')
const pacote = require('pacote')
const openUrl = require('./utils/open-url.js')
const hostedFromMani = require('./utils/hosted-git-info-from-manifest.js')
const getWorkspaces = require('./workspaces/get-workspaces.js')
const BaseCommand = require('./base-command.js')
class Docs extends BaseCommand {
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get description () {
return 'Open documentation for a package in a web browser'
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get name () {
return 'docs'
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get params () {
return ['browser', 'registry', 'workspace', 'workspaces']
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get usage () {
return ['[<pkgname> [<pkgname> ...]]']
}
exec (args, cb) {
this.docs(args).then(() => cb()).catch(cb)
}
execWorkspaces (args, filters, cb) {
this.docsWorkspaces(args, filters).then(() => cb()).catch(cb)
}
async docs (args) {
if (!args || !args.length)
args = ['.']
await Promise.all(args.map(pkg => this.getDocs(pkg)))
}
async docsWorkspaces (args, filters) {
const workspaces =
await getWorkspaces(filters, { path: this.npm.localPrefix })
return this.docs([...workspaces.values()])
}
async getDocs (pkg) {
const opts = { ...this.npm.flatOptions, fullMetadata: true }
const mani = await pacote.manifest(pkg, opts)
const url = this.getDocsUrl(mani)
log.silly('docs', 'url', url)
await openUrl(this.npm, url, `${mani.name} docs available at the following URL`)
}
getDocsUrl (mani) {
if (mani.homepage)
return mani.homepage
const info = hostedFromMani(mani)
if (info)
return info.docs()
return 'https://www.npmjs.com/package/' + mani.name
}
}
module.exports = Docs
|
