mirror of
https://github.com/nushell/nushell.git
synced 2025-02-16 10:32:29 +01: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>
46 lines
1.2 KiB
Plaintext
46 lines
1.2 KiB
Plaintext
use std/testing *
|
|
use std/assert
|
|
use std/log
|
|
use std/log *
|
|
|
|
@test
|
|
def env_log-ansi [] {
|
|
assert equal (log-ansi).CRITICAL (ansi red_bold)
|
|
assert equal (log-ansi).ERROR (ansi red)
|
|
assert equal (log-ansi).WARNING (ansi yellow)
|
|
assert equal (log-ansi).INFO (ansi default)
|
|
assert equal (log-ansi).DEBUG (ansi default_dimmed)
|
|
}
|
|
|
|
@test
|
|
def env_log-level [] {
|
|
assert equal (log-level).CRITICAL 50
|
|
assert equal (log-level).ERROR 40
|
|
assert equal (log-level).WARNING 30
|
|
assert equal (log-level).INFO 20
|
|
assert equal (log-level).DEBUG 10
|
|
}
|
|
|
|
@test
|
|
def env_log-prefix [] {
|
|
assert equal (log-prefix).CRITICAL "CRT"
|
|
assert equal (log-prefix).ERROR "ERR"
|
|
assert equal (log-prefix).WARNING "WRN"
|
|
assert equal (log-prefix).INFO "INF"
|
|
assert equal (log-prefix).DEBUG "DBG"
|
|
}
|
|
|
|
@test
|
|
def env_log-short-prefix [] {
|
|
assert equal (log-short-prefix).CRITICAL "C"
|
|
assert equal (log-short-prefix).ERROR "E"
|
|
assert equal (log-short-prefix).WARNING "W"
|
|
assert equal (log-short-prefix).INFO "I"
|
|
assert equal (log-short-prefix).DEBUG "D"
|
|
}
|
|
|
|
@test
|
|
def env_log_format [] {
|
|
assert equal $env.NU_LOG_FORMAT $"%ANSI_START%%DATE%|%LEVEL%|%MSG%%ANSI_STOP%"
|
|
}
|