76bdda1178
# Description this PR deprecates the `std testing` module in favor of Nupm. the plan is to simply hide the module to the user but still use it internally when running the tests so that - users don't start to use this module and rather focus on Nupm - devs don't have to install anything to run the tests locally, they can just use `toolkit test stdlib` for instance the deprecation message will be very similar to https://github.com/nushell/nushell/pull/11097 > **Note** > to demonstrate that the removal of such a command from the exposed modules of `std` will be transparent and not require the user to install anything, i have it [prepared in a branch based on this PR](https://github.com/amtoine/nushell/compare/deprecate-std-testing...amtoine:nushell:hide-std-testing) > running `toolkit test stdlib` will run the standard library tests without an issue and yet `use std testing` won't work 👌 # User-Facing Changes `std testing run-tests` will be removed in `0.90` # Tests + Formatting # After Submitting |
||
|---|---|---|
| .. | ||
| src | ||
| std | ||
| 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