All files / lib dist-tag.js

100% Statements 86/86
100% Branches 42/42
100% Functions 20/20
100% Lines 80/80

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 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    1x 1x 1x 1x   1x 1x 1x 1x 1x   1x             1x 2x 2x 1x   1x   1x       15x   1x 15x 32x   15x 5x   10x 3x   7x 4x   3x     2x   1x       5x 5x 5x   5x   5x 2x   3x   3x 1x   2x 2x 1x 1x   1x   1x 1x                 1x 1x           3x 3x   3x 1x   2x 2x 1x 1x   1x 1x   1x 1x         1x 1x           8x 3x 3x 1x   2x     5x   5x   12x 4x 4x   1x 1x         9x               9x 8x 9x 1x   8x       1x  
'use strict'
 
const log = require('npmlog')
const npa = require('npm-package-arg')
const regFetch = require('npm-registry-fetch')
const semver = require('semver')
 
const npm = require('./npm.js')
const output = require('./utils/output.js')
const otplease = require('./utils/otplease.js')
const readLocalPkgName = require('./utils/read-local-package.js')
const usageUtil = require('./utils/usage.js')
 
const usage = usageUtil(
  'dist-tag',
  'npm dist-tag add <pkg>@<version> [<tag>]' +
  '\nnpm dist-tag rm <pkg> <tag>' +
  '\nnpm dist-tag ls [<pkg>]'
)
 
const completion = function (opts, cb) {
  const argv = opts.conf.argv.remain
  if (argv.length === 2)
    return cb(null, ['add', 'rm', 'ls'])
 
  switch (argv[2]) {
    default:
      return cb()
  }
}
 
const cmd = (args, cb) => distTag(args).then(() => cb()).catch(cb)
 
const distTag = async ([cmdName, pkg, tag]) => {
  const opts = npm.flatOptions
  const has = (items) => new Set(items).has(cmdName)
 
  if (has(['add', 'a', 'set', 's']))
    return add(pkg, tag, opts)
 
  if (has(['rm', 'r', 'del', 'd', 'remove']))
    return remove(pkg, tag, opts)
 
  if (has(['ls', 'l', 'sl', 'list']))
    return list(pkg, opts)
 
  if (!pkg) {
    // when only using the pkg name the default behavior
    // should be listing the existing tags
    return list(cmdName, opts)
  } else
    throw usage
}
 
function add (spec, tag, opts) {
  spec = npa(spec || '')
  const version = spec.rawSpec
  const defaultTag = tag || opts.defaultTag
 
  log.verbose('dist-tag add', defaultTag, 'to', spec.name + '@' + version)
 
  if (!spec.name || !version || !defaultTag)
    throw usage
 
  const t = defaultTag.trim()
 
  if (semver.validRange(t))
    throw new Error('Tag name must not be a valid SemVer range: ' + t)
 
  return fetchTags(spec, opts).then(tags => {
    if (tags[t] === version) {
      log.warn('dist-tag add', t, 'is already set to version', version)
      return
    }
    tags[t] = version
    const url =
      `/-/package/${spec.escapedName}/dist-tags/${encodeURIComponent(t)}`
    const reqOpts = {
      ...opts,
      method: 'PUT',
      body: JSON.stringify(version),
      headers: {
        'content-type': 'application/json',
      },
      spec,
    }
    return otplease(reqOpts, reqOpts => regFetch(url, reqOpts)).then(() => {
      output(`+${t}: ${spec.name}@${version}`)
    })
  })
}
 
function remove (spec, tag, opts) {
  spec = npa(spec || '')
  log.verbose('dist-tag del', tag, 'from', spec.name)
 
  if (!spec.name)
    throw usage
 
  return fetchTags(spec, opts).then(tags => {
    if (!tags[tag]) {
      log.info('dist-tag del', tag, 'is not a dist-tag on', spec.name)
      throw new Error(tag + ' is not a dist-tag on ' + spec.name)
    }
    const version = tags[tag]
    delete tags[tag]
    const url =
      `/-/package/${spec.escapedName}/dist-tags/${encodeURIComponent(tag)}`
    const reqOpts = {
      ...opts,
      method: 'DELETE',
      spec,
    }
    return otplease(reqOpts, reqOpts => regFetch(url, reqOpts)).then(() => {
      output(`-${tag}: ${spec.name}@${version}`)
    })
  })
}
 
function list (spec, opts) {
  if (!spec) {
    return readLocalPkgName().then(pkg => {
      if (!pkg)
        throw usage
 
      return list(pkg, opts)
    })
  }
  spec = npa(spec)
 
  return fetchTags(spec, opts).then(tags => {
    const msg =
      Object.keys(tags).map(k => `${k}: ${tags[k]}`).sort().join('\n')
    output(msg)
    return tags
  }, err => {
    log.error('dist-tag ls', "Couldn't get dist-tag data for", spec)
    throw err
  })
}
 
function fetchTags (spec, opts) {
  return regFetch.json(
    `/-/package/${spec.escapedName}/dist-tags`,
    {
      ...opts,
      'prefer-online': true,
      spec,
    }
  ).then(data => {
    if (data && typeof data === 'object')
      delete data._etag
    if (!data || !Object.keys(data).length)
      throw new Error('No dist-tags found for ' + spec.name)
 
    return data
  })
}
 
module.exports = Object.assign(cmd, { usage, completion })