All files outdated.js

100% Statements 122/122
98.59% Branches 70/71
100% Functions 18/18
100% Lines 118/118

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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 29017x 17x 17x 17x 17x 17x 17x 17x   17x   17x 17x 17x 17x   17x     17x     17x 16x         17x 17x 17x       17x         17x 17x     46x     16x 4x     12x 2x 10x 2x   24x 8x               8x 1x 8x   8x 24x   8x   404x   8x         17x   17x   18x 1x 1x     18x 22x 1x 1x   21x 61x       18x 16x 2x 7x             53x       44x       58x 58x 58x 58x   58x         58x 19x 4x         54x 1x   53x 53x 44x   44x 44x 1x   1x   42x 42x   42x         40x                             9x         1x       17x 17x   1x 1x 1x     16x   1x 1x     16x     17x 58x   17x 16x                           24x   24x   24x 4x 4x     24x 14x 14x 14x     24x           2x                   8x 8x             8x 4x   8x         2x 2x                   8x 8x             8x 4x 4x     2x     17x  
const os = require('os')
const path = require('path')
const pacote = require('pacote')
const table = require('text-table')
const color = require('ansicolors')
const styles = require('ansistyles')
const npa = require('npm-package-arg')
const pickManifest = require('npm-pick-manifest')
 
const Arborist = require('@npmcli/arborist')
 
const npm = require('./npm.js')
const output = require('./utils/output.js')
const usageUtil = require('./utils/usage.js')
const ansiTrim = require('./utils/ansi-trim.js')
 
const usage = usageUtil('outdated',
  'npm outdated [[<@scope>/]<pkg> ...]'
)
const completion = require('./utils/completion/none.js')
 
function cmd (args, cb) {
  outdated(args)
    .then(() => cb())
    .catch(cb)
}
 
async function outdated (args) {
  const opts = npm.flatOptions
  const global = path.resolve(npm.globalDir, '..')
  const where = opts.global
    ? global
    : npm.prefix
 
  const arb = new Arborist({
    ...opts,
    path: where,
  })
 
  const tree = await arb.loadActual()
  const list = await outdated_(tree, args, opts)
 
  // sorts list alphabetically
  const outdated = list.sort((a, b) => a.name.localeCompare(b.name))
 
  // return if no outdated packages
  if (outdated.length === 0 && !opts.json)
    return
 
  // display results
  if (opts.json)
    output(makeJSON(outdated, opts))
  else if (opts.parseable)
    output(makeParseable(outdated, opts))
  else {
    const outList = outdated.map(x => makePretty(x, opts))
    const outHead = ['Package',
      'Current',
      'Wanted',
      'Latest',
      'Location',
      'Depended by',
    ]
 
    if (opts.long)
      outHead.push('Package Type', 'Homepage')
    const outTable = [outHead].concat(outList)
 
    if (opts.color)
      outTable[0] = outTable[0].map(heading => styles.underline(heading))
 
    const tableOpts = {
      align: ['l', 'r', 'r', 'r', 'l'],
      stringLength: s => ansiTrim(s).length,
    }
    output(table(outTable, tableOpts))
  }
}
 
