mirror of
https://github.com/nushell/nushell.git
synced 2024-11-07 17:14:23 +01:00
FEATURE: format std log and add --short option (#9091)
# Description - prettify formatting - move message formatting to a private function - allow short prefixes for loggers via `--short|-s` flag # User-Facing Changes - allow short prefixes for loggers via `--short|-s` flag # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> --------- Co-authored-by: amtoine <stevan.antoine@gmail.com>
This commit is contained in:
Emily Grace Seville
GitHub
parent
fe60fb8679
commit
a2dd948e71
@ -1,52 +1,131 @@
|
||||
export def "log CRITICAL_LEVEL" [] { 50 }
|
||||
export def "log ERROR_LEVEL" [] { 40 }
|
||||
export def "log WARNING_LEVEL" [] { 30 }
|
||||
export def "log INFO_LEVEL" [] { 20 }
|
||||
export def "log DEBUG_LEVEL" [] { 10 }
|
||||
|
||||
export def "log CRITICAL_LEVEL_PREFIX" [] { "CRT" }
|
||||
export def "log ERROR_LEVEL_PREFIX" [] { "ERR" }
|
||||
export def "log WARNING_LEVEL_PREFIX" [] { "WRN" }
|
||||
export def "log INFO_LEVEL_PREFIX" [] { "INF" }
|
||||
export def "log DEBUG_LEVEL_PREFIX" [] { "DBG" }
|
||||
|
||||
def parse-string-level [level: string] {
|
||||
(
|
||||
if ($level in [(log CRITICAL_LEVEL_PREFIX) "CRIT" "CRITICAL"]) {
|
||||
log CRITICAL_LEVEL
|
||||
} else if ($level in [(log ERROR_LEVEL_PREFIX) "ERROR" ]) {
|
||||
log ERROR_LEVEL
|
||||
} else if ($level in [(log WARNING_LEVEL_PREFIX) "WARN" "WARNING"]) {
|
||||
log WARNING_LEVEL
|
||||
} else if ($level in [(log DEBUG_LEVEL_PREFIX) "DEBUG"]) {
|
||||
log DEBUG_LEVEL
|
||||
} else {
|
||||
log INFO_LEVEL
|
||||
}
|
||||
)
|
||||
export def "log CRITICAL_LEVEL" [] {
|
||||
50
|
||||
}
|
||||
|
||||
def parse-int-level [level: int] {
|
||||
(
|
||||
if ($level >= (log CRITICAL_LEVEL)) {
|
||||
export def "log ERROR_LEVEL" [] {
|
||||
40
|
||||
}
|
||||
|
||||
export def "log WARNING_LEVEL" [] {
|
||||
30
|
||||
}
|
||||
|
||||
export def "log INFO_LEVEL" [] {
|
||||
20
|
||||
}
|
||||
|
||||
export def "log DEBUG_LEVEL" [] {
|
||||
10
|
||||
}
|
||||
|
||||
def parse-string-level [
|
||||
level: string
|
||||
] {
|
||||
if $level in [(log CRITICAL_LEVEL_PREFIX) (log CRITICAL_LEVEL_PREFIX --short) "CRIT" "CRITICAL"] {
|
||||
log CRITICAL_LEVEL
|
||||
} else if $level in [(log ERROR_LEVEL_PREFIX) (log ERROR_LEVEL_PREFIX --short) "ERROR" ] {
|
||||
log ERROR_LEVEL
|
||||
} else if $level in [(log WARNING_LEVEL_PREFIX) (log WARNING_LEVEL_PREFIX --short) "WARN" "WARNING"] {
|
||||
log WARNING_LEVEL
|
||||
} else if $level in [(log DEBUG_LEVEL_PREFIX) (log DEBUG_LEVEL_PREFIX --short) "DEBUG"] {
|
||||
log DEBUG_LEVEL
|
||||
} else {
|
||||
log INFO_LEVEL
|
||||
}
|
||||
}
|
||||
|
||||
export def "log CRITICAL_LEVEL_PREFIX" [
|
||||
--short (-s)
|
||||
] {
|
||||
if $short {
|
||||
"C"
|
||||
} else {
|
||||
"CRT"
|
||||
}
|
||||
}
|
||||
|
||||
export def "log ERROR_LEVEL_PREFIX" [
|
||||
--short (-s)
|
||||
] {
|
||||
if $short {
|
||||
"E"
|
||||
} else {
|
||||
"ERR"
|
||||
}
|
||||
}
|
||||
|
||||
export def "log WARNING_LEVEL_PREFIX" [
|
||||
--short (-s)
|
||||
] {
|
||||
if $short {
|
||||
"W"
|
||||
} else {
|
||||
"WRN"
|
||||
}
|
||||
}
|
||||
|
||||
export def "log INFO_LEVEL_PREFIX" [
|
||||
--short (-s)
|
||||
] {
|
||||
if $short {
|
||||
"I"
|
||||
} else {
|
||||
"INF"
|
||||
}
|
||||
}
|
||||
|
||||
export def "log DEBUG_LEVEL_PREFIX" [
|
||||
--short (-s)
|
||||
] {
|
||||
if $short {
|
||||
"D"
|
||||
} else {
|
||||
"DBG"
|
||||
}
|
||||
}
|
||||
|
||||
def parse-int-level [
|
||||
level: int,
|
||||
--short (-s)
|
||||
] {
|
||||
if $level >= (log CRITICAL_LEVEL) {
|
||||
if $short {
|
||||
log CRITICAL_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log CRITICAL_LEVEL_PREFIX
|
||||
} else if ($level >= (log ERROR_LEVEL)) {
|
||||
}
|
||||
} else if $level >= (log ERROR_LEVEL) {
|
||||
if $short {
|
||||
log ERROR_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log ERROR_LEVEL_PREFIX
|
||||
} else if ($level >= (log WARNING_LEVEL)) {
|
||||
}
|
||||
} else if $level >= (log WARNING_LEVEL) {
|
||||
if $short {
|
||||
log WARNING_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log WARNING_LEVEL_PREFIX
|
||||
} else if ($level >= (log INFO_LEVEL)) {
|
||||
}
|
||||
} else if $level >= (log INFO_LEVEL) {
|
||||
if $short {
|
||||
log INFO_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log INFO_LEVEL_PREFIX
|
||||
}
|
||||
} else {
|
||||
if $short {
|
||||
log DEBUG_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log DEBUG_LEVEL_PREFIX
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
def current-log-level [] {
|
||||
let env_level = ($env | get -i NU_LOG_LEVEL | default (log INFO_LEVEL))
|
||||
let env_level = ($env.NU_LOG_LEVEL? | default (log INFO_LEVEL))
|
||||
|
||||
try {
|
||||
($env_level | into int)
|
||||
$env_level | into int
|
||||
} catch {
|
||||
parse-string-level $env_level
|
||||
}
|
||||
@ -56,52 +135,129 @@ def now [] {
|
||||
date now | date format "%Y-%m-%dT%H:%M:%S%.3f"
|
||||
}
|
||||
|
||||
# Log critical message
|
||||
export def "log critical" [message: string] {
|
||||
if (current-log-level) > (log CRITICAL_LEVEL) { return }
|
||||
|
||||
print --stderr $"(ansi red_bold)(log CRITICAL_LEVEL_PREFIX)|(now)|($message)(ansi reset)"
|
||||
}
|
||||
# Log error message
|
||||
export def "log error" [message: string] {
|
||||
if (current-log-level) > (log ERROR_LEVEL) { return }
|
||||
|
||||
print --stderr $"(ansi red)(log ERROR_LEVEL_PREFIX)|(now)|($message)(ansi reset)"
|
||||
}
|
||||
# Log warning message
|
||||
export def "log warning" [message: string] {
|
||||
if (current-log-level) > (log WARNING_LEVEL) { return }
|
||||
|
||||
print --stderr $"(ansi yellow)(log WARNING_LEVEL_PREFIX)|(now)|($message)(ansi reset)"
|
||||
}
|
||||
# Log info message
|
||||
export def "log info" [message: string] {
|
||||
if (current-log-level) > (log INFO_LEVEL) { return }
|
||||
|
||||
print --stderr $"(ansi default)(log INFO_LEVEL_PREFIX)|(now)|($message)(ansi reset)"
|
||||
}
|
||||
# Log debug message
|
||||
export def "log debug" [message: string] {
|
||||
if (current-log-level) > (log DEBUG_LEVEL) { return }
|
||||
|
||||
print --stderr $"(ansi default_dimmed)(log DEBUG_LEVEL_PREFIX)|(now)|($message)(ansi reset)"
|
||||
def log-formatted [
|
||||
color: string,
|
||||
prefix: string,
|
||||
message: string
|
||||
] {
|
||||
print --stderr $"($color)($prefix)|(now)|(ansi u)($message)(ansi reset)"
|
||||
}
|
||||
|
||||
# Log with custom message format and verbosity level
|
||||
# Log a critical message
|
||||
export def "log critical" [
|
||||
message: string, # A message
|
||||
--short (-s) # Whether to use a short prefix
|
||||
] {
|
||||
if (current-log-level) > (log CRITICAL_LEVEL) {
|
||||
return
|
||||
}
|
||||
|
||||
let prefix = if $short {
|
||||
log CRITICAL_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log CRITICAL_LEVEL_PREFIX
|
||||
}
|
||||
log-formatted (ansi red_bold) $prefix $message
|
||||
}
|
||||
|
||||
# Log an error message
|
||||
export def "log error" [
|
||||
message: string, # A message
|
||||
--short (-s) # Whether to use a short prefix
|
||||
] {
|
||||
if (current-log-level) > (log ERROR_LEVEL) {
|
||||
return
|
||||
}
|
||||
|
||||
let prefix = if $short {
|
||||
log ERROR_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log ERROR_LEVEL_PREFIX
|
||||
}
|
||||
log-formatted (ansi red) $prefix $message
|
||||
}
|
||||
|
||||
# Log a warning message
|
||||
export def "log warning" [
|
||||
message: string, # A message
|
||||
--short (-s) # Whether to use a short prefix
|
||||
] {
|
||||
if (current-log-level) > (log WARNING_LEVEL) {
|
||||
return
|
||||
}
|
||||
|
||||
let prefix = if $short {
|
||||
log WARNING_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log WARNING_LEVEL_PREFIX
|
||||
}
|
||||
log-formatted (ansi yellow) $prefix $message
|
||||
}
|
||||
|
||||
# Log an info message
|
||||
export def "log info" [
|
||||
message: string, # A message
|
||||
--short (-s) # Whether to use a short prefix
|
||||
] {
|
||||
if (current-log-level) > (log INFO_LEVEL) {
|
||||
return
|
||||
}
|
||||
|
||||
let prefix = if $short {
|
||||
log INFO_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log INFO_LEVEL_PREFIX
|
||||
}
|
||||
log-formatted (ansi default) $prefix $message
|
||||
}
|
||||
|
||||
# Log a debug message
|
||||
export def "log debug" [
|
||||
message: string, # A message
|
||||
--short (-s) # Whether to use a short prefix
|
||||
] {
|
||||
if (current-log-level) > (log DEBUG_LEVEL) {
|
||||
return
|
||||
}
|
||||
|
||||
let prefix = if $short {
|
||||
log DEBUG_LEVEL_PREFIX --short
|
||||
} else {
|
||||
log DEBUG_LEVEL_PREFIX
|
||||
}
|
||||
log-formatted (ansi default_dimmed) $prefix $message
|
||||
}
|
||||
|
||||
# Log a message with a specific format and verbosity level
|
||||
#
|
||||
# Format reference:
|
||||
# > %MSG% will be replaced by $message
|
||||
# > %DATE% will be replaced by the timestamp of log in standard Nushell's log format: "%Y-%m-%dT%H:%M:%S%.3f"
|
||||
# > %LEVEL% will be replaced by the standard Nushell's log verbosity prefixes, e.g. "CRT"
|
||||
# - %MSG% will be replaced by $message
|
||||
# - %DATE% will be replaced by the timestamp of log in standard Nushell's log format: "%Y-%m-%dT%H:%M:%S%.3f"
|
||||
# - %LEVEL% will be replaced by the standard Nushell's log verbosity prefixes, e.g. "CRT"
|
||||
#
|
||||
# Examples:
|
||||
# > std log custom "my message" $"(ansi yellow)[%LEVEL%]MY MESSAGE: %MSG% [%DATE%](ansi reset)" (std log WARNING_LEVEL)
|
||||
# - std log custom "my message" $"(ansi yellow)[%LEVEL%]MY MESSAGE: %MSG% [%DATE%](ansi reset)" (std log WARNING_LEVEL)
|
||||
export def "log custom" [
|
||||
message: string, # Message inserted into the log template
|
||||
format: string, # A string to be printed into stderr.
|
||||
log_level: int # Log's verbosity level
|
||||
] {
|
||||
if (current-log-level) > ($log_level) { return }
|
||||
message: string, # A message
|
||||
format: string, # A format
|
||||
log_level: int # A log level
|
||||
--short (-s) # Whether to use a short prefix
|
||||
] {
|
||||
if (current-log-level) > ($log_level) {
|
||||
return
|
||||
}
|
||||
|
||||
print --stderr ($format | str replace "%MSG%" $message | str replace "%DATE%" (now) | str replace "%LEVEL%" (parse-int-level $log_level | into string))
|
||||
}
|
||||
let level = ((if $short {
|
||||
parse-int-level $log_level --short
|
||||
} else {
|
||||
parse-int-level $log_level
|
||||
}) | into string)
|
||||
|
||||
print --stderr ([
|
||||
["%MSG%" $message]
|
||||
["%DATE%" (now)]
|
||||
["%LEVEL%" $level]
|
||||
] | reduce --fold $format {
|
||||
|it, acc| $acc | str replace --all $it.0 $it.1
|
||||
})
|
||||
}
|
||||
|
||||
@ -1,69 +1,141 @@
|
||||
use std *
|
||||
|
||||
def run [system_level, message_level] {
|
||||
def run [
|
||||
system_level,
|
||||
message_level
|
||||
--short (-s)
|
||||
] {
|
||||
do {
|
||||
^$nu.current-exe -c $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) "test message"'
|
||||
} | complete | get -i stderr
|
||||
if $short {
|
||||
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) --short "test message"'
|
||||
} else {
|
||||
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) "test message"'
|
||||
}
|
||||
} | complete | get --ignore-errors stderr
|
||||
}
|
||||
def "assert no message" [system_level, message_level] {
|
||||
|
||||
def "assert no message" [
|
||||
system_level,
|
||||
message_level
|
||||
] {
|
||||
let output = (run $system_level $message_level)
|
||||
assert equal "" $output
|
||||
}
|
||||
|
||||
def "assert message" [system_level, message_level, message_level_str] {
|
||||
def "assert message" [
|
||||
system_level,
|
||||
message_level,
|
||||
message_level_str
|
||||
] {
|
||||
let output = (run $system_level $message_level)
|
||||
assert str contains $output $message_level_str
|
||||
assert str contains $output "test message"
|
||||
}
|
||||
|
||||
def "assert message short" [
|
||||
system_level,
|
||||
message_level,
|
||||
message_level_str
|
||||
] {
|
||||
let output = (run --short $system_level $message_level)
|
||||
assert str contains $output $message_level_str
|
||||
assert str contains $output "test message"
|
||||
}
|
||||
|
||||
export def test_critical [] {
|
||||
assert no message 99 critical
|
||||
assert message CRITICAL critical CRT
|
||||
}
|
||||
|
||||
export def test_critical_short [] {
|
||||
assert message short CRITICAL critical C
|
||||
}
|
||||
|
||||
export def test_error [] {
|
||||
assert no message CRITICAL error
|
||||
assert message ERROR error ERR
|
||||
}
|
||||
|
||||
export def test_error_short [] {
|
||||
assert message short ERROR error E
|
||||
}
|
||||
|
||||
export def test_warning [] {
|
||||
assert no message ERROR warning
|
||||
assert message WARNING warning WRN
|
||||
}
|
||||
|
||||
export def test_warning_short [] {
|
||||
assert message short WARNING warning W
|
||||
}
|
||||
|
||||
export def test_info [] {
|
||||
assert no message WARNING info
|
||||
assert message INFO info "INF" #INF has to be quoted, otherwise it is the `inf` float
|
||||
assert message INFO info "INF" # INF has to be quoted, otherwise it is the `inf` float
|
||||
}
|
||||
|
||||
export def test_info_short [] {
|
||||
assert message short INFO info I
|
||||
}
|
||||
|
||||
export def test_debug [] {
|
||||
assert no message INFO debug
|
||||
assert message DEBUG debug DBG
|
||||
}
|
||||
|
||||
export def test_debug_short [] {
|
||||
assert message short DEBUG debug D
|
||||
}
|
||||
|
||||
def "run custom" [system_level, format, message_level] {
|
||||
|
||||
def "run custom" [
|
||||
system_level,
|
||||
format,
|
||||
message_level
|
||||
] {
|
||||
do {
|
||||
^$nu.current-exe -c $'use std; NU_LOG_LEVEL=($system_level) std log custom "test message" "($format)" ($message_level)'
|
||||
} | complete | get -i stderr
|
||||
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log custom "test message" "($format)" ($message_level)'
|
||||
} | complete | get --ignore-errors stderr
|
||||
}
|
||||
|
||||
def "assert custom message" [system_level, format, message_level] {
|
||||
def "assert custom message" [
|
||||
system_level,
|
||||
format,
|
||||
message_level
|
||||
] {
|
||||
let output = (run custom $system_level $format $message_level)
|
||||
assert equal ($output | str trim -r) ($format | str replace "%MSG%" "test message")
|
||||
assert equal ($output | str trim --right) ($format | str replace "%MSG%" "test message")
|
||||
}
|
||||
|
||||
def "assert custom message contains" [system_level, format, message_level, tested_str] {
|
||||
def "assert custom message contains" [
|
||||
system_level,
|
||||
format,
|
||||
message_level,
|
||||
tested_str
|
||||
] {
|
||||
let output = (run custom $system_level $format $message_level)
|
||||
assert ($output | str contains $tested_str)
|
||||
assert ($output | str contains "test message")
|
||||
}
|
||||
|
||||
def "assert custom message not contains" [system_level, format, message_level, tested_str] {
|
||||
def "assert custom message not contains" [
|
||||
system_level,
|
||||
format,
|
||||
message_level,
|
||||
tested_str
|
||||
] {
|
||||
let output = (run custom $system_level $format $message_level)
|
||||
assert (not ($output | str contains $tested_str))
|
||||
assert ($output | str contains "test message")
|
||||
}
|
||||
|
||||
def "assert no custom message" [system_level, format, message_level] {
|
||||
def "assert no custom message" [
|
||||
system_level,
|
||||
format,
|
||||
message_level
|
||||
] {
|
||||
let output = (run custom $system_level $format $message_level)
|
||||
assert equal ($output | str trim -r) ""
|
||||
assert equal ($output | str trim --right) ""
|
||||
}
|
||||
|
||||
export def test_custom [] {
|
||||
@ -73,4 +145,20 @@ export def test_custom [] {
|
||||
|
||||
assert custom message contains (log DEBUG_LEVEL) $"(ansi yellow)[%LEVEL%]MY MESSAGE: %MSG% [%DATE%](ansi reset)" (log WARNING_LEVEL) (log WARNING_LEVEL_PREFIX)
|
||||
assert custom message not contains (log DEBUG_LEVEL) $"(ansi yellow)MY MESSAGE: %MSG% [%DATE%](ansi reset)" (log WARNING_LEVEL) (log WARNING_LEVEL_PREFIX)
|
||||
}
|
||||
}
|
||||
|
||||
export def "test_long_prefixes" [] {
|
||||
assert equal (log CRITICAL_LEVEL_PREFIX) "CRT"
|
||||
assert equal (log ERROR_LEVEL_PREFIX) "ERR"
|
||||
assert equal (log WARNING_LEVEL_PREFIX) "WRN"
|
||||
assert equal (log INFO_LEVEL_PREFIX) "INF"
|
||||
assert equal (log DEBUG_LEVEL_PREFIX) "DBG"
|
||||
}
|
||||
|
||||
export def "test_short_prefixes" [] {
|
||||
assert equal (log CRITICAL_LEVEL_PREFIX --short) "C"
|
||||
assert equal (log ERROR_LEVEL_PREFIX --short) "E"
|
||||
assert equal (log WARNING_LEVEL_PREFIX --short) "W"
|
||||
assert equal (log INFO_LEVEL_PREFIX --short) "I"
|
||||
assert equal (log DEBUG_LEVEL_PREFIX --short) "D"
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user