All files / lib run-script.js

100% Statements 84/84
100% Branches 48/48
100% Functions 7/7
100% Lines 82/82

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 1472x 2x 2x 2x 2x 2x 2x 2x 2x 2x   2x         2x 4x 4x   3x 3x 3x     1x     2x 19x 19x     2x 11x 11x 11x   11x 10x   10x 1x 9x 5x   10x   10x 3x 1x   2x 2x         7x 7x 6x 2x   6x 2x     7x                   7x 11x               2x 8x 8x 7x                 56x   7x 1x   6x 6x 1x   5x 1x 1x     4x 1x 5x   1x     3x 3x 3x 3x 3x 7x 7x     3x 2x   3x 4x   3x 1x 2x 1x   3x 3x   3x     2x  
const run = require('@npmcli/run-script')
const { isServerPackage } = run
const npm = require('./npm.js')
const readJson = require('read-package-json-fast')
const { resolve } = require('path')
const output = require('./utils/output.js')
const log = require('npmlog')
const usageUtil = require('./utils/usage')
const didYouMean = require('./utils/did-you-mean')
const isWindowsShell = require('./utils/is-windows-shell.js')
 
const usage = usageUtil(
  'run-script',
  'npm run-script <command> [-- <args>]'
)
 
const completion = async (opts, cb) => {
  const argv = opts.conf.argv.remain
  if (argv.length === 2) {
    // find the script name
    const json = resolve(npm.localPrefix, 'package.json')
    const { scripts = {} } = await readJson(json).catch(er => ({}))
    return cb(null, Object.keys(scripts))
  }
  // otherwise nothing to do, just let the system handle it
  return cb()
}
 
const cmd = (args, cb) => {
  const fn = args.length ? runScript : list
  return fn(args).then(() => cb()).catch(cb)
}
 
const runScript = async (args) => {
  const path = npm.localPrefix
  const event = args.shift()
  const { scriptShell } = npm.flatOptions
 
  const pkg = await readJson(`${path}/package.json`)
  const { scripts = {} } = pkg
 
  if (event === 'restart' && !scripts.restart)
    scripts.restart = 'npm stop --if-present && npm start'
  else if (event === 'env')
    scripts.env = isWindowsShell ? 'SET' : 'env'
 
  pkg.scripts = scripts
 
  if (!scripts[event] && !(event === 'start' && await isServerPackage(path))) {
    if (npm.config.get('if-present'))
      return
 
    const suggestions = didYouMean(event, Object.keys(scripts))
    throw new Error(`missing script: ${event}${
      suggestions ? `\n${suggestions}` : ''}`)
  }
 
  // positional args only added to the main event, not pre/post
  const events = [[event, args]]
  if (!npm.flatOptions.ignoreScripts) {
    if (scripts[`pre${event}`])
      events.unshift([`pre${event}`, []])
 
    if (scripts[`post${event}`])
      events.push([`post${event}`, []])
  }
 
  const opts = {
    path,
    args,
    scriptShell,
    stdio: 'inherit',
    stdioString: true,
    pkg,
    banner: log.level !== 'silent',
  }
 
  for (const [event, args] of events) {
    await run({
      ...opts,
      event,
      args,
    })
  }
}
 
const list = async () => {
  const path = npm.localPrefix
  const { scripts, name } = await readJson(`${path}/package.json`)
  const cmdList = [
    'publish',
    'install',
    'uninstall',
    'test',
    'stop',
    'start',
    'restart',
    'version',
  ].reduce((l, p) => l.concat(['pre' + p, p, 'post' + p]), [])
 
  if (!scripts)
    return []
 
  const allScripts = Object.keys(scripts)
  if (log.level === 'silent')
    return allScripts
 
  if (npm.flatOptions.json) {
    output(JSON.stringify(scripts, null, 2))
    return allScripts
  }
 
  if (npm.flatOptions.parseable) {
    for (const [script, cmd] of Object.entries(scripts))
      output(`${script}:${cmd}`)
 
    return allScripts
  }
 
  const indent = '\n    '
  const prefix = '  '
  const cmds = []
  const runScripts = []
  for (const script of allScripts) {
    const list = cmdList.includes(script) ? cmds : runScripts
    list.push(script)
  }
 
  if (cmds.length)
    output(`Lifecycle scripts included in ${name}:`)
 
  for (const script of cmds)
    output(prefix + script + indent + scripts[script])
 
  if (!cmds.length && runScripts.length)
    output(`Scripts available in ${name} via \`npm run-script\`:`)
  else if (runScripts.length)
    output('\navailable via `npm run-script`:')
 
  for (const script of runScripts)
    output(prefix + script + indent + scripts[script])
 
  return allScripts
}
 
module.exports = Object.assign(cmd, { completion, usage })