async function outdated_ (tree, deps, opts) {
  const list = []
 
  const edges = new Set()
  function getEdges (nodes, type) {
    const getEdgesIn = (node) => {
      for (const edge of node.edgesIn)
        edges.add(edge)
    }
 
    const getEdgesOut = (node) => {
      if (opts.global) {
        for (const child of node.children.values())
          edges.add(child)
      } else {
        for (const edge of node.edgesOut.values())
          edges.add(edge)
      }
    }
 
    if (!nodes)
      return getEdgesOut(tree)
    for (const node of nodes) {
      type === 'edgesOut'
        ? getEdgesOut(node)
        : getEdgesIn(node)
    }
  }
 
  async function getPackument (spec) {
    const packument = await pacote.packument(spec, {
      fullMetadata: npm.flatOptions.long,
      preferOnline: true,
    })
    return packument
  }
 
  async function getOutdatedInfo (edge) {
    const spec = npa(edge.name)
    const node = edge.to || edge
    const { path, location } = node
    const { version: current } = node.package || {}
 
    const type = edge.optional ? 'optionalDependencies'
      : edge.peer ? 'peerDependencies'
      : edge.dev ? 'devDependencies'
      : 'dependencies'
 
    for (const omitType of opts.omit || []) {
      if (node[omitType])
        return
    }
 
    // deps different from prod not currently
    // on disk are not included in the output
    if (edge.error === 'MISSING' && type !== 'dependencies')
      return
 
    try {
      const packument = await getPackument(spec)
      const expected = edge.spec
      // if it's not a range, version, or tag, skip it
      try {
        if (!npa(`${edge.name}@${edge.spec}`).registry)
          return null
      } catch (err) {
        return null
      }
      const wanted = pickManifest(packument, expected, npm.flatOptions)
      const latest = pickManifest(packument, '*', npm.flatOptions)
 
      if (
        !current ||
        current !== wanted.version ||
        wanted.version !== latest.version
      ) {
        list.push({
          name: edge.name,
          path,
          type,
          current,
          location,
          wanted: wanted.version,
          latest: latest.version,
          dependent: edge.from ? edge.from.name : 'global',
          homepage: packument.homepage,
        })
      }
    } catch (err) {
      // silently catch and ignore ETARGET, E403 &
      // E404 errors, deps are just skipped {
      if (!(
        err.code === 'ETARGET' ||
        err.code === 'E403' ||
        err.code === 'E404')
      )
        throw err
    }
  }
 
  const p = []
  if (deps.length !== 0) {
    // specific deps
    for (let i = 0; i < deps.length; i++) {
      const nodes = tree.inventory.query('name', deps[i])
      getEdges(nodes, 'edgesIn')
    }
  } else {
    if (opts.all) {
      // all deps in tree
      const nodes = tree.inventory.values()
      getEdges(nodes, 'edgesOut')
    }
    // top-level deps
    getEdges()
  }
 
  for (const edge of edges)
    p.push(getOutdatedInfo(edge))
 
  await Promise.all(p)
  return list
}
 
// formatting functions
function makePretty (dep, opts) {
  const {
    current = 'MISSING',
    location = '-',
    homepage = '',
    name,
    wanted,
    latest,
    type,
    dependent,
  } = dep
 
  const columns = [name, current, wanted, latest, location, dependent]
 
  if (opts.long) {
    columns[6] = type
    columns[7] = homepage
  }
 
  if (opts.color) {
    columns[0] = color[current === wanted ? 'yellow' : 'red'](columns[0]) // current
    columns[2] = color.green(columns[2]) // wanted
    columns[3] = color.magenta(columns[3]) // latest
  }
 
  return columns
}
 
// --parseable creates output like this:
// <fullpath>:<name@wanted>:<name@installed>:<name@latest>:<dependedby>
function makeParseable (list, opts) {
  return list.map(dep => {
    const {
      name,
      current,
      wanted,
      latest,
      path,
      dependent,
      type,
      homepage,
    } = dep
    const out = [
      path,
      name + '@' + wanted,
      current ? (name + '@' + current) : 'MISSING',
      name + '@' + latest,
      dependent,
    ]
    if (opts.long)
      out.push(type, homepage)
 
    return out.join(':')
  }).join(os.EOL)
}
 
function makeJSON (list, opts) {
  const out = {}
  list.forEach(dep => {
    const {
      name,
      current,
      wanted,
      latest,
      path,
      type,
      dependent,
      homepage,
    } = dep
    out[name] = {
      current,
      wanted,
      latest,
      dependent,
      location: path,
    }
    if (opts.long) {
      out[name].type = type
      out[name].homepage = homepage
    }
  })
  return JSON.stringify(out, null, 2)
}
 
module.exports = Object.assign(cmd, { completion, usage })