mirror of
https://github.com/nushell/nushell
synced 2024-12-29 14:33:13 +00:00
155de9f6fc
# Description - Log levels are now exported members of `std log`, e.g. `std log CRITICAL_LEVEL` - Added `std log custom` command that allows to declare custom message format (actual message replaces `%MSG%` in the template) with user-defined log level. # User-Facing Changes New possibilities included in description # 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. -->
107 lines
No EOL
3.6 KiB
Text
107 lines
No EOL
3.6 KiB
Text
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
|
|
}
|
|
)
|
|
}
|
|
|
|
def parse-int-level [level: int] {
|
|
(
|
|
if ($level >= (log CRITICAL_LEVEL)) {
|
|
log CRITICAL_LEVEL_PREFIX
|
|
} else if ($level >= (log ERROR_LEVEL)) {
|
|
log ERROR_LEVEL_PREFIX
|
|
} else if ($level >= (log WARNING_LEVEL)) {
|
|
log WARNING_LEVEL_PREFIX
|
|
} else if ($level >= (log INFO_LEVEL)) {
|
|
log INFO_LEVEL_PREFIX
|
|
} else {
|
|
log DEBUG_LEVEL_PREFIX
|
|
}
|
|
)
|
|
}
|
|
|
|
def current-log-level [] {
|
|
let env_level = ($env | get -i NU_LOG_LEVEL | default (log INFO_LEVEL))
|
|
|
|
try {
|
|
($env_level | into int)
|
|
} catch {
|
|
parse-string-level $env_level
|
|
}
|
|
}
|
|
|
|
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)"
|
|
}
|
|
|
|
# Log with custom message 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"
|
|
#
|
|
# Examples:
|
|
# > 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 }
|
|
|
|
print --stderr ($format | str replace "%MSG%" $message | str replace "%DATE%" (now) | str replace "%LEVEL%" (parse-int-level $log_level | into string))
|
|
} |