extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-06-30 06:30:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor the CONTRIBUTING.md guidelines for nu-std (#8912)

Browse Source 
## 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
This commit is contained in:
Antoine Stevan
2023-04-19 22:21:27 +02:00
committed by GitHub
parent ed64a44b82
commit d42c2b2dbc
2 changed files with 189 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
crates/nu-std/README.md
View File

@ -3,15 +3,16 @@
<img src="https://media.giphy.com/media/hvRJCLFzcasrR4ia7z/giphy.gif" width="28"></img>
</h1>
The standard library is a pure-`nushell` collection of custom commands which
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 "
> 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 │
. . .
@ -24,27 +25,27 @@ To see what's here:
```
## :toolbox: Using the standard library in the REPL or in scripts
All commands in the standard library must be "imported" into the running environment
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`](https://nushell.sh/commands/docs/use.html) command.
You can choose to import the whole module, but then must refer to individual commands with a `std` prefix, e.g:
```
```nushell
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.
```
```nushell
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.
## :pencil2: contribute to the standard library
You're invited to contribute to the standard library!
See [CONTRIBUTING.md]([./CONTRIBUTING.md](https://github.com/nushell/nushell/blob/main/crates/nu-std/CONTRIBUTING.md))
for details
You're invited to contribute to the standard library! See [CONTRIBUTING.md] for details
[CONTRIBUTING.md]: https://github.com/nushell/nushell/blob/main/crates/nu-std/CONTRIBUTING.md