All files / lib config.js

100% Statements 127/127
100% Branches 65/65
100% Functions 16/16
100% Lines 123/123

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 2374x 4x 4x 4x   4x 4x 4x 4x 4x 4x 4x 4x 4x   4x                     21x   4x 11x 11x 1x   11x 2x 2x 1x   2x     9x 9x     2x 1x             4x         4x       4x 3x   4x 21x 21x 21x   6x 5x   3x 2x       3x 2x     4x 4x   4x 3x   1x     21x       4x 6x 1x   5x 2x 1x 1x 1x   1x     5x 5x 5x 5x 5x 5x 1x   5x     4x 3x 1x   2x 1x   1x     4x 3x 1x   2x 2x 2x     4x 4x 4x 1x   3x 3x       3x   3x 1x   3x 12x 12x           12x     3x                     2x               3x 3x 3x     30x   4x 4x 4x 4x 13x 3x   26x 10x 4x   6x 6x 23x 23x 23x 23x     6x     4x 3x               4x     4x 1x 1x 5x 1x   4x   1x     4x  
const npm = require('./npm.js')
const { defaults, types } = require('./utils/config.js')
const usageUtil = require('./utils/usage.js')
const output = require('./utils/output.js')
 
const mkdirp = require('mkdirp-infer-owner')
const { dirname } = require('path')
const { promisify } = require('util')
const fs = require('fs')
const readFile = promisify(fs.readFile)
const writeFile = promisify(fs.writeFile)
const editor = promisify(require('editor'))
const { EOL } = require('os')
const ini = require('ini')
 
const usage = usageUtil(
  'config',
  'npm config set <key> <value>' +
  '\nnpm config get [<key>]' +
  '\nnpm config delete <key>' +
  '\nnpm config list [--json]' +
  '\nnpm config edit' +
  '\nnpm set <key> <value>' +
  '\nnpm get [<key>]'
)
 
const cmd = (args, cb) => config(args).then(() => cb()).catch(cb)
 
const completion = (opts, cb) => {
  const argv = opts.conf.argv.remain
  if (argv[1] !== 'config')
    argv.unshift('config')
 
  if (argv.length === 2) {
    const cmds = ['get', 'set', 'delete', 'ls', 'rm', 'edit']
    if (opts.partialWord !== 'l')
      cmds.push('list')
 
    return cb(null, cmds)
  }
 
  const action = argv[2]
  switch (action) {
    case 'set':
      // todo: complete with valid values, if possible.
      if (argv.length > 3)
        return cb(null, [])
 
      // fallthrough
      /* eslint no-fallthrough:0 */
    case 'get':
    case 'delete':
    case 'rm':
      return cb(null, Object.keys(types))
    case 'edit':
    case 'list':
    case 'ls':
    default:
      return cb(null, [])
  }
}
 
const UsageError = () =>
  Object.assign(new Error(usage), { code: 'EUSAGE' })
 
const config = async ([action, key, val]) => {
  npm.log.disableProgress()
  try {
    switch (action) {
      case 'set':
        await set(key, val)
        break
      case 'get':
        await get(key)
        break
      case 'delete':
      case 'rm':
      case 'del':
        await del(key)
        break
      case 'list':
      case 'ls':
        await (npm.flatOptions.json ? listJson() : list())
        break
      case 'edit':
        await edit()
        break
      default:
        throw UsageError()
    }
  } finally {
    npm.log.enableProgress()
  }
}
 
const set = async (key, val) => {
  if (key === undefined)
    throw UsageError()
 
  if (val === undefined) {
    if (key.indexOf('=') !== -1) {
      const k = key.split('=')
      key = k.shift()
      val = k.join('=')
    } else
      val = ''
  }
 
  key = key.trim()
  val = val.trim()
  npm.log.info('config', 'set %j %j', key, val)
  const where = npm.flatOptions.global ? 'global' : 'user'
  npm.config.set(key, val, where)
  if (!npm.config.validate(where))
    npm.log.warn('config', 'omitting invalid config values')
 
  await npm.config.save(where)
}
 
const get = async key => {
  if (!key)
    return list()
 
  if (!publicVar(key))
    throw `The ${key} option is protected, and cannot be retrieved in this way`
 
  output(npm.config.get(key))
}
 
const del = async key => {
  if (!key)
    throw UsageError()
 
  const where = npm.flatOptions.global ? 'global' : 'user'
  npm.config.delete(key, where)
  await npm.config.save(where)
}
 
const edit = async () => {
  const { editor: e, global } = npm.flatOptions
  if (!e)
    throw new Error('No `editor` config or EDITOR environment variable set')
 
  const where = global ? 'global' : 'user'
  const file = npm.config.data.get(where).source
 
  // save first, just to make sure it's synced up
  // this also removes all the comments from the last time we edited it.
  await npm.config.save(where)
 
  const data = (
    await readFile(file, 'utf8').catch(() => '')
  ).replace(/\r\n/g, '\n')
  const defData = Object.entries(defaults).reduce((str, [key, val]) => {
    const obj = { [key]: val }
    const i = ini.stringify(obj)
      .replace(/\r\n/g, '\n') // normalizes output from ini.stringify
      .replace(/\n$/m, '')
      .replace(/^/g, '; ')
      .replace(/\n/g, '\n; ')
      .split('\n')
    return str + '\n' + i
  }, '')
 
  const tmpData = `;;;;
; npm ${where}config file: ${file}
; this is a simple ini-formatted file
; lines that start with semi-colons are comments
; run \`npm help 7 config\` for documentation of the various options
;
; Configs like \`@scope:registry\` map a scope to a given registry url.
;
; Configs like \`//<hostname>/:_authToken\` are auth that is restricted
; to the registry host specified.
 
${data.split('\n').sort((a, b) => a.localeCompare(b)).join('\n').trim()}
 
;;;;
; all available options shown below with default values
;;;;
 
${defData}
`.split('\n').join(EOL)
  await mkdirp(dirname(file))
  await writeFile(file, tmpData, 'utf8')
  await editor(file, { editor: e })
}
 
const publicVar = k => !/^(\/\/[^:]+:)?_/.test(k)
 
const list = async () => {
  const msg = []
  const { long } = npm.flatOptions
  for (const [where, { data, source }] of npm.config.data.entries()) {
    if (where === 'default' && !long)
      continue
 
    const keys = Object.keys(data).sort((a, b) => a.localeCompare(b))
    if (!keys.length)
      continue
 
    msg.push(`; "${where}" config from ${source}`, '')
    for (const k of keys) {
      const v = publicVar(k) ? JSON.stringify(data[k]) : '(protected)'
      const src = npm.config.find(k)
      const overridden = src !== where
      msg.push((overridden ? '; ' : '') +
        `${k} = ${v} ${overridden ? `; overridden by ${src}` : ''}`)
    }
    msg.push('')
  }
 
  if (!long) {
    msg.push(
      `; node bin location = ${process.execPath}`,
      `; cwd = ${process.cwd()}`,
      `; HOME = ${process.env.HOME}`,
      '; Run `npm config ls -l` to show all defaults.'
    )
  }
 
  output(msg.join('\n').trim())
}
 
const listJson = async () => {
  const publicConf = {}
  for (const key in npm.config.list[0]) {
    if (!publicVar(key))
      continue
 
    publicConf[key] = npm.config.get(key)
  }
  output(JSON.stringify(publicConf, null, 2))
}
 
module.exports = Object.assign(cmd, { usage, completion })