@npmcli/config 7.2.0 → 8.0.1

package/README.md

@@ -55,20 +55,17 @@ The resulting hierarchy of configs:
 
 ```js
 const Config = require('@npmcli/config')
-// the types of all the configs we know about
-const types = require('./config/types.js')
-// default values for all the configs we know about
-const defaults = require('./config/defaults.js')
-// if you want -c to be short for --call and so on, define it here
-const shorthands = require('./config/shorthands.js')
+const { shorthands, definitions, flatten } = require('@npmcli/config/lib/definitions')
 
 const conf = new Config({
   // path to the npm module being run
   npmPath: resolve(__dirname, '..'),
-  types,
+  definitions,
   shorthands,
-  defaults,
+  flatten,
   // optional, defaults to process.argv
+  // argv: [] <- if you are using this package in your own cli
+  //             and dont want to have colliding argv
   argv: process.argv,
   // optional, defaults to process.env
   env: process.env,

package/lib/definitions/definitions.js

@@ -963,6 +963,7 @@ define('include-workspace-root', {
 
 define('init-author-email', {
   default: '',
+  hint: '<email>',
   type: String,
   description: `
     The value \`npm init\` should use by default for the package author's
@@ -972,6 +973,7 @@ define('init-author-email', {
 
 define('init-author-name', {
   default: '',
+  hint: '<name>',
   type: String,
   description: `
     The value \`npm init\` should use by default for the package author's name.
@@ -981,6 +983,7 @@ define('init-author-name', {
 define('init-author-url', {
   default: '',
   type: ['', url],
+  hint: '<url>',
   description: `
     The value \`npm init\` should use by default for the package author's homepage.
   `,
@@ -988,6 +991,7 @@ define('init-author-url', {
 
 define('init-license', {
   default: 'ISC',
+  hint: '<license>',
   type: String,
   description: `
     The value \`npm init\` should use by default for the package license.
@@ -997,6 +1001,7 @@ define('init-license', {
 define('init-module', {
   default: '~/.npm-init.js',
   type: path,
+  hint: '<module>',
   description: `
     A module that will be loaded by the \`npm init\` command.  See the
     documentation for the
@@ -1008,6 +1013,7 @@ define('init-module', {
 define('init-version', {
   default: '1.0.0',
   type: semver,
+  hint: '<version>',
   description: `
     The value that \`npm init\` should use by default for the package
     version number, if not already set in package.json.
@@ -1207,6 +1213,33 @@ define('local-address', {
   flatten,
 })
 
+define('sbom-format', {
+  default: null,
+  type: [
+    'cyclonedx',
+    'spdx',
+  ],
+  description: `
+    SBOM format to use when generating SBOMs.
+  `,
+  flatten,
+})
+
+define('sbom-type', {
+  default: 'library',
+  type: [
+    'library',
+    'application',
+    'framework',
+  ],
+  description: `
+    The type of package described by the generated SBOM. For SPDX, this is the
+    value for the \`primaryPackagePurpose\` fieled. For CycloneDX, this is the
+    value for the \`type\` field.
+  `,
+  flatten,
+})
+
 define('location', {
   default: 'user',
   short: 'L',

package/lib/index.js

@@ -774,29 +774,29 @@ class Config {
     await chmod(conf.source, mode)
   }
 
-  clearCredentialsByURI (uri) {
+  clearCredentialsByURI (uri, level = 'user') {
     const nerfed = nerfDart(uri)
     const def = nerfDart(this.get('registry'))
     if (def === nerfed) {
-      this.delete(`-authtoken`, 'user')
-      this.delete(`_authToken`, 'user')
-      this.delete(`_authtoken`, 'user')
-      this.delete(`_auth`, 'user')
-      this.delete(`_password`, 'user')
-      this.delete(`username`, 'user')
+      this.delete(`-authtoken`, level)
+      this.delete(`_authToken`, level)
+      this.delete(`_authtoken`, level)
+      this.delete(`_auth`, level)
+      this.delete(`_password`, level)
+      this.delete(`username`, level)
       // de-nerf email if it's nerfed to the default registry
-      const email = this.get(`${nerfed}:email`, 'user')
+      const email = this.get(`${nerfed}:email`, level)
       if (email) {
-        this.set('email', email, 'user')
+        this.set('email', email, level)
       }
     }
-    this.delete(`${nerfed}:_authToken`, 'user')
-    this.delete(`${nerfed}:_auth`, 'user')
-    this.delete(`${nerfed}:_password`, 'user')
-    this.delete(`${nerfed}:username`, 'user')
-    this.delete(`${nerfed}:email`, 'user')
-    this.delete(`${nerfed}:certfile`, 'user')
-    this.delete(`${nerfed}:keyfile`, 'user')
+    this.delete(`${nerfed}:_authToken`, level)
+    this.delete(`${nerfed}:_auth`, level)
+    this.delete(`${nerfed}:_password`, level)
+    this.delete(`${nerfed}:username`, level)
+    this.delete(`${nerfed}:email`, level)
+    this.delete(`${nerfed}:certfile`, level)
+    this.delete(`${nerfed}:keyfile`, level)
   }
 
   setCredentialsByURI (uri, { token, username, password, email, certfile, keyfile }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/config",
-  "version": "7.2.0",
+  "version": "8.0.1",
   "files": [
     "bin/",
     "lib/"
@@ -19,8 +19,8 @@
     "snap": "tap",
     "lint": "eslint \"**/*.js\"",
     "postlint": "template-oss-check",
-    "lintfix": "node ../.. run lint -- --fix",
-    "posttest": "node ../.. run lint",
+    "lintfix": "npm run lint -- --fix",
+    "posttest": "npm run lint",
     "template-oss-apply": "template-oss-apply --force"
   },
   "tap": {
@@ -32,7 +32,7 @@
   "devDependencies": {
     "@npmcli/eslint-config": "^4.0.0",
     "@npmcli/mock-globals": "^1.0.0",
-    "@npmcli/template-oss": "4.18.0",
+    "@npmcli/template-oss": "4.19.0",
     "tap": "^16.3.8"
   },
   "dependencies": {
@@ -46,10 +46,12 @@
     "walk-up-path": "^3.0.1"
   },
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+    "node": "^16.14.0 || >=18.0.0"
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
-    "version": "4.18.0"
+    "version": "4.19.0",
+    "content": "../../scripts/template-oss/index.js",
+    "npm": "npm"
   }
 }