All files / lib docs.js

100% Statements 31/31
100% Branches 8/8
100% Functions 6/6
100% Lines 28/28

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 431x 1x 1x 1x 1x 1x 1x   1x 1x   6x   1x 6x 1x   6x     1x 6x 3x     3x 3x 2x     1x     1x 6x 6x 6x 6x 6x     1x  
const log = require('npmlog')
const pacote = require('pacote')
const { promisify } = require('util')
const openUrl = promisify(require('./utils/open-url.js'))
const usageUtil = require('./utils/usage.js')
const npm = require('./npm.js')
const hostedFromMani = require('./utils/hosted-git-info-from-manifest.js')
 
const usage = usageUtil('docs', 'npm docs [<pkgname> [<pkgname> ...]]')
const completion = require('./utils/completion/none.js')
 
const cmd = (args, cb) => docs(args).then(() => cb()).catch(cb)
 
const docs = async args => {
  if (!args || !args.length) {
    args = ['.']
  }
  await Promise.all(args.map(pkg => getDocs(pkg)))
}
 
const 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
}
 
const getDocs = async pkg => {
  const opts = { ...npm.flatOptions, fullMetadata: true }
  const mani = await pacote.manifest(pkg, opts)
  const url = getDocsUrl(mani)
  log.silly('docs', 'url', url)
  await openUrl(url, `${mani.name} docs available at the following URL`)
}
 
module.exports = Object.assign(cmd, { usage, completion })