# All files npm.js

100% Statements 141/141
98.28% Branches 57/58
100% Functions 35/35
100% Lines 136/136

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
    290
    291
    292
    293

    2x
    2x
    2x

    2x

    2x

    12x

    2x
    2x
    2x

    12x
    5x

    7x
    7x
    1x
    1x

    6x
    1x
    1x

    5x
    5x
    5x

    2x
    5x
    5x
    5x
    5x

    2x

    2x
    2x
    2x
    2x
    2x
    2x

    2x
    2x
    2x

    2x
    2x
    2x
    2x
    2x
    2x
    2x

    2x

    1x

    5x
    1x

    4x
    4x

    4x
    3x

    1x
    1x

    4x
    2x
    2x

    2x
    2x
    2x

    10x
    2x

    8x
    8x
    2x
    2x

    6x
    1x

    5x

    5x
    5x
    5x
    5x
    5x
    5x
    1x

    5x
    2x
    2x

    5x
    5x

    16x

    5x
    5x
    5x
    1x
    1x
    1x

    5x

    5x
    4x

    4x

    4x
    4x

    4x

    4x
    4x
    4x

    4x
    4x
    1x

    4x

    4x

    6x

    1x

    10x

    6x

    1x

    29x

    2x

    27x

    2x

    8x

    7x

    10x

    9x
    9x

    5x

    7x

    17x

    2x
    2x

    4x
    2x
    2x

    4x

    2x
    2x
    2x

    2x

    2x
    2x
    2x
    2x
    2x

    2x
    1x

     // The order of the code in this file is relevant, because a lot of things
    // require('npm.js'), but also we need to use some of those modules.  So,
    // we define and instantiate the singleton ahead of loading any modules
    // required for its methods.

    // these are all dependencies used in the ctor
    const EventEmitter = require('events')
    const { resolve, dirname } = require('path')
    const Config = require('@npmcli/config')

    // Patch the global fs module here at the app level
    require('graceful-fs').gracefulify(require('fs'))

    const procLogListener = require('./utils/proc-log-listener.js')

    const hasOwnProperty = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key)

    // the first time `npm.commands.xyz` is loaded, it gets added
    // to the cmds object, so we don't have to load it again.
    const proxyCmds = (npm) => {
      const cmds = {}
      return new Proxy(cmds, {
        get: (prop, cmd) => {
          if (hasOwnProperty(cmds, cmd)) {
            return cmds[cmd]
          }

          const actual = deref(cmd)
          if (!actual) {
            cmds[cmd] = undefined
            return cmds[cmd]
          }
          if (cmds[actual]) {
            cmds[cmd] = cmds[actual]
            return cmds[cmd]
          }
          cmds[actual] = makeCmd(actual)
          cmds[cmd] = cmds[actual]
          return cmds[cmd]
        }
      })
    }

    const makeCmd = cmd => {
      const impl = require(`./${cmd}.js`)
      const fn = (args, cb) => npm[_runCmd](cmd, impl, args, cb)
      Object.assign(fn, impl)
      return fn
    }

    const { types, defaults, shorthands } = require('./utils/config.js')

    let warnedNonDashArg = false
    const _runCmd = Symbol('_runCmd')
    const _load = Symbol('_load')
    const _flatOptions = Symbol('_flatOptions')
    const _tmpFolder = Symbol('_tmpFolder')
    const npm = module.exports = new class extends EventEmitter {
      constructor () {
        super()
        require('./utils/perf.js')
        this.modes = {
          exec: 0o755,
          file: 0o644,
          umask: 0o22
        }
        this.started = Date.now()
        this.command = null
        this.commands = proxyCmds(this)
        procLogListener()
        process.emit('time', 'npm')
        this.version = require('../package.json').version
        this.config = new Config({
          npmPath: dirname(__dirname),
          types,
          defaults,
          shorthands
        })
        this.updateNotification = null
      }

      deref (c) {
        return deref(c)
      }

      // this will only ever be called with cmd set to the canonical command name
      [_runCmd] (cmd, impl, args, cb) {
        if (!this.loaded) {
          throw new Error(
            'Call npm.load(cb) before using this command.\n' +
            'See the README.md or bin/npm-cli.js for example usage.'
          )
        }

        process.emit('time', `command:${cmd}`)
        this.command = cmd

        // Options are prefixed by a hyphen-minus (-, \u2d).
        // Other dash-type chars look similar but are invalid.
        if (!warnedNonDashArg) {
          args.filter(arg => /^[\u2010-\u2015\u2212\uFE58\uFE63\uFF0D]/.test(arg))
            .forEach(arg => {
              warnedNonDashArg = true
              log.error('arg', 'Argument starts with non-ascii dash, this is probably invalid:', arg)
            })
        }

        if (this.config.get('usage')) {
          console.log(impl.usage)
          cb()
        } else {
          impl(args, er => {
            process.emit('timeEnd', `command:${cmd}`)
            cb(er)
          })
        }
      }

      // call with parsed CLI options and a callback when done loading
      // XXX promisify this and stop taking a callback
      load (cb) {
        if (!cb || typeof cb !== 'function') {
          throw new TypeError('must call as: npm.load(callback)')
        }
        this.once('load', cb)
        if (this.loaded || this.loadErr) {
          this.emit('load', this.loadErr)
          return
        }
        if (this.loading) {
          return
        }
        this.loading = true

        process.emit('time', 'npm:load')
        this.log.pause()
        return this[_load]().catch(er => er).then((er) => {
          this.loading = false
          this.loadErr = er
          if (!er && this.config.get('force')) {
            this.log.warn('using --force', 'Recommended protections disabled.')
          }
          if (!er && !this[_flatOptions]) {
            this[_flatOptions] = require('./config/flat-options.js')(this)
            process.env.npm_command = this.command
          }
          process.emit('timeEnd', 'npm:load')
          this.emit('load', er)
        })
      }

      get loaded () {
        return this.config.loaded
      }

      async [_load] () {
        const node = await which(process.argv[0]).catch(er => null)
        console.error('_LOAD', node, process.execPath)
        if (node && node.toUpperCase() !== process.execPath.toUpperCase()) {
          console.error('IS A SYMLINK')
          log.verbose('node symlink', node)
          process.execPath = node
        }
        this.config.execPath = node

        await this.config.load()
        this.argv = this.config.parsedArgv.remain

        setUserAgent(this.config)

        this.color = setupLog(this.config, this)
        process.env.COLOR = this.color ? '1' : '0'

        cleanUpLogFiles(this.cache, this.config.get('logs-max'), log.warn)

        log.resume()
        const umask = this.config.get('umask')
        this.modes = {
          exec: 0o777 & (~umask),
          file: 0o666 & (~umask),
          umask
        }

        const configScope = this.config.get('scope')
        if (configScope && !/^@/.test(configScope)) {
          this.config.set('scope', `@${configScope}`, this.config.find('scope'))
        }
        this.projectScope = this.config.get('scope') ||
          getProjectScope(this.prefix)

        startMetrics()
      }

      get flatOptions () {
        return this[_flatOptions]
      }

      get lockfileVersion () {
        return 2
      }

      get log () {
        return log
      }

      get cache () {
        return this.config.get('cache')
      }

      set cache (r) {
        this.config.set('cache', r)
      }

      get globalPrefix () {
        return this.config.globalPrefix
      }

      set globalPrefix (r) {
        this.config.globalPrefix = r
      }

      get localPrefix () {
        return this.config.localPrefix
      }

      set localPrefix (r) {
        this.config.localPrefix = r
      }

      get globalDir () {
        return process.platform !== 'win32'
          ? resolve(this.globalPrefix, 'lib', 'node_modules')
          : resolve(this.globalPrefix, 'node_modules')
      }

      get localDir () {
        return resolve(this.localPrefix, 'node_modules')
      }

      get dir () {
        return (this.config.get('global')) ? this.globalDir : this.localDir
      }

      get globalBin () {
        const b = this.globalPrefix
        return process.platform !== 'win32' ? resolve(b, 'bin') : b
      }

      get localBin () {
        return resolve(this.dir, '.bin')
      }

      get bin () {
        return this.config.get('global') ? this.globalBin : this.localBin
      }

      get prefix () {
        return this.config.get('global') ? this.globalPrefix : this.localPrefix
      }

      set prefix (r) {
        const k = this.config.get('global') ? 'globalPrefix' : 'localPrefix'
        this[k] = r
      }

      // XXX add logging to see if we actually use this
      get tmp () {
        if (!this[_tmpFolder]) {
          const rand = require('crypto').randomBytes(4).toString('hex')
          this[_tmpFolder] = `npm-${process.pid}-${rand}`
        }
        return resolve(this.config.get('tmp'), this[_tmpFolder])
      }
    }()

    // now load everything required by the class methods

    const log = require('npmlog')
    const { promisify } = require('util')
    const startMetrics = require('./utils/metrics.js').start

    const which = promisify(require('which'))

    const setUserAgent = require('./utils/set-user-agent.js')
    const deref = require('./utils/deref-command.js')
    const setupLog = require('./utils/setup-log.js')
    const cleanUpLogFiles = require('./utils/cleanup-log-files.js')
    const getProjectScope = require('./utils/get-project-scope.js')

    if (require.main === module) {
      require('./cli.js')(process)
    }