mirror of
https://github.com/nushell/nushell
synced 2024-12-28 14:03:09 +00:00
1a864ea6f4
- Replaced `start`/`end` with span. - Fixed standard library. - Add `help` option. - Add a couple more errors for invalid record types. Resolve #10914 # Description # User-Facing Changes - **BREAKING CHANGE:** `error make` now takes in `span` instead of `start`/`end`: ```Nushell error make { msg: "Message" label: { text: "Label text" span: (metadata $var).span } } ``` - `error make` now has a `help` argument for custom error help.
296 lines
7.7 KiB
Text
296 lines
7.7 KiB
Text
##################################################################################
|
||
#
|
||
# Assert commands.
|
||
#
|
||
##################################################################################
|
||
|
||
# Universal assert command
|
||
#
|
||
# If the condition is not true, it generates an error.
|
||
#
|
||
# # Example
|
||
#
|
||
# ```nushell
|
||
# >_ assert (3 == 3)
|
||
# >_ assert (42 == 3)
|
||
# Error:
|
||
# × Assertion failed:
|
||
# ╭─[myscript.nu:11:1]
|
||
# 11 │ assert (3 == 3)
|
||
# 12 │ assert (42 == 3)
|
||
# · ───┬────
|
||
# · ╰── It is not true.
|
||
# 13 │
|
||
# ╰────
|
||
# ```
|
||
#
|
||
# The --error-label flag can be used if you want to create a custom assert command:
|
||
# ```
|
||
# def "assert even" [number: int] {
|
||
# assert ($number mod 2 == 0) --error-label {
|
||
# text: $"($number) is not an even number",
|
||
# span: (metadata $number).span,
|
||
# }
|
||
# }
|
||
# ```
|
||
export def main [
|
||
condition: bool, # Condition, which should be true
|
||
message?: string, # Optional error message
|
||
--error-label: record # Label for `error make` if you want to create a custom assert
|
||
] {
|
||
if $condition { return }
|
||
error make {
|
||
msg: ($message | default "Assertion failed."),
|
||
label: ($error_label | default {
|
||
text: "It is not true.",
|
||
span: (metadata $condition).span,
|
||
})
|
||
}
|
||
}
|
||
|
||
|
||
# Negative assertion
|
||
#
|
||
# If the condition is not false, it generates an error.
|
||
#
|
||
# # Examples
|
||
#
|
||
# >_ assert (42 == 3)
|
||
# >_ assert (3 == 3)
|
||
# Error:
|
||
# × Assertion failed:
|
||
# ╭─[myscript.nu:11:1]
|
||
# 11 │ assert (42 == 3)
|
||
# 12 │ assert (3 == 3)
|
||
# · ───┬────
|
||
# · ╰── It is not false.
|
||
# 13 │
|
||
# ╰────
|
||
#
|
||
#
|
||
# The --error-label flag can be used if you want to create a custom assert command:
|
||
# ```
|
||
# def "assert not even" [number: int] {
|
||
# assert not ($number mod 2 == 0) --error-label {
|
||
# span: (metadata $number).span,
|
||
# text: $"($number) is an even number",
|
||
# }
|
||
# }
|
||
# ```
|
||
#
|
||
export def not [
|
||
condition: bool, # Condition, which should be false
|
||
message?: string, # Optional error message
|
||
--error-label: record # Label for `error make` if you want to create a custom assert
|
||
] {
|
||
if $condition {
|
||
let span = (metadata $condition).span
|
||
error make {
|
||
msg: ($message | default "Assertion failed."),
|
||
label: ($error_label | default {
|
||
text: "It is not false.",
|
||
span: $span,
|
||
})
|
||
}
|
||
}
|
||
}
|
||
|
||
# Assert that executing the code generates an error
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert error {|| missing_command} # passes
|
||
# > assert error {|| 12} # fails
|
||
export def error [
|
||
code: closure,
|
||
message?: string
|
||
] {
|
||
let error_raised = (try { do $code; false } catch { true })
|
||
main ($error_raised) $message --error-label {
|
||
span: (metadata $code).span
|
||
text: (
|
||
"There were no error during code execution:\n"
|
||
+ $" (view source $code)"
|
||
)
|
||
}
|
||
}
|
||
|
||
# Assert $left == $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert equal 1 1 # passes
|
||
# > assert equal (0.1 + 0.2) 0.3
|
||
# > assert equal 1 2 # fails
|
||
export def equal [left: any, right: any, message?: string] {
|
||
main ($left == $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
"These are not equal.\n"
|
||
+ $" Left : '($left | to nuon --raw)'\n"
|
||
+ $" Right : '($right | to nuon --raw)'"
|
||
)
|
||
}
|
||
}
|
||
|
||
# Assert $left != $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert not equal 1 2 # passes
|
||
# > assert not equal 1 "apple" # passes
|
||
# > assert not equal 7 7 # fails
|
||
export def "not equal" [left: any, right: any, message?: string] {
|
||
main ($left != $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: $"These are both '($left | to nuon --raw)'."
|
||
}
|
||
}
|
||
|
||
# Assert $left <= $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert less or equal 1 2 # passes
|
||
# > assert less or equal 1 1 # passes
|
||
# > assert less or equal 1 0 # fails
|
||
export def "less or equal" [left: any, right: any, message?: string] {
|
||
main ($left <= $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
"The condition *left <= right* is not satisfied.\n"
|
||
+ $" Left : '($left)'\n"
|
||
+ $" Right : '($right)'"
|
||
)
|
||
}
|
||
}
|
||
|
||
# Assert $left < $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert less 1 2 # passes
|
||
# > assert less 1 1 # fails
|
||
export def less [left: any, right: any, message?: string] {
|
||
main ($left < $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
"The condition *left < right* is not satisfied.\n"
|
||
+ $" Left : '($left)'\n"
|
||
+ $" Right : '($right)'"
|
||
)
|
||
}
|
||
}
|
||
|
||
# Assert $left > $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert greater 2 1 # passes
|
||
# > assert greater 2 2 # fails
|
||
export def greater [left: any, right: any, message?: string] {
|
||
main ($left > $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
"The condition *left > right* is not satisfied.\n"
|
||
+ $" Left : '($left)'\n"
|
||
+ $" Right : '($right)'"
|
||
)
|
||
}
|
||
}
|
||
|
||
# Assert $left >= $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert greater or equal 2 1 # passes
|
||
# > assert greater or equal 2 2 # passes
|
||
# > assert greater or equal 1 2 # fails
|
||
export def "greater or equal" [left: any, right: any, message?: string] {
|
||
main ($left >= $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
"The condition *left < right* is not satisfied.\n"
|
||
+ $" Left : '($left)'\n"
|
||
+ $" Right : '($right)'"
|
||
)
|
||
}
|
||
}
|
||
|
||
alias "core length" = length
|
||
# Assert length of $left is $right
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert length [0, 0] 2 # passes
|
||
# > assert length [0] 3 # fails
|
||
export def length [left: list, right: int, message?: string] {
|
||
main (($left | core length) == $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
"This does not have the correct length:\n"
|
||
+ $" value : ($left | to nuon --raw)\n"
|
||
+ $" length : ($left | core length)\n"
|
||
+ $" expected : ($right)"
|
||
)
|
||
}
|
||
}
|
||
|
||
alias "core str contains" = str contains
|
||
# Assert that ($left | str contains $right)
|
||
#
|
||
# For more documentation see the assert command
|
||
#
|
||
# # Examples
|
||
#
|
||
# > assert str contains "arst" "rs" # passes
|
||
# > assert str contains "arst" "k" # fails
|
||
export def "str contains" [left: string, right: string, message?: string] {
|
||
main ($left | core str contains $right) $message --error-label {
|
||
span: {
|
||
start: (metadata $left).span.start
|
||
end: (metadata $right).span.end
|
||
}
|
||
text: (
|
||
$"This does not contain '($right)'.\n"
|
||
+ $" value: ($left | to nuon --raw)"
|
||
)
|
||
}
|
||
}
|