mirror of
https://github.com/nushell/nushell.git
synced 2025-04-24 21:28:20 +02:00
442df9e39c
# Description
Add custom command attributes.
- Attributes are placed before a command definition and start with a `@`
character.
- Attribute invocations consist of const command call. The command's
name must start with "attr ", but this prefix is not used in the
invocation.
- A command named `attr example` is invoked as an attribute as
`@example`
- Several built-in attribute commands are provided as part of this PR
- `attr example`: Attaches an example to the commands help text
```nushell
# Double numbers
@example "double an int" { 5 | double } --result 10
@example "double a float" { 0.5 | double } --result 1.0
def double []: [number -> number] {
$in * 2
}
```
- `attr search-terms`: Adds search terms to a command
- ~`attr env`: Equivalent to using `def --env`~
- ~`attr wrapped`: Equivalent to using `def --wrapped`~ shelved for
later discussion
- several testing related attributes in `std/testing`
- If an attribute has no internal/special purpose, it's stored as
command metadata that can be obtained with `scope commands`.
- This allows having attributes like `@test` which can be used by test
runners.
- Used the `@example` attribute for `std` examples.
- Updated the std tests and test runner to use `@test` attributes
- Added completions for attributes
# User-Facing Changes
Users can add examples to their own command definitions, and add other
arbitrary attributes.
# Tests + Formatting
- 🟢 toolkit fmt
- 🟢 toolkit clippy
- 🟢 toolkit test
- 🟢 toolkit test stdlib
# After Submitting
- Add documentation about the attribute syntax and built-in attributes
- `help attributes`
---------
Co-authored-by: 132ikl <132@ikl.sh>
99 lines
2.0 KiB
Plaintext
99 lines
2.0 KiB
Plaintext
use std/testing *
|
|
use std/assert
|
|
|
|
def run [
|
|
system_level,
|
|
message_level
|
|
--short
|
|
] {
|
|
if $short {
|
|
^$nu.current-exe --no-config-file --commands $'use std; use std/log; NU_LOG_LEVEL=($system_level) log ($message_level) --short "test message"'
|
|
} else {
|
|
^$nu.current-exe --no-config-file --commands $'use std; use std/log; NU_LOG_LEVEL=($system_level) log ($message_level) "test message"'
|
|
}
|
|
| complete | get --ignore-errors stderr
|
|
}
|
|
|
|
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
|
|
] {
|
|
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"
|
|
}
|
|
|
|
@test
|
|
def critical [] {
|
|
assert no message 99 critical
|
|
assert message CRITICAL critical CRT
|
|
}
|
|
|
|
@test
|
|
def critical_short [] {
|
|
assert message short CRITICAL critical C
|
|
}
|
|
|
|
@test
|
|
def error [] {
|
|
assert no message CRITICAL error
|
|
assert message ERROR error ERR
|
|
}
|
|
|
|
@test
|
|
def error_short [] {
|
|
assert message short ERROR error E
|
|
}
|
|
|
|
@test
|
|
def warning [] {
|
|
assert no message ERROR warning
|
|
assert message WARNING warning WRN
|
|
}
|
|
|
|
@test
|
|
def warning_short [] {
|
|
assert message short WARNING warning W
|
|
}
|
|
|
|
@test
|
|
def info [] {
|
|
assert no message WARNING info
|
|
assert message INFO info "INF" # INF has to be quoted, otherwise it is the `inf` float
|
|
}
|
|
|
|
@test
|
|
def info_short [] {
|
|
assert message short INFO info I
|
|
}
|
|
|
|
@test
|
|
def debug [] {
|
|
assert no message INFO debug
|
|
assert message DEBUG debug DBG
|
|
}
|
|
|
|
@test
|
|
def debug_short [] {
|
|
assert message short DEBUG debug D
|
|
}
|