@npmcli/config 1.1.6 → 1.2.1

package/README.md

@@ -2,7 +2,7 @@
 
 Configuration management for the npm cli.
 
-This module is the spiritual decendant of
+This module is the spiritual descendant of
 [`npmconf`](http://npm.im/npmconf), and the code that once lived in npm's
 `lib/config/` folder.
 
@@ -27,7 +27,7 @@ The only exceptions:
 - A `builtin` config, read from a `npmrc` file in the root of the npm
   project itself, overrides all defaults.
 
-The resulting heirarchy of configs:
+The resulting hierarchy of configs:
 
 - CLI switches.  eg `--some-key=some-value` on the command line.  These are
   parsed by [`nopt`](http://npm.im/nopt), which is not a great choice, but

package/lib/env-replace.js

@@ -3,12 +3,11 @@
 const envExpr = /(\\*)\$\{([^}]+)\}/g
 
 module.exports = (f, env) => f.replace(envExpr, (orig, esc, name) => {
+  const val = env[name] !== undefined ? env[name] : `\$\{${name}\}`
+
   // consume the escape chars that are relevant.
   if (esc.length % 2)
     return orig.substr((esc.length + 1) / 2)
 
-  if (undefined === env[name])
-    throw new Error('Failed to replace env in config: ' + orig)
-
-  return (esc.substr(esc.length / 2)) + env[name]
+  return (esc.substr(esc.length / 2)) + val
 })

package/lib/get-user-agent.js

@@ -0,0 +1,13 @@
+// Accepts a config object, returns a user-agent string
+const getUserAgent = (config) => {
+  const ciName = config.get('ci-name')
+  return (config.get('user-agent') || '')
+    .replace(/\{node-version\}/gi, config.get('node-version'))
+    .replace(/\{npm-version\}/gi, config.get('npm-version'))
+    .replace(/\{platform\}/gi, process.platform)
+    .replace(/\{arch\}/gi, process.arch)
+    .replace(/\{ci\}/gi, ciName ? `ci/${ciName}` : '')
+    .trim()
+}
+
+module.exports = getUserAgent

package/lib/index.js

@@ -47,6 +47,7 @@ const envReplace = require('./env-replace.js')
 const parseField = require('./parse-field.js')
 const typeDescription = require('./type-description.js')
 const setEnvs = require('./set-envs.js')
+const getUserAgent = require('./get-user-agent.js')
 
 // types that can be saved back to
 const confFileTypes = new Set([
@@ -241,6 +242,13 @@ class Config {
     // symbols, as that module also does a bunch of get operations
     this[_loaded] = true
 
+    // set proper globalPrefix now that everything is loaded
+    this.globalPrefix = this.get('prefix')
+
+    process.emit('time', 'config:load:setUserAgent')
+    this.setUserAgent()
+    process.emit('timeEnd', 'config:load:setUserAgent')
+
     process.emit('time', 'config:load:setEnvs')
     this.setEnvs()
     process.emit('timeEnd', 'config:load:setEnvs')
@@ -300,7 +308,7 @@ class Config {
     const prefix = 'npm_config_'
     const conf = Object.create(null)
     for (const [envKey, envVal] of Object.entries(this.env)) {
-      if (!/^npm_config_/i.test(envKey))
+      if (!/^npm_config_/i.test(envKey) || envVal === '')
         continue
       const key = envKey.substr('npm_config_'.length)
         .replace(/(?!^)_/g, '-') // don't replace _ at the start of the key
@@ -691,6 +699,12 @@ class Config {
     })
   }
 
+  // the user-agent configuration is a template that gets populated
+  // with some variables, that takes place here
+  setUserAgent () {
+    this.set('user-agent', getUserAgent(this))
+  }
+
   // set up the environment object we have with npm_config_* environs
   // for all configs that are different from their default values, and
   // set EDITOR and HOME.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/config",
-  "version": "1.1.6",
+  "version": "1.2.1",
   "files": [
     "lib"
   ],