forked from extern/nushell
df15fc24fe
# Description
I have (hopefully) simplified the `log.nu` internal structure and added
customizable log format for all `log` commands
# User-Facing Changes
- [x] Replaced constants with env records for:
- ansi (newly added)
- log level
- prefix
- short prefix
- [x] Added `format` argument to all log commands
- [x] Assertions for (not) equality (equal, not equal, greater,
lesser...) now put left and right values inside `'` quotes, so the
assertions for strings are more meaningful
- [x] Documented the %-formatting of log messages
# 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>
303 lines
8.1 KiB
Plaintext
303 lines
8.1 KiB
Plaintext
export-env {
|
|
let-env LOG_ANSI = {
|
|
"CRITICAL": (ansi red_bold),
|
|
"ERROR": (ansi red),
|
|
"WARNING": (ansi yellow),
|
|
"INFO": (ansi default),
|
|
"DEBUG": (ansi default_dimmed)
|
|
}
|
|
|
|
let-env LOG_LEVEL = {
|
|
"CRITICAL": 50,
|
|
"ERROR": 40,
|
|
"WARNING": 30,
|
|
"INFO": 20,
|
|
"DEBUG": 10
|
|
}
|
|
|
|
let-env LOG_PREFIX = {
|
|
"CRITICAL": "CRT",
|
|
"ERROR": "ERR",
|
|
"WARNING": "WRN",
|
|
"INFO": "INF",
|
|
"DEBUG": "DBG"
|
|
}
|
|
|
|
let-env LOG_SHORT_PREFIX = {
|
|
"CRITICAL": "C",
|
|
"ERROR": "E",
|
|
"WARNING": "W",
|
|
"INFO": "I",
|
|
"DEBUG": "D"
|
|
}
|
|
|
|
let-env LOG_FORMAT = $"%ANSI_START%%DATE%|%LEVEL%|(ansi u)%MSG%%ANSI_STOP%"
|
|
}
|
|
|
|
def log-types [] {
|
|
(
|
|
{
|
|
"CRITICAL": {
|
|
"ansi": $env.LOG_ANSI.CRITICAL,
|
|
"level": $env.LOG_LEVEL.CRITICAL,
|
|
"prefix": $env.LOG_PREFIX.CRITICAL,
|
|
"short_prefix": $env.LOG_SHORT_PREFIX.CRITICAL
|
|
},
|
|
"ERROR": {
|
|
"ansi": $env.LOG_ANSI.ERROR,
|
|
"level": $env.LOG_LEVEL.ERROR,
|
|
"prefix": $env.LOG_PREFIX.ERROR,
|
|
"short_prefix": $env.LOG_SHORT_PREFIX.ERROR
|
|
},
|
|
"WARNING": {
|
|
"ansi": $env.LOG_ANSI.WARNING,
|
|
"level": $env.LOG_LEVEL.WARNING,
|
|
"prefix": $env.LOG_PREFIX.WARNING,
|
|
"short_prefix": $env.LOG_SHORT_PREFIX.WARNING
|
|
},
|
|
"INFO": {
|
|
"ansi": $env.LOG_ANSI.INFO,
|
|
"level": $env.LOG_LEVEL.INFO,
|
|
"prefix": $env.LOG_PREFIX.INFO,
|
|
"short_prefix": $env.LOG_SHORT_PREFIX.INFO
|
|
},
|
|
"DEBUG": {
|
|
"ansi": $env.LOG_ANSI.DEBUG,
|
|
"level": $env.LOG_LEVEL.DEBUG,
|
|
"prefix": $env.LOG_PREFIX.DEBUG,
|
|
"short_prefix": $env.LOG_SHORT_PREFIX.DEBUG
|
|
}
|
|
}
|
|
)
|
|
}
|
|
|
|
|
|
def parse-string-level [
|
|
level: string
|
|
] {
|
|
let level = ($level | str upcase)
|
|
|
|
if $level in [$env.LOG_PREFIX.CRITICAL $env.LOG_SHORT_PREFIX.CRITICAL "CRIT" "CRITICAL"] {
|
|
$env.LOG_LEVEL.CRITICAL
|
|
} else if $level in [$env.LOG_PREFIX.ERROR $env.LOG_SHORT_PREFIX.ERROR "ERROR"] {
|
|
$env.LOG_LEVEL.ERROR
|
|
} else if $level in [$env.LOG_PREFIX.WARNING $env.LOG_SHORT_PREFIX.WARNING "WARN" "WARNING"] {
|
|
$env.LOG_LEVEL.WARNING
|
|
} else if $level in [$env.LOG_PREFIX.DEBUG $env.LOG_SHORT_PREFIX.DEBUG "DEBUG"] {
|
|
$env.LOG_LEVEL.DEBUG
|
|
} else {
|
|
$env.LOG_LEVEL.INFO
|
|
}
|
|
}
|
|
|
|
|
|
def parse-int-level [
|
|
level: int,
|
|
--short (-s)
|
|
] {
|
|
if $level >= $env.LOG_LEVEL.CRITICAL {
|
|
if $short {
|
|
$env.LOG_SHORT_PREFIX.CRITICAL
|
|
} else {
|
|
$env.LOG_PREFIX.CRITICAL
|
|
}
|
|
} else if $level >= $env.LOG_LEVEL.ERROR {
|
|
if $short {
|
|
$env.LOG_SHORT_PREFIX.ERROR
|
|
} else {
|
|
$env.LOG_PREFIX.ERROR
|
|
}
|
|
} else if $level >= $env.LOG_LEVEL.WARNING {
|
|
if $short {
|
|
$env.LOG_SHORT_PREFIX.WARNING
|
|
} else {
|
|
$env.LOG_PREFIX.WARNING
|
|
}
|
|
} else if $level >= $env.LOG_LEVEL.INFO {
|
|
if $short {
|
|
$env.LOG_SHORT_PREFIX.INFO
|
|
} else {
|
|
$env.LOG_PREFIX.INFO
|
|
}
|
|
} else {
|
|
if $short {
|
|
$env.LOG_SHORT_PREFIX.DEBUG
|
|
} else {
|
|
$env.LOG_PREFIX.DEBUG
|
|
}
|
|
}
|
|
}
|
|
|
|
def current-log-level [] {
|
|
let env_level = ($env.NU_LOG_LEVEL? | default ($env.LOG_LEVEL.INFO))
|
|
|
|
try {
|
|
$env_level | into int
|
|
} catch {
|
|
parse-string-level $env_level
|
|
}
|
|
}
|
|
|
|
def now [] {
|
|
date now | date format "%Y-%m-%dT%H:%M:%S%.3f"
|
|
}
|
|
|
|
def handle-log [
|
|
message: string,
|
|
formatting: record,
|
|
format_string: string,
|
|
short: bool
|
|
] {
|
|
let log_format = if ($format_string | is-empty) {
|
|
$env.LOG_FORMAT
|
|
} else {
|
|
$format_string
|
|
}
|
|
|
|
let prefix = if $short {
|
|
$formatting.short_prefix
|
|
} else {
|
|
$formatting.prefix
|
|
}
|
|
|
|
custom $message $log_format $formatting.level --level-prefix $prefix --ansi $formatting.ansi
|
|
}
|
|
|
|
# Logging module
|
|
#
|
|
# Log formatting placeholders:
|
|
# - %MSG%: message to be logged
|
|
# - %DATE%: date of log
|
|
# - %LEVEL%: string prefix for the log level
|
|
# - %ANSI_START%: ansi formatting
|
|
# - %ANSI_STOP%: literally (ansi reset)
|
|
#
|
|
# Note: All placeholders are optional, so "" is still a valid format
|
|
#
|
|
# Example: $"%ANSI_START%%DATE%|%LEVEL%|(ansi u)%MSG%%ANSI_STOP%"
|
|
export def main [] {}
|
|
|
|
# Log a critical message
|
|
export def critical [
|
|
message: string, # A message
|
|
--short (-s) # Whether to use a short prefix
|
|
--format (-f): string # A format (for further reference: help std log)
|
|
] {
|
|
handle-log $message (log-types | get CRITICAL) $format $short
|
|
}
|
|
|
|
# Log an error message
|
|
export def error [
|
|
message: string, # A message
|
|
--short (-s) # Whether to use a short prefix
|
|
--format (-f): string # A format (for further reference: help std log)
|
|
] {
|
|
handle-log $message (log-types | get ERROR) $format $short
|
|
}
|
|
|
|
# Log a warning message
|
|
export def warning [
|
|
message: string, # A message
|
|
--short (-s) # Whether to use a short prefix
|
|
--format (-f): string # A format (for further reference: help std log)
|
|
] {
|
|
handle-log $message (log-types | get WARNING) $format $short
|
|
}
|
|
|
|
# Log an info message
|
|
export def info [
|
|
message: string, # A message
|
|
--short (-s) # Whether to use a short prefix
|
|
--format (-f): string # A format (for further reference: help std log)
|
|
] {
|
|
handle-log $message (log-types | get INFO) $format $short
|
|
}
|
|
|
|
# Log a debug message
|
|
export def debug [
|
|
message: string, # A message
|
|
--short (-s) # Whether to use a short prefix
|
|
--format (-f): string # A format (for further reference: help std log)
|
|
] {
|
|
handle-log $message (log-types | get DEBUG) $format $short
|
|
}
|
|
|
|
def log-level-deduction-error [
|
|
type: string
|
|
span: record<start: int, end: int>
|
|
log_level: int
|
|
] {
|
|
error make {
|
|
msg: $"(ansi red_bold)Cannot deduce ($type) for given log level: ($log_level).(ansi reset)"
|
|
label: {
|
|
text: ([
|
|
"Invalid log level."
|
|
$" Available log levels in $env.LOG_LEVEL:"
|
|
($env.LOG_LEVEL | to text | lines | each {|it| $" ($it)" } | to text)
|
|
] | str join "\n")
|
|
start: $span.start
|
|
end: $span.end
|
|
}
|
|
}
|
|
}
|
|
|
|
# Log a message with a specific format and verbosity level, with either configurable or auto-deduced %LEVEL% and %ANSI_START% placeholder extensions
|
|
export def custom [
|
|
message: string, # A message
|
|
format: string, # A format (for further reference: help std log)
|
|
log_level: int # A log level (has to be one of the $env.LOG_LEVEL values for correct ansi/prefix deduction)
|
|
--level-prefix (-p): string # %LEVEL% placeholder extension
|
|
--ansi (-a): string # %ANSI_START% placeholder extension
|
|
] {
|
|
if (current-log-level) > ($log_level) {
|
|
return
|
|
}
|
|
|
|
let valid_levels_for_defaulting = [
|
|
$env.LOG_LEVEL.CRITICAL
|
|
$env.LOG_LEVEL.ERROR
|
|
$env.LOG_LEVEL.WARNING
|
|
$env.LOG_LEVEL.INFO
|
|
$env.LOG_LEVEL.DEBUG
|
|
]
|
|
|
|
let prefix = if ($level_prefix | is-empty) {
|
|
if ($log_level not-in $valid_levels_for_defaulting) {
|
|
log-level-deduction-error "log level prefix" (metadata $log_level).span $log_level
|
|
}
|
|
|
|
parse-int-level $log_level
|
|
|
|
} else {
|
|
$level_prefix
|
|
}
|
|
|
|
let ansi = if ($ansi | is-empty) {
|
|
if ($log_level not-in $valid_levels_for_defaulting) {
|
|
log-level-deduction-error "ansi" (metadata $log_level).span $log_level
|
|
}
|
|
|
|
(
|
|
log-types
|
|
| values
|
|
| each {|record|
|
|
if ($record.level == $log_level) {
|
|
$record.ansi
|
|
}
|
|
} | first
|
|
)
|
|
} else {
|
|
$ansi
|
|
}
|
|
|
|
print --stderr ([
|
|
["%MSG%" $message]
|
|
["%DATE%" (now)]
|
|
["%LEVEL%" $prefix]
|
|
["%ANSI_START%" $ansi]
|
|
["%ANSI_STOP%" (ansi reset)]
|
|
] | reduce --fold $format {
|
|
|it, acc| $acc | str replace --all $it.0 $it.1
|
|
})
|
|
}
|