lib/commands/docs.js


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

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 BaseCommand = require('../base-command.js')
class Docs extends BaseCommand {
  static description = 'Open documentation for a package in a web browser'
  static name = 'docs'
  static params = [
    'browser',
    'registry',
    'workspace',
    'workspaces',
    'include-workspace-root',
  ]

  static usage = ['[<pkgname> [<pkgname> ...]]']

  async exec (args) {
    if (!args || !args.length) {
      args = ['.']
    }

    await Promise.all(args.map(pkg => this.getDocs(pkg)))
  }

  async execWorkspaces (args, filters) {
    await this.setWorkspaces(filters)
    return this.exec(this.workspacePaths)
  }

  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