mirror of
https://github.com/nushell/nushell.git
synced 2025-04-24 05:08:29 +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>
37 lines
734 B
Plaintext
37 lines
734 B
Plaintext
# std.nu, `used` to load all standard library components
|
|
|
|
# Top-level commands: ellie, repeat, null-device, and "path add"
|
|
export use std/util *
|
|
|
|
# std submodules
|
|
export module std/assert
|
|
export module std/bench
|
|
export module std/dt
|
|
export module std/formats
|
|
export module std/help
|
|
export module std/input
|
|
export module std/iter
|
|
export module std/log
|
|
export module std/math
|
|
export module std/xml
|
|
export module std/config
|
|
export module std/testing
|
|
|
|
# Load main dirs command and all subcommands
|
|
export use std/dirs main
|
|
export module dirs {
|
|
export use std/dirs [
|
|
add
|
|
drop
|
|
next
|
|
prev
|
|
goto
|
|
]
|
|
}
|
|
|
|
# Workaround for #13403 to load export-env blocks from submodules
|
|
export-env {
|
|
use std/log []
|
|
use std/dirs []
|
|
}
|