docs: explain that _auth only goes to npm registry

npm · Apr 21, 2022 · 6cd6831 · 6cd6831
1 parent 392882b
commit 6cd6831
Show file tree

Hide file tree

Showing 5 changed files with 261 additions and 0 deletions.
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
@@ -138,6 +138,8 @@ npm ls --global --parseable --long --loglevel info
 * Type: null or String
 
 A basic-auth string to use when authenticating against the npm registry.
+This will ONLY be used to authenticate against the npm registry. For other
+registries you will need to scope it like "//other-registry.tld/:_auth"
 
 Warning: This should generally not be set via a command-line option. It is
 safer to use a registry-provided authentication bearer token stored in the

diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -147,6 +147,8 @@ define('_auth', {
   type: [null, String],
   description: `
     A basic-auth string to use when authenticating against the npm registry.
+    This will ONLY be used to authenticate against the npm registry.  For other
+    registries you will need to scope it like "//other-registry.tld/:_auth"
 
     Warning: This should generally not be set via a command-line option.  It
     is safer to use a registry-provided authentication bearer token stored in

diff --git a/tap-snapshots/test/lib/commands/publish.js.test.cjs b/tap-snapshots/test/lib/commands/publish.js.test.cjs
@@ -5,6 +5,259 @@
  * Make sure to inspect the output below.  Do not ignore changes!
  */
 'use strict'
+exports[`test/lib/commands/publish.js TAP _auth config default registry > new package version 1`] = `
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP dry-run > must match snapshot 1`] = `
+Array [
+  Array [
+    "",
+  ],
+  Array [
+    "",
+    "package: [email protected]",
+  ],
+  Array [
+    "=== Tarball Contents ===",
+  ],
+  Array [
+    "",
+    "87B package.json",
+  ],
+  Array [
+    "=== Tarball Details ===",
+  ],
+  Array [
+    "",
+    String(
+      name:          test-package                            
+      version:       1.0.0                                   
+      filename:      test-package-1.0.0.tgz                  
+      package size:  160 B                                   
+      unpacked size: 87 B                                    
+      shasum:{sha}
+      integrity:{sha}
+      total files:   1                                       
+    ),
+  ],
+  Array [
+    "",
+    "",
+  ],
+  Array [
+    "",
+    "Publishing to https://registry.npmjs.org/ (dry-run)",
+  ],
+]
+`
+
+exports[`test/lib/commands/publish.js TAP has auth for scope configured registry > new package version 1`] = `
++ @npm/[email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP ignore-scripts > new package version 1`] = `
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP json > must match snapshot 1`] = `
+Array [
+  Array [
+    "",
+    "Publishing to https://registry.npmjs.org/",
+  ],
+]
+`
+
+exports[`test/lib/commands/publish.js TAP json > new package json 1`] = `
+{
+  "id": "[email protected]",
+  "name": "test-package",
+  "version": "1.0.0",
+  "size": 160,
+  "unpackedSize": 87,
+  "shasum": "{sha}",
+  "integrity": "{sha}",
+  "filename": "test-package-1.0.0.tgz",
+  "files": [
+    {
+      "path": "package.json",
+      "size": 87,
+      "mode": 420
+    }
+  ],
+  "entryCount": 1,
+  "bundled": []
+}
+`
+
+exports[`test/lib/commands/publish.js TAP no auth dry-run > must match snapshot 1`] = `
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP no auth dry-run > warns about auth being needed 1`] = `
+Array [
+  Array [
+    "",
+    "This command requires you to be logged in to https://registry.npmjs.org/ (dry-run)",
+  ],
+]
+`
+
+exports[`test/lib/commands/publish.js TAP re-loads publishConfig.registry if added during script process > new package version 1`] = `
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP respects publishConfig.registry, runs appropriate scripts > new package version 1`] = `
+
+`
+
 exports[`test/lib/commands/publish.js TAP scoped _auth config scoped registry > new package version 1`] = `
 + @npm/[email protected]
 `
+
+exports[`test/lib/commands/publish.js TAP tarball > must match snapshot 1`] = `
+Array [
+  Array [
+    "",
+  ],
+  Array [
+    "",
+    "package: [email protected]",
+  ],
+  Array [
+    "=== Tarball Contents ===",
+  ],
+  Array [
+    "",
+    String(
+      26B index.js    
+      98B package.json
+    ),
+  ],
+  Array [
+    "=== Tarball Details ===",
+  ],
+  Array [
+    "",
+    String(
+      name:          test-tar-package                        
+      version:       1.0.0                                   
+      filename:      test-tar-package-1.0.0.tgz              
+      package size:  218 B                                   
+      unpacked size: 124 B                                   
+      shasum:{sha}
+      integrity:{sha}
+      total files:   2                                       
+    ),
+  ],
+  Array [
+    "",
+    "",
+  ],
+  Array [
+    "",
+    "Publishing to https://registry.npmjs.org/",
+  ],
+]
+`
+
+exports[`test/lib/commands/publish.js TAP tarball > new package json 1`] = `
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP workspaces all workspaces - color > all public workspaces 1`] = `
++ [email protected]
++ [email protected]
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP workspaces all workspaces - color > warns about skipped private workspace in color 1`] = `
+Array [
+  Array [
+    "publish",
+    "Skipping workspace \\u001b[32mworkspace-p\\u001b[39m, marked as \\u001b[1mprivate\\u001b[22m",
+  ],
+]
+`
+
+exports[`test/lib/commands/publish.js TAP workspaces all workspaces - no color > all public workspaces 1`] = `
++ [email protected]
++ [email protected]
++ [email protected]
+`
+
+exports[`test/lib/commands/publish.js TAP workspaces all workspaces - no color > warns about skipped private workspace 1`] = `
+Array [
+  Array [
+    "publish",
+    "Skipping workspace workspace-p, marked as private",
+  ],
+]
+`
+
+exports[`test/lib/commands/publish.js TAP workspaces json > all workspaces in json 1`] = `
+{
+  "workspace-a": {
+    "id": "[email protected]",
+    "name": "workspace-a",
+    "version": "1.2.3-a",
+    "size": 162,
+    "unpackedSize": 82,
+    "shasum": "{sha}",
+    "integrity": "{sha}",
+    "filename": "workspace-a-1.2.3-a.tgz",
+    "files": [
+      {
+        "path": "package.json",
+        "size": 82,
+        "mode": 420
+      }
+    ],
+    "entryCount": 1,
+    "bundled": []
+  },
+  "workspace-b": {
+    "id": "[email protected]",
+    "name": "workspace-b",
+    "version": "1.2.3-n",
+    "size": 171,
+    "unpackedSize": 92,
+    "shasum": "{sha}",
+    "integrity": "{sha}",
+    "filename": "workspace-b-1.2.3-n.tgz",
+    "files": [
+      {
+        "path": "package.json",
+        "size": 92,
+        "mode": 420
+      }
+    ],
+    "entryCount": 1,
+    "bundled": []
+  },
+  "workspace-n": {
+    "id": "[email protected]",
+    "name": "workspace-n",
+    "version": "1.2.3-n",
+    "size": 140,
+    "unpackedSize": 42,
+    "shasum": "{sha}",
+    "integrity": "{sha}",
+    "filename": "workspace-n-1.2.3-n.tgz",
+    "files": [
+      {
+        "path": "package.json",
+        "size": 42,
+        "mode": 420
+      }
+    ],
+    "entryCount": 1,
+    "bundled": []
+  }
+}
+`
+
+exports[`test/lib/commands/publish.js TAP workspaces one workspace - success > single workspace 1`] = `
++ [email protected]
+`
diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
@@ -169,6 +169,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for _auth
 * Type: null or String
 
 A basic-auth string to use when authenticating against the npm registry.
+This will ONLY be used to authenticate against the npm registry. For other
+registries you will need to scope it like "//other-registry.tld/:_auth"
 
 Warning: This should generally not be set via a command-line option. It is
 safer to use a registry-provided authentication bearer token stored in the

diff --git a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
@@ -12,6 +12,8 @@ exports[`test/lib/utils/config/describe-all.js TAP > must match snapshot 1`] = `
 * Type: null or String
 
 A basic-auth string to use when authenticating against the npm registry.
+This will ONLY be used to authenticate against the npm registry. For other
+registries you will need to scope it like "//other-registry.tld/:_auth"
 
 Warning: This should generally not be set via a command-line option. It is
 safer to use a registry-provided authentication bearer token stored in the