mirror of https://github.com/nushell/nushell.git synced 2024-10-16 23:33:49 +02:00

History

Antoine Stevan d1309a36b2 standard library: fix the readme (#8526 ) # Description as we now want to put all the library in `std.nu` alone, this PR removes the mentions to "creating a separate submodule from `std.nu`" from the `README` of the standard library and adds a few clarifications about the structure of the library. # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```		2023-03-20 17:05:49 +13:00
..
README.md	standard library: fix the readme (#8526 )	2023-03-20 17:05:49 +13:00
std.nu	standard library: add log commands (#8448 )	2023-03-18 08:19:54 -05:00
test_dirs.nu	standard library: use the standard assert and fix test output (#8509 )	2023-03-18 09:23:41 -05:00
test_logger.nu	standard library: add log commands (#8448 )	2023-03-18 08:19:54 -05:00
test_std.nu	Make assert eq, assert ne consistent with ==, != operators (#8473 )	2023-03-18 08:59:27 +13:00
tests.nu	standard library: add log commands (#8448 )	2023-03-18 08:19:54 -05: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

all the commands of the standard_library are located in std.nu
the tests are located in files that have a name starting with "test_", e.g. test_std.nu
a test runner, at tests.nu, allows to run all the tests automatically

🔧 add new commands

add new standard commands by appending to std.nu
add associated tests to test_std.nu or preferably to test_<submodule>.nu.
- define a new exported (!) test_<feature> command
- import the assert functions you need at the top of the functions, e.g. use std.nu "assert eq"

🧪 run the tests

the following call should return no errors

NU_LOG_LEVEL=DEBUG nu /path/to/standard_library/tests.nu

🔍 a concrete example

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