# All files error-message.js

100% Statements 129/129
100% Branches 95/95
100% Functions 3/3
100% Lines 129/129

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
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    1x
    1x
    1x
    1x
    1x

    1x
    61x
    61x
    61x

    2x
    2x
    2x
    2x
    2x

    1x
    1x

    1x
    1x

    1x

    16x

    16x

    16x

    16x

    3x
    3x

    13x
    13x

    16x

    1x
    1x

    1x

    3x
    2x
    2x
    2x
    1x

    1x

    2x
    2x

    2x

    8x
    2x
    2x

    6x
    4x

    6x
    1x
    1x

    5x
    1x
    1x

    4x

    8x

    4x
    4x
    3x

    3x
    3x

    3x

    3x
    1x

    2x

    2x
    2x
    2x

    3x
    3x

    4x

    1x
    1x
    1x
    1x
    1x
    1x

    1x
    1x
    1x

    1x

    2x
    2x
    2x
    2x
    2x

    2x

    2x

    1x
    1x
    1x
    1x
    1x

    1x
    1x
    1x

    4x
    4x

    4x

    1x
    1x

    1x

    1x
    1x

    1x

    2x
    2x
    2x

    2x

    1x
    1x

    1x

    1x
    1x

    1x

    2x
    2x

    2x

    4x
    4x

    4x

    3x
    3x
    1x

    3x
    1x

    3x
    1x

    3x
    1x

    3x

    61x

     'use strict'
    const npm = require('../npm.js')
    const { format } = require('util')
    const { resolve } = require('path')
    const nameValidator = require('validate-npm-package-name')
    const npmlog = require('npmlog')

    module.exports = (er) => {
      const short = []
      const detail = []
      switch (er.code) {
        case 'ENOLOCK':
          const cmd = npm.command || ''
          short.push([cmd, 'This command requires an existing lockfile.'])
          detail.push([cmd, 'Try creating one first with: npm i --package-lock-only'])
          detail.push([cmd, `Original error: ${er.message}`])
          break
        case 'ENOAUDIT':
          short.push(['audit', er.message])
          break

        case 'ECONNREFUSED':
          short.push(['', er])
          detail.push([
            '',
            [
              '\nIf you are behind a proxy, please make sure that the',
              "'proxy' config is set properly.  See: 'npm help config'"
            ].join('\n')
          ])
          break

        case 'EACCES':
        case 'EPERM':
          const isCachePath = typeof er.path === 'string' &&
            npm.config.loaded && er.path.startsWith(npm.config.get('cache'))
          const isCacheDest = typeof er.dest === 'string' &&
            npm.config.loaded && er.dest.startsWith(npm.config.get('cache'))

          const isWindows = require('./is-windows.js')

          if (!isWindows && (isCachePath || isCacheDest)) {
            // user probably doesn't need this, but still add it to the debug log
            npmlog.verbose(er.stack)
            short.push([
              '',
              [
                '',
                'Your cache folder contains root-owned files, due to a bug in',
                'previous versions of npm which has since been addressed.',
                '',
                'To permanently fix this problem, please run:',
                `  sudo chown -R ${process.getuid()}:${process.getgid()} ${JSON.stringify(npm.config.get('cache'))}`
              ].join('\n')
            ])
          } else {
            short.push(['', er])
            detail.push([
              '',
              [
                '\nThe operation was rejected by your operating system.',
                (isWindows
                  ? 'It\'s possible that the file was already in use (by a text editor or antivirus),\n' +
                    'or that you lack permissions to access it.'
                  : 'It is likely you do not have the permissions to access this file as the current user'),
                '\nIf you believe this might be a permissions issue, please double-check the',
                'permissions of the file and its containing directories, or try running',
                'the command again as root/Administrator.'
              ].join('\n')])
          }
          break

        case 'ENOGIT':
          short.push(['', er.message])
          detail.push([
            '',
            [
              '',
              'Failed using git.',
              'Please check if you have git installed and in your PATH.'
            ].join('\n')
          ])
          break

        case 'EJSONPARSE':
          // Check whether we ran into a conflict in our own package.json
          if (er.file === resolve(npm.prefix, 'package.json')) {
            const { isDiff } = require('parse-conflict-json')
            const txt = require('fs').readFileSync(er.file, 'utf8')
            if (isDiff(txt)) {
              detail.push([
                '',
                [
                  'Merge conflict detected in your package.json.',
                  '',
                  'Please resolve the package.json conflict and retry the command:',
                  '',
                  `$ ${process.argv.join(' ')}`
                ].join('\n')
              ])
              break
            }
          }
          short.push(['JSON.parse', er.message])
          detail.push([
            'JSON.parse',
            [
              'Failed to parse JSON data.',
              'Note: package.json must be actual JSON, not just JavaScript.'
            ].join('\n')
          ])
          break

        case 'EOTP':
        case 'E401':
          // E401 is for places where we accidentally neglect OTP stuff
          if (er.code === 'EOTP' || /one-time pass/.test(er.message)) {
            short.push(['', 'This operation requires a one-time password from your authenticator.'])
            detail.push([
              '',
              [
                'You can provide a one-time password by passing --otp=<code> to the command you ran.',
                'If you already provided a one-time password then it is likely that you either typoed',
                'it, or it timed out. Please try again.'
              ].join('\n')
            ])
          } else {
            // npm ERR! code E401
            // npm ERR! Unable to authenticate, need: Basic
            const auth = !er.headers || !er.headers['www-authenticate'] ? []
              : er.headers['www-authenticate'].map((au) => au.split(/[,\s]+/))[0]

            if (auth.includes('Bearer')) {
              short.push(['', 'Unable to authenticate, your authentication token seems to be invalid.'])
              detail.push([
                '',
                [
                  'To correct this please trying logging in again with:',
                  '    npm login'
                ].join('\n')
              ])
            } else if (auth.includes('Basic')) {
              short.push(['', 'Incorrect or missing password.'])
              detail.push([
                '',
                [
                  'If you were trying to login, change your password, create an',
                  'authentication token or enable two-factor authentication then',
                  'that means you likely typed your password in incorrectly.',
                  'Please try again, or recover your password at:',
                  '    https://www.npmjs.com/forgot',
                  '',
                  'If you were doing some other operation then your saved credentials are',
                  'probably out of date. To correct this please try logging in again with:',
                  '    npm login'
                ].join('\n')
              ])
            } else {
              short.push(['', er.message || er])
            }
          }
          break

        case 'E404':
          // There's no need to have 404 in the message as well.
          short.push(['404', er.message.replace(/^404\s+/, '')])
          if (er.pkgid && er.pkgid !== '-') {
            const pkg = er.pkgid.replace(/(?!^)@.*$/, '')

            detail.push(['404', ''])
            detail.push(['404', '', "'" + er.pkgid + "' is not in the npm registry."])

            const valResult = nameValidator(pkg)

            if (valResult.validForNewPackages) {
              detail.push(['404', 'You should bug the author to publish it (or use the name yourself!)'])
            } else {
              detail.push(['404', 'This package name is not valid, because', ''])

              const errorsArray = (valResult.errors || []).concat(valResult.warnings || [])
              errorsArray.forEach(function (item, idx) {
                detail.push(['404', ' ' + (idx + 1) + '. ' + item])
              })
            }

            detail.push(['404', '\nNote that you can also install from a'])
            detail.push(['404', 'tarball, folder, http url, or git url.'])
          }
          break

        case 'EPUBLISHCONFLICT':
          short.push(['publish fail', 'Cannot publish over existing version.'])
          detail.push(['publish fail', "Update the 'version' field in package.json and try again."])
          detail.push(['publish fail', ''])
          detail.push(['publish fail', 'To automatically increment version numbers, see:'])
          detail.push(['publish fail', '    npm help version'])
          break

        case 'EISGIT':
          short.push(['git', er.message])
          short.push(['git', '    ' + er.path])
          detail.push([
            'git',
            [
              'Refusing to remove it. Update manually,',
              'or move it out of the way first.'
            ].join('\n')
          ])
          break

        case 'EBADPLATFORM':
          const validOs = er.os.join ? er.os.join(',') : er.os
          const validArch = er.cpu.join ? er.cpu.join(',') : er.cpu
          const expected = {os: validOs, arch: validArch}
          const actual = {os: process.platform, arch: process.arch}
          short.push([
            'notsup',
            [
              format('Unsupported platform for %s: wanted %j (current: %j)', er.pkgid, expected, actual)
            ].join('\n')
          ])
          detail.push([
            'notsup',
            [
              'Valid OS:    ' + validOs,
              'Valid Arch:  ' + validArch,
              'Actual OS:   ' + process.platform,
              'Actual Arch: ' + process.arch
            ].join('\n')
          ])
          break

        case 'EEXIST':
          short.push(['', er.message])
          short.push(['', 'File exists: ' + (er.dest || er.path)])
          detail.push(['', 'Remove the existing file and try again, or run npm'])
          detail.push(['', 'with --force to overwrite files recklessly.'])
          break

        case 'ENEEDAUTH':
          short.push(['need auth', er.message])
          detail.push(['need auth', 'You need to authorize this machine using `npm adduser`'])
          break

        case 'ECONNRESET':
        case 'ENOTFOUND':
        case 'ETIMEDOUT':
        case 'EAI_FAIL':
          short.push(['network', er.message])
          detail.push([
            'network',
            [
              'This is a problem related to network connectivity.',
              'In most cases you are behind a proxy or have bad network settings.',
              '\nIf you are behind a proxy, please make sure that the',
              "'proxy' config is set properly.  See: 'npm help config'"
            ].join('\n')
          ])
          break

        case 'ETARGET':
          short.push(['notarget', er.message])
          detail.push(['notarget', [
            'In most cases you or one of your dependencies are requesting',
            "a package version that doesn't exist."
          ].join('\n')])
          break

        case 'E403':
          short.push(['403', er.message])
          detail.push(['403', [
            'In most cases, you or one of your dependencies are requesting',
            'a package version that is forbidden by your security policy, or',
            'on a server you do not have access to.'
          ].join('\n')])
          break

        case 'EBADENGINE':
          short.push(['engine', er.message])
          short.push(['engine', 'Not compatible with your version of node/npm: ' + er.pkgid])
          detail.push([
            'notsup',
            [
              'Not compatible with your version of node/npm: ' + er.pkgid,
              'Required: ' + JSON.stringify(er.required),
              'Actual:   ' + JSON.stringify({
                npm: npm.version,
                node: npm.config.loaded ? npm.config.get('node-version') : process.version
              })
            ].join('\n')
          ])
          break

        case 'ENOSPC':
          short.push(['nospc', er.message])
          detail.push([
            'nospc',
            [
              'There appears to be insufficient space on your system to finish.',
              'Clear up some disk space and try again.'
            ].join('\n')
          ])
          break

        case 'EROFS':
          short.push(['rofs', er.message])
          detail.push([
            'rofs',
            [
              'Often virtualized file systems, or other file systems',
              "that don't support symlinks, give this error."
            ].join('\n')
          ])
          break

        case 'ENOENT':
          short.push(['enoent', er.message])
          detail.push([
            'enoent',
            [
              'This is related to npm not being able to find a file.',
              er.file ? "\nCheck if the file '" + er.file + "' is present." : ''
            ].join('\n')
          ])
          break

        case 'EMISSINGARG':
        case 'EUNKNOWNTYPE':
        case 'EINVALIDTYPE':
        case 'ETOOMANYARGS':
          short.push(['typeerror', er.stack])
          detail.push([
            'typeerror',
            [
              'This is an error with npm itself. Please report this error at:',
              '    https://github.com/npm/cli/issues'
            ].join('\n')
          ])
          break

        default:
          short.push(['', er.message || er])
          if (er.signal) {
            detail.push(['signal', er.signal])
          }
          if (er.cmd && Array.isArray(er.args)) {
            detail.push(['command', ...[er.cmd, ...er.args]])
          }
          if (er.stdout) {
            detail.push(['', er.stdout.trim()])
          }
          if (er.stderr) {
            detail.push(['', er.stderr.trim()])
          }
          break
      }
      return {summary: short, detail: detail}
    }