mirror of
https://github.com/nushell/nushell.git
synced 2025-05-01 16:44:27 +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>
46 lines
1.7 KiB
Plaintext
46 lines
1.7 KiB
Plaintext
use std/testing *
|
|
use std/assert
|
|
use std/dt *
|
|
|
|
@test
|
|
def equal_times [] {
|
|
let t1 = (date now)
|
|
assert equal (datetime-diff $t1 $t1) ({year:0, month:0, day:0, hour:0, minute:0, second:0, millisecond:0, microsecond:0 nanosecond:0})
|
|
}
|
|
|
|
@test
|
|
def one_ns_later [] {
|
|
let t1 = (date now)
|
|
assert equal (datetime-diff ($t1 + 1ns) $t1) ({year:0, month:0, day:0, hour:0, minute:0, second:0, millisecond:0, microsecond:0 nanosecond:1})
|
|
}
|
|
|
|
@test
|
|
def one_yr_later [] {
|
|
let t1 = ('2022-10-1T0:1:2z' | into datetime) # a date for which one year later is 365 days, since duration doesn't support year or month
|
|
assert equal (datetime-diff ($t1 + 365day) $t1) ({year:1, month:0, day:0, hour:0, minute:0, second:0, millisecond:0, microsecond:0 nanosecond:0})
|
|
}
|
|
|
|
@test
|
|
def carry_ripples [] {
|
|
let t1 = ('2023-10-9T0:0:0z' | into datetime)
|
|
let t2 = ('2022-10-9T0:0:0.000000001z' | into datetime)
|
|
assert equal (datetime-diff $t1 $t2) ({year:0, month:11, day:30, hour:23, minute:59, second:59, millisecond:999, microsecond:999 nanosecond:999})
|
|
}
|
|
|
|
@test
|
|
def earlier_arg_must_be_less_or_equal_later [] {
|
|
let t1 = ('2022-10-9T0:0:0.000000001z' | into datetime)
|
|
let t2 = ('2023-10-9T0:0:0z' | into datetime)
|
|
assert error {|| (datetime-diff $t1 $t2)}
|
|
}
|
|
|
|
@test
|
|
def pp_skips_zeros [] {
|
|
assert equal (pretty-print-duration {year:1, month:0, day:0, hour:0, minute:0, second:0, millisecond:0, microsecond:0 nanosecond:0}) "1yr "
|
|
}
|
|
|
|
@test
|
|
def pp_doesnt_skip_neg [] { # datetime-diff can't return negative units, but prettyprint shouldn't skip them (if passed handcrafted record)
|
|
assert equal (pretty-print-duration {year:-1, month:0, day:0, hour:0, minute:0, second:0, millisecond:0, microsecond:0 nanosecond:0}) "-1yr "
|
|
}
|