summaryrefslogtreecommitdiff
path: root/deps/npm/lib/deprecate.js
blob: 42d099b544e31d81a1fba04b8be2ec1f89f0e3f5 (plain)
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
const npm = require('./npm.js')
const fetch = require('npm-registry-fetch')
const otplease = require('./utils/otplease.js')
const npa = require('npm-package-arg')
const semver = require('semver')
const getIdentity = require('./utils/get-identity.js')
const libaccess = require('libnpmaccess')
const usageUtil = require('./utils/usage.js')

const UsageError = () =>
  Object.assign(new Error(`\nUsage: ${usage}`), {
    code: 'EUSAGE',
  })

const usage = usageUtil(
  'deprecate',
  'npm deprecate <pkg>[@<version>] <message>'
)

const completion = async (opts) => {
  if (opts.conf.argv.remain.length > 1)
    return []

  const username = await getIdentity(npm.flatOptions)
  const packages = await libaccess.lsPackages(username, npm.flatOptions)
  return Object.keys(packages)
    .filter((name) =>
      packages[name] === 'write' &&
      (opts.conf.argv.remain.length === 0 ||
        name.startsWith(opts.conf.argv.remain[0])))
}

const cmd = (args, cb) =>
  deprecate(args)
    .then(() => cb())
    .catch(err => cb(err.code === 'EUSAGE' ? err.message : err))

const deprecate = async ([pkg, msg]) => {
  if (!pkg || !msg)
    throw UsageError()

  // fetch the data and make sure it exists.
  const p = npa(pkg)
  // npa makes the default spec "latest", but for deprecation
  // "*" is the appropriate default.
  const spec = p.rawSpec === '' ? '*' : p.fetchSpec

  if (semver.validRange(spec, true) === null)
    throw new Error(`invalid version range: ${spec}`)

  const uri = '/' + p.escapedName
  const packument = await fetch.json(uri, {
    ...npm.flatOptions,
    spec: p,
    query: { write: true },
  })

  Object.keys(packument.versions)
    .filter(v => semver.satisfies(v, spec, { includePrerelease: true }))
    .forEach(v => {
      packument.versions[v].deprecated = msg
    })

  return otplease(npm.flatOptions, opts => fetch(uri, {
    ...opts,
    spec: p,
    method: 'PUT',
    body: packument,
    ignoreBody: true,
  }))
}

module.exports = Object.assign(cmd, { completion, usage })