@npmcli/config 3.0.1 → 4.0.2

package/README.md

@@ -78,9 +78,12 @@ const conf = new Config({
   platform: process.platform,
   // optional, defaults to process.cwd()
   cwd: process.cwd(),
-  // optional, defaults to emitting 'log' events on process object
-  // only silly, verbose, warn, and error are logged by this module
-  log: require('proc-log')
+})
+
+// emits log events on the process object
+// see `proc-log` for more info
+process.on('log', (level, ...args) => {
+  console.log(level, ...args)
 })
 
 // returns a promise that fails if config loading fails, and
@@ -124,8 +127,6 @@ Options:
   Windows.
 - `execPath` Optional, defaults to `process.execPath`.  Used to infer the
   `globalPrefix`.
-- `log` Optional, the object used to log debug messages, warnings, and
-  errors.  Defaults to emitting on the `process` object.
 - `env` Optional, defaults to `process.env`.  Source of the environment
   variables for configuration.
 - `argv` Optional, defaults to `process.argv`.  Source of the CLI options
@@ -161,7 +162,6 @@ Fields:
 - `argv` The `argv` param
 - `execPath` The `execPath` param
 - `platform` The `platform` param
-- `log` The `log` param
 - `defaults` The `defaults` param
 - `shorthands` The `shorthands` param
 - `types` The `types` param

package/lib/env-replace.js

@@ -1,14 +1,14 @@
 // replace any ${ENV} values with the appropriate environ.
 
-const envExpr = /(\\*)\$\{([^}]+)\}/g
+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)
+    return orig.slice((esc.length + 1) / 2)
   }
 
-  return (esc.substr(esc.length / 2)) + val
+  return (esc.slice(esc.length / 2)) + val
 })

package/lib/index.js

@@ -5,6 +5,7 @@ const nopt = require('nopt')
 const mkdirp = require('mkdirp-infer-owner')
 const mapWorkspaces = require('@npmcli/map-workspaces')
 const rpj = require('read-package-json-fast')
+const log = require('proc-log')
 
 /* istanbul ignore next */
 const myUid = process.getuid && process.getuid()
@@ -88,7 +89,6 @@ class Config {
     // options just to override in tests, mostly
     env = process.env,
     argv = process.argv,
-    log = require('proc-log'),
     platform = process.platform,
     execPath = process.execPath,
     cwd = process.cwd(),
@@ -114,7 +114,6 @@ class Config {
     this.defaults = defaults
 
     this.npmPath = npmPath
-    this.log = log
     this.argv = argv
     this.env = env
     this.execPath = execPath
@@ -367,7 +366,7 @@ class Config {
       if (!/^npm_config_/i.test(envKey) || envVal === '') {
         continue
       }
-      const key = envKey.substr('npm_config_'.length)
+      const key = envKey.slice('npm_config_'.length)
         .replace(/(?!^)_/g, '-') // don't replace _ at the start of the key
         .toLowerCase()
       conf[key] = envVal
@@ -397,13 +396,13 @@ class Config {
   validate (where) {
     if (!where) {
       let valid = true
-      for (const [where] of this.data.entries()) {
+      for (const [entryWhere] of this.data.entries()) {
         // no need to validate our defaults, we know they're fine
         // cli was already validated when parsed the first time
-        if (where === 'default' || where === 'builtin' || where === 'cli') {
+        if (entryWhere === 'default' || entryWhere === 'builtin' || entryWhere === 'cli') {
           continue
         }
-        const ret = this.validate(where)
+        const ret = this.validate(entryWhere)
         valid = valid && ret
       }
       return valid
@@ -436,7 +435,7 @@ class Config {
   }
 
   invalidHandler (k, val, type, source, where) {
-    this.log.warn(
+    log.warn(
       'invalid config',
       k + '=' + JSON.stringify(val),
       `set in ${source}`
@@ -469,7 +468,7 @@ class Config {
       : mustBe.filter(m => m !== Array)
         .map(n => typeof n === 'string' ? n : JSON.stringify(n))
         .join(', ')
-    this.log.warn('invalid config', msg, desc)
+    log.warn('invalid config', msg, desc)
   }
 
   [_loadObject] (obj, where, source, er = null) {
@@ -491,7 +490,7 @@ class Config {
     if (er) {
       conf.loadError = er
       if (er.code !== 'ENOENT') {
-        this.log.verbose('config', `error loading ${where} config`, er)
+        log.verbose('config', `error loading ${where} config`, er)
       }
     } else {
       conf.raw = obj
@@ -510,7 +509,7 @@ class Config {
     // XXX a future npm version will make this a warning.
     // An even more future npm version will make this an error.
     if (this.deprecated[key]) {
-      this.log.verbose('config', key, this.deprecated[key])
+      log.verbose('config', key, this.deprecated[key])
     }
   }
 
@@ -567,6 +566,7 @@ class Config {
     }
 
     const cliWorkspaces = this[_get]('workspaces', 'cli')
+    const isGlobal = this[_get]('global') || this[_get]('location') === 'global'
 
     for (const p of walkUp(this.cwd)) {
       const hasNodeModules = await stat(resolve(p, 'node_modules'))
@@ -580,8 +580,8 @@ class Config {
       if (!this.localPrefix && (hasNodeModules || hasPackageJson)) {
         this.localPrefix = p
 
-        // if workspaces are disabled, return now
-        if (cliWorkspaces === false) {
+        // if workspaces are disabled, or we're in global mode, return now
+        if (cliWorkspaces === false || isGlobal) {
           return
         }
 
@@ -607,14 +607,14 @@ class Config {
               .catch(() => false)
 
             if (hasNpmrc) {
-              this.log.warn(`ignoring workspace config at ${this.localPrefix}/.npmrc`)
+              log.warn(`ignoring workspace config at ${this.localPrefix}/.npmrc`)
             }
 
             // set the workspace in the default layer, which allows it to be overridden easily
             const { data } = this.data.get('default')
             data.workspace = [this.localPrefix]
             this.localPrefix = p
-            this.log.info(`found workspace root at ${this.localPrefix}`)
+            log.info(`found workspace root at ${this.localPrefix}`)
             // we found a root, so we return now
             return
           }

package/lib/parse-field.js

@@ -56,7 +56,7 @@ const parseField = (f, key, opts, listElement = false) => {
   if (isPath) {
     const homePattern = platform === 'win32' ? /^~(\/|\\)/ : /^~\//
     if (homePattern.test(f) && home) {
-      f = resolve(home, f.substr(2))
+      f = resolve(home, f.slice(2))
     } else {
       f = resolve(f)
     }

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@npmcli/config",
-  "version": "3.0.1",
+  "version": "4.0.2",
   "files": [
-    "bin",
-    "lib"
+    "bin/",
+    "lib/"
   ],
   "main": "lib/index.js",
   "description": "Configuration management for the npm cli",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/npm/config"
+    "url": "https://github.com/npm/config.git"
   },
   "author": "GitHub Inc.",
   "license": "ISC",
@@ -19,23 +19,24 @@
     "preversion": "npm test",
     "postversion": "npm publish",
     "prepublishOnly": "git push origin --follow-tags",
-    "lint": "eslint '**/*.js'",
-    "postlint": "npm-template-check",
+    "lint": "eslint \"**/*.js\"",
+    "postlint": "template-oss-check",
     "lintfix": "npm run lint -- --fix",
     "posttest": "npm run lint",
-    "template-copy": "npm-template-copy --force"
+    "template-oss-apply": "template-oss-apply --force"
   },
   "tap": {
     "check-coverage": true,
     "coverage-map": "map.js"
   },
   "devDependencies": {
-    "@npmcli/template-oss": "^2.7.1",
-    "tap": "^15.1.6"
+    "@npmcli/eslint-config": "^3.0.1",
+    "@npmcli/template-oss": "3.2.2",
+    "tap": "^16.0.1"
   },
   "dependencies": {
-    "@npmcli/map-workspaces": "^2.0.0",
-    "ini": "^2.0.0",
+    "@npmcli/map-workspaces": "^2.0.2",
+    "ini": "^3.0.0",
     "mkdirp-infer-owner": "^2.0.0",
     "nopt": "^5.0.0",
     "proc-log": "^2.0.0",
@@ -44,9 +45,10 @@
     "walk-up-path": "^1.0.0"
   },
   "engines": {
-    "node": "^12.13.0 || ^14.15.0 || >=16"
+    "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
   },
   "templateOSS": {
-    "version": "2.7.1"
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
+    "version": "3.2.2"
   }
 }