mirror of https://github.com/nushell/nushell.git synced 2024-11-24 17:34:00 +01:00

History

Antoine Stevan d3be5ec750 DOC: make the README of the standard library clearer (#8465 ) Should close #8444. # Description as asked by @presidento, i've used a generic command to run the tests. i've also transformed the "a concrete example" sections into quote blocks to make them stand out less. not sure about that one, please tell me what you think 😋 i think a small example is always helpfull, maybe some work has to be done to make it better 💪 # User-Facing Changes hopefully a slightly clearer README for the standard library # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```		2023-03-15 20:13:09 -07:00
..
dirs.nu	add `dirs` command to std lib (#8368 )	2023-03-11 16:31:09 -06:00
README.md	DOC: make the README of the standard library clearer (#8465 )	2023-03-15 20:13:09 -07:00
std.nu	std.nu: Rewrite assert method (#8405 )	2023-03-15 18:19:38 +01:00
tests.nu	add `dirs` command to std lib (#8368 )	2023-03-11 16:31:09 -06:00

README.md

Welcome to the standard library of `nushell`!

The standard library is a pure-nushell collection of commands to allow anyone to build complex applications using standardized tools gathered incrementally.

In this library, you might find rust-like assert commands to write tests, tools to manipulate paths and strings, etc, etc, ...

🧰 use the standard library in the REPL or in scripts

in order to "import" the standard library to either the interactive REPL of nushell or inside some .nu script, you might want to use the use command!

use /path/to/standard_library/std.nu

🔍 a concrete example

my name is @amtoine and i use the ghq tool to manage git projects

Note

ghq stores any repository inside $env.GHQ_ROOT under <host>/<owner>/<repo>/

the path to my local fork of nushell is then defined as
let-env NUSHELL_REPO = ($env.GHQ_ROOT | path join "github.com" "amtoine" "nushell")
and the full path to the standard library is defined as
let-env STD_LIB = ($env.NUSHELL_REPO | path join "crates" "nu-utils" "standard_library")
see the content of $env.STD_LIB 😋
>_ ls $env.STD_LIB | get name | str replace $env.STD_LIB "" | str trim -l -c "/"
╭───┬───────────╮
│ 0 │ README.md │
│ 1 │ std.nu    │
│ 2 │ tests.nu  │
╰───┴───────────╯
finally we can use the standard library and have access to the commands it exposes 👍
>_ use std.nu
>_ help std
Module: std

Exported commands:
  assert (std assert), assert eq (std assert eq), assert ne (std assert ne), match (std match)

This module does not export environment.

✏️ contribute to the standard library

🔧 add new commands

add new standard commands to std.nu
add associated tests to tests.nu
- define a new test_<feature> before the main
- import the assert functions you need at the top of the functions, e.g. use std.nu "assert eq"
- add a call to test_<feature> at the bottom of the main

🧪 run the tests

the following call should return no errors

nu /path/to/standard_library/tests.nu

🔍 a concrete example

with STD_LIB defined as in the example above
nu ($env.STD_LIB | path join "tests.nu")