mirror of
https://github.com/nushell/nushell
synced 2024-12-27 05:23:11 +00:00
47f9fd3644
# Description an example should show what happens quite clearly 😋 > **Note** > the ugly spanned errors you'll see below are fixed in https://github.com/nushell/nushell/pull/9039 😌 in all cases we get ``` > std help commands does-not-exist-anywhere Help pages from external command does-not-exist-anywhere: No manual entry for does-not-exist-anywhere Error: × std::help::command_not_found ╭─[help:662:1] 662 │ 663 │ let command = ($command | str join " ") · ─┬─ · ╰── command not found 664 │ ╰──── ``` but ## ❌ before this PR ``` > std help does-not-exist-anywhere Help pages from external command does-not-exist-anywhere: No manual entry for does-not-exist-anywhere ``` without any error, which makes it inconsistent with all the other `std help` commands which give errors when not finding an item 🤔 ## ✔️ with this PR ``` > std help does-not-exist-anywhere Help pages from external command does-not-exist-anywhere: No manual entry for does-not-exist-anywhere Error: × std::help::item_not_found ╭─[help:740:1] 740 │ 741 │ let item = ($item | str join " ") · ─┬─ · ╰── item not found 742 │ ╰──── ``` # User-Facing Changes more consistent errors when using `std help` and `std help commands`, as shown above. # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting ``` $nothing ``` |
||
|---|---|---|
| .. | ||
| lib | ||
| src | ||
| tests | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
Welcome to the standard library of `nushell`!
The standard library is a pure-nushell collection of custom commands which
provide interactive utilities and building blocks for users writing casual scripts or complex applications.
To see what's here:
> use std
> help commands | select name usage | where name =~ "std "
╭────┬─────────────────────────────┬────────────────────────────────────────────────────────────────╮
│ # │ name │ usage │
├────┼─────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ 0 │ std assert │ Universal assert command │
│ 1 │ std assert equal │ Assert $left == $right │
. . .
│ 11 │ std clip │ put the end of a pipe into the system clipboard. │
│ 12 │ std dirs add │ Add one or more directories to the list. │
. . .
├────┼─────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ # │ name │ usage │
╰────┴─────────────────────────────┴────────────────────────────────────────────────────────────────╯
🧰 Using the standard library in the REPL or in scripts
All commands in the standard library must be "imported" into the running environment
(the interactive read-execute-print-loop (REPL) or a .nu script) using the
use command.
You can choose to import the whole module, but then must refer to individual commands with a std prefix, e.g:
use std
std log debug "Running now"
std assert (1 == 2)
Or you can enumerate the specific commands you want to import and invoke them without the std prefix.
use std ["log debug" assert]
log debug "Running again"
assert (2 == 1)
This is probably the form of import you'll want to add to your env.nu for interactive use.
✏️ contribute to the standard library
You're invited to contribute to the standard library! See CONTRIBUTING.md for details