@npmcli/config 6.2.0 → 7.0.0

package/lib/definitions/index.js

@@ -0,0 +1,73 @@
+const definitions = require('./definitions.js')
+
+// use the defined flattening function, and copy over any scoped
+// registries and registry-specific "nerfdart" configs verbatim
+//
+// TODO: make these getters so that we only have to make dirty
+// the thing that changed, and then flatten the fields that
+// could have changed when a config.set is called.
+//
+// TODO: move nerfdart auth stuff into a nested object that
+// is only passed along to paths that end up calling npm-registry-fetch.
+const flatten = (obj, flat = {}) => {
+  for (const [key, val] of Object.entries(obj)) {
+    const def = definitions[key]
+    if (def && def.flatten) {
+      def.flatten(key, obj, flat)
+    } else if (/@.*:registry$/i.test(key) || /^\/\//.test(key)) {
+      flat[key] = val
+    }
+  }
+
+  // XXX make this the bin/npm-cli.js file explicitly instead
+  // otherwise using npm programmatically is a bit of a pain.
+  flat.npmBin = require.main ? require.main.filename
+    : /* istanbul ignore next - not configurable property */ undefined
+  flat.nodeBin = process.env.NODE || process.execPath
+
+  return flat
+}
+
+const definitionProps = Object.entries(definitions)
+  .reduce((acc, [key, { short = [], default: d }]) => {
+  // can be either an array or string
+    for (const s of [].concat(short)) {
+      acc.shorthands[s] = [`--${key}`]
+    }
+    acc.defaults[key] = d
+    return acc
+  }, { shorthands: {}, defaults: {} })
+
+// aliases where they get expanded into a completely different thing
+// these are NOT supported in the environment or npmrc files, only
+// expanded on the CLI.
+// TODO: when we switch off of nopt, use an arg parser that supports
+// more reasonable aliasing and short opts right in the definitions set.
+const shorthands = {
+  'enjoy-by': ['--before'],
+  d: ['--loglevel', 'info'],
+  dd: ['--loglevel', 'verbose'],
+  ddd: ['--loglevel', 'silly'],
+  quiet: ['--loglevel', 'warn'],
+  q: ['--loglevel', 'warn'],
+  s: ['--loglevel', 'silent'],
+  silent: ['--loglevel', 'silent'],
+  verbose: ['--loglevel', 'verbose'],
+  desc: ['--description'],
+  help: ['--usage'],
+  local: ['--no-global'],
+  n: ['--no-yes'],
+  no: ['--no-yes'],
+  porcelain: ['--parseable'],
+  readonly: ['--read-only'],
+  reg: ['--registry'],
+  iwr: ['--include-workspace-root'],
+  ...definitionProps.shorthands,
+}
+
+module.exports = {
+  defaults: definitionProps.defaults,
+  definitions,
+  flatten,
+  shorthands,
+}

package/lib/errors.js

@@ -4,6 +4,7 @@ class ErrInvalidAuth extends Error {
   constructor (problems) {
     let message = 'Invalid auth configuration found: '
     message += problems.map((problem) => {
+      // istanbul ignore else
       if (problem.action === 'delete') {
         return `\`${problem.key}\` is not allowed in ${problem.where} config`
       } else if (problem.action === 'rename') {

package/lib/index.js

@@ -305,16 +305,22 @@ class Config {
     this.loadGlobalPrefix()
     this.loadHome()
 
-    this.#loadObject({
+    const defaultsObject = {
       ...this.defaults,
       prefix: this.globalPrefix,
-    }, 'default', 'default values')
+    }
 
-    const { data } = this.data.get('default')
+    try {
+      defaultsObject['npm-version'] = require(join(this.npmPath, 'package.json')).version
+    } catch {
+      // in some weird state where the passed in npmPath does not have a package.json
+      // this will never happen in npm, but is guarded here in case this is consumed
+      // in other ways + tests
+    }
 
-    // the metrics-registry defaults to the current resolved value of
-    // the registry, unless overridden somewhere else.
-    settableGetter(data, 'metrics-registry', () => this.#get('registry'))
+    this.#loadObject(defaultsObject, 'default', 'default values')
+
+    const { data } = this.data.get('default')
 
     // if the prefix is set on cli, env, or userconfig, then we need to
     // default the globalconfig file to that location, instead of the default
@@ -446,7 +452,7 @@ class Config {
       nopt.invalidHandler = (k, val, type) =>
         this.invalidHandler(k, val, type, obj.source, where)
 
-      nopt.clean(obj.data, this.types, this.typeDefs)
+      nopt.clean(obj.data, this.types, typeDefs)
 
       nopt.invalidHandler = null
       return obj[_valid]

package/lib/umask.js

@@ -1,5 +1,9 @@
 class Umask {}
 const parse = val => {
+  // this is run via nopt and parse field where everything is
+  // converted to a string first, ignoring coverage for now
+  // instead of figuring out what is happening under the hood in nopt
+  // istanbul ignore else
   if (typeof val === 'string') {
     if (/^0o?[0-7]+$/.test(val)) {
       return parseInt(val.replace(/^0o?/, ''), 8)
@@ -8,15 +12,16 @@ const parse = val => {
     } else {
       throw new Error(`invalid umask value: ${val}`)
     }
+  } else {
+    if (typeof val !== 'number') {
+      throw new Error(`invalid umask value: ${val}`)
+    }
+    val = Math.floor(val)
+    if (val < 0 || val > 511) {
+      throw new Error(`invalid umask value: ${val}`)
+    }
+    return val
   }
-  if (typeof val !== 'number') {
-    throw new Error(`invalid umask value: ${val}`)
-  }
-  val = Math.floor(val)
-  if (val < 0 || val > 511) {
-    throw new Error(`invalid umask value: ${val}`)
-  }
-  return val
 }
 
 const validate = (data, k, val) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/config",
-  "version": "6.2.0",
+  "version": "7.0.0",
   "files": [
     "bin/",
     "lib/"
@@ -24,8 +24,6 @@
     "template-oss-apply": "template-oss-apply --force"
   },
   "tap": {
-    "check-coverage": true,
-    "coverage-map": "map.js",
     "nyc-arg": [
       "--exclude",
       "tap-snapshots/**"
@@ -33,11 +31,13 @@
   },
   "devDependencies": {
     "@npmcli/eslint-config": "^4.0.0",
-    "@npmcli/template-oss": "4.14.1",
+    "@npmcli/mock-globals": "^1.0.0",
+    "@npmcli/template-oss": "4.18.0",
     "tap": "^16.3.4"
   },
   "dependencies": {
     "@npmcli/map-workspaces": "^3.0.2",
+    "ci-info": "^3.8.0",
     "ini": "^4.1.0",
     "nopt": "^7.0.0",
     "proc-log": "^3.0.0",
@@ -50,6 +50,6 @@
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
-    "version": "4.14.1"
+    "version": "4.18.0"
   }
 }