d42c2b2dbc
## Description just a little refactor of `CONTRIBUTING.md` of the standard library in `nu-std`. - see the new version [here](https://github.com/amtoine/nushell/blob/stblib/refactor/CONTRIBUTING-guidelines/crates/nu-std/CONTRIBUTING.md). > **Note** > actually, that one might be best reviewed commit by commit 😋 > i tried to be as explicit as possible 😌 - i fixed the width to `80` columns - cc/ @bobhy, if you want to jump in and find broken links / bad changes |
||
|---|---|---|
| .. | ||
| 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