Skip to content

Commit 2af31dd

Browse files
authored
docs: change certfile to cafile (#7947)
cafile is the correct config key Closes: npm/documentation#1337
1 parent e362c6d commit 2af31dd

File tree

4 files changed

+12
-27
lines changed

4 files changed

+12
-27
lines changed

docs/lib/content/configuring-npm/npmrc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ The full list is:
103103
- `username`
104104
- `_password`
105105
- `email`
106-
- `certfile` (path to certificate file)
106+
- `cafile` (path to certificate authority file)
107107
- `keyfile` (path to key file)
108108

109109
In order to scope these values, they must be prefixed by a URI fragment.

tap-snapshots/test/lib/commands/audit.js.test.cjs

-15
Original file line numberDiff line numberDiff line change
@@ -331,21 +331,6 @@ audited 2 packages in xxx
331331
2 packages have verified registry signatures
332332
`
333333

334-
exports[`test/lib/commands/audit.js TAP fallback audit > must match snapshot 1`] = `
335-
# npm audit report
336-
337-
test-dep-a 1.0.0
338-
Severity: high
339-
Test advisory 100 - https://github.com/advisories/GHSA-100
340-
fix available via \`npm audit fix\`
341-
node_modules/test-dep-a
342-
343-
1 high severity vulnerability
344-
345-
To address all issues, run:
346-
npm audit fix
347-
`
348-
349334
exports[`test/lib/commands/audit.js TAP json audit > must match snapshot 1`] = `
350335
{
351336
"auditReportVersion": 2,

tap-snapshots/test/lib/docs.js.test.cjs

+6-6
Original file line numberDiff line numberDiff line change
@@ -1877,9 +1877,9 @@ When set to \`dev\` or \`development\`, this is an alias for \`--include=dev\`.
18771877
* Default: null
18781878
* Type: null or String
18791879
* DEPRECATED: \`key\` and \`cert\` are no longer used for most registry
1880-
operations. Use registry scoped \`keyfile\` and \`certfile\` instead. Example:
1880+
operations. Use registry scoped \`keyfile\` and \`cafile\` instead. Example:
18811881
//other-registry.tld/:keyfile=/path/to/key.pem
1882-
//other-registry.tld/:certfile=/path/to/cert.crt
1882+
//other-registry.tld/:cafile=/path/to/cert.crt
18831883
18841884
A client certificate to pass when accessing the registry. Values should be
18851885
in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with
@@ -1890,8 +1890,8 @@ cert="-----BEGIN CERTIFICATE-----\\nXXXX\\nXXXX\\n-----END CERTIFICATE-----"
18901890
\`\`\`
18911891
18921892
It is _not_ the path to a certificate file, though you can set a
1893-
registry-scoped "certfile" path like
1894-
"//other-registry.tld/:certfile=/path/to/cert.pem".
1893+
registry-scoped "cafile" path like
1894+
"//other-registry.tld/:cafile=/path/to/cert.pem".
18951895
18961896
18971897
@@ -1982,9 +1982,9 @@ Alias for \`--init-version\`
19821982
* Default: null
19831983
* Type: null or String
19841984
* DEPRECATED: \`key\` and \`cert\` are no longer used for most registry
1985-
operations. Use registry scoped \`keyfile\` and \`certfile\` instead. Example:
1985+
operations. Use registry scoped \`keyfile\` and \`cafile\` instead. Example:
19861986
//other-registry.tld/:keyfile=/path/to/key.pem
1987-
//other-registry.tld/:certfile=/path/to/cert.crt
1987+
//other-registry.tld/:cafile=/path/to/cert.crt
19881988
19891989
A client key to pass when accessing the registry. Values should be in PEM
19901990
format with newlines replaced by the string "\\n". For example:

workspaces/config/lib/definitions/definitions.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -397,14 +397,14 @@ const definitions = {
397397
\`\`\`
398398
399399
It is _not_ the path to a certificate file, though you can set a registry-scoped
400-
"certfile" path like "//other-registry.tld/:certfile=/path/to/cert.pem".
400+
"cafile" path like "//other-registry.tld/:cafile=/path/to/cert.pem".
401401
`,
402402
deprecated: `
403403
\`key\` and \`cert\` are no longer used for most registry operations.
404-
Use registry scoped \`keyfile\` and \`certfile\` instead.
404+
Use registry scoped \`keyfile\` and \`cafile\` instead.
405405
Example:
406406
//other-registry.tld/:keyfile=/path/to/key.pem
407-
//other-registry.tld/:certfile=/path/to/cert.crt
407+
//other-registry.tld/:cafile=/path/to/cert.crt
408408
`,
409409
flatten,
410410
}),
@@ -1077,10 +1077,10 @@ const definitions = {
10771077
`,
10781078
deprecated: `
10791079
\`key\` and \`cert\` are no longer used for most registry operations.
1080-
Use registry scoped \`keyfile\` and \`certfile\` instead.
1080+
Use registry scoped \`keyfile\` and \`cafile\` instead.
10811081
Example:
10821082
//other-registry.tld/:keyfile=/path/to/key.pem
1083-
//other-registry.tld/:certfile=/path/to/cert.crt
1083+
//other-registry.tld/:cafile=/path/to/cert.crt
10841084
`,
10851085
flatten,
10861086
}),

0 commit comments

Comments
 (0)