diff options
author | Luke Karrys <luke@lukekarrys.com> | 2021-12-03 00:17:38 +0300 |
---|---|---|
committer | Luke Karrys <luke@lukekarrys.com> | 2021-12-03 00:32:28 +0300 |
commit | cbae0fb71cea55004f7066c0dfc870137b53ee8b (patch) | |
tree | 6d2d36a0bdb8f9ed8a3e8b7a776804755d1f400e | |
parent | 31b098ee26ed17facb132278bb3205e80e2a760d (diff) |
docs: update description about where/when debug log is written
PR-URL: https://github.com/npm/cli/pull/4114
Credit: @lukekarrys
Close: #4114
Reviewed-by: @wraithgar
-rw-r--r-- | docs/content/using-npm/config.md | 4 | ||||
-rw-r--r-- | lib/utils/config/definitions.js | 4 | ||||
-rw-r--r-- | tap-snapshots/test/lib/utils/config/definitions.js.test.cjs | 4 | ||||
-rw-r--r-- | tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs | 4 |
4 files changed, 8 insertions, 8 deletions
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md index a7678b18d..fe197e344 100644 --- a/docs/content/using-npm/config.md +++ b/docs/content/using-npm/config.md @@ -1014,8 +1014,8 @@ Ideal if all users are on npm version 7 and higher. * Type: "silent", "error", "warn", "notice", "http", "timing", "info", "verbose", or "silly" -What level of logs to report. On failure, *all* logs are written to -`npm-debug.log` in the current working directory. +What level of logs to report. All logs are written to a debug log, with the +path to that file printed if the execution of a command fails. Any logs of a higher level than the setting are shown. The default is "notice". diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js index 181406918..ac8a4e2f6 100644 --- a/lib/utils/config/definitions.js +++ b/lib/utils/config/definitions.js @@ -1214,8 +1214,8 @@ define('loglevel', { 'silly', ], description: ` - What level of logs to report. On failure, *all* logs are written to - \`npm-debug.log\` in the current working directory. + What level of logs to report. All logs are written to a debug log, + with the path to that file printed if the execution of a command fails. Any logs of a higher level than the setting are shown. The default is "notice". diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs index 069c8ec4f..84bb22ff0 100644 --- a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs +++ b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs @@ -1087,8 +1087,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for logle * Type: "silent", "error", "warn", "notice", "http", "timing", "info", "verbose", or "silly" -What level of logs to report. On failure, *all* logs are written to -\`npm-debug.log\` in the current working directory. +What level of logs to report. All logs are written to a debug log, with the +path to that file printed if the execution of a command fails. Any logs of a higher level than the setting are shown. The default is "notice". 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 index 80d95f971..3db90f767 100644 --- a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs +++ b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs @@ -888,8 +888,8 @@ Ideal if all users are on npm version 7 and higher. * Type: "silent", "error", "warn", "notice", "http", "timing", "info", "verbose", or "silly" -What level of logs to report. On failure, *all* logs are written to -\`npm-debug.log\` in the current working directory. +What level of logs to report. All logs are written to a debug log, with the +path to that file printed if the execution of a command fails. Any logs of a higher level than the setting are shown. The default is "notice". |