mirror of
https://github.com/nushell/nushell.git
synced 2025-04-24 13:18:18 +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>
83 lines
1.7 KiB
Plaintext
83 lines
1.7 KiB
Plaintext
use std/testing *
|
|
use std *
|
|
use std/assert
|
|
|
|
@test
|
|
def assert_basic [] {
|
|
assert true
|
|
assert (1 + 2 == 3)
|
|
assert error { assert false }
|
|
assert error { assert (1 + 2 == 4) }
|
|
}
|
|
|
|
@test
|
|
def assert_not [] {
|
|
assert not false
|
|
assert not (1 + 2 == 4)
|
|
assert error { assert not true }
|
|
assert error { assert not (1 + 2 == 3) }
|
|
}
|
|
|
|
@test
|
|
def assert_equal [] {
|
|
assert equal (1 + 2) 3
|
|
assert equal (0.1 + 0.2 | into string | into float) 0.3 # 0.30000000000000004 == 0.3
|
|
assert error { assert equal 1 "foo" }
|
|
assert error { assert equal (1 + 2) 4 }
|
|
}
|
|
|
|
@test
|
|
def assert_not_equal [] {
|
|
assert not equal (1 + 2) 4
|
|
assert not equal 1 "foo"
|
|
assert not equal (1 + 2) "3"
|
|
assert error { assert not equal 1 1 }
|
|
}
|
|
|
|
@test
|
|
def assert_error [] {
|
|
let failing_code = {|| missing_code_to_run}
|
|
assert error $failing_code
|
|
|
|
let good_code = {|| }
|
|
let assert_error_raised = (try { assert error $good_code; false } catch { true })
|
|
assert $assert_error_raised "The assert error should be false if there is no error in the executed code."
|
|
}
|
|
|
|
@test
|
|
def assert_less [] {
|
|
assert less 1 2
|
|
assert error { assert less 1 1 }
|
|
}
|
|
|
|
@test
|
|
def assert_less_or_equal [] {
|
|
assert less or equal 1 2
|
|
assert less or equal 1 1
|
|
assert error { assert less or equal 1 0 }
|
|
}
|
|
|
|
@test
|
|
def assert_greater [] {
|
|
assert greater 2 1
|
|
assert error { assert greater 2 2 }
|
|
}
|
|
|
|
@test
|
|
def assert_greater_or_equal [] {
|
|
assert greater or equal 1 1
|
|
assert greater or equal 2 1
|
|
assert error { assert greater or equal 0 1 }
|
|
}
|
|
|
|
@test
|
|
def assert_length [] {
|
|
assert length [0, 0, 0] 3
|
|
assert error { assert length [0, 0] 3 }
|
|
}
|
|
|
|
@ignore
|
|
def assert_skip [] {
|
|
assert true # This test case is skipped on purpose
|
|
}
|