dae4a9b091
Should close on of the points in - https://github.com/nushell/nushell/issues/8813 # Description before this PR, we had a problem ``` cargo run -- -c '{ modules: ((help modules | get name) == (std help modules | get name)) aliases: ((help aliases | get name) == (std help aliases | get name)) externs: ((help externs | get name) == (std help externs | get name)) operators: ((help operators | get name) == (std help operators | get name)) commands: ((help commands | get name) == (std help commands | get name)) }' ``` would give ``` ╭───────────┬───────╮ │ modules │ false │ │ aliases │ true │ │ externs │ true │ │ operators │ false │ │ commands │ true │ ╰───────────┴───────╯ ``` this PR removes the `name` sorting so that the orders are the same between the `std` implementation and the built-in one. > **Note** > run the same `cargo run` command as above and see > ``` > ╭───────────┬──────╮ > │ modules │ true │ > │ aliases │ true │ > │ externs │ true │ > │ operators │ true │ > │ commands │ true │ > ╰───────────┴──────╯ > ``` # User-Facing Changes the operators in `std help ...` will be sorted just as the built-in `help ...`. # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - ⚫ `toolkit test` - ⚫ `toolkit test stdlib` # 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