nushell/crates/nu-std
Máté FARKAS 0bfa769b7d
std: remove logging example (#8877)
The example is is going to be included in the documentation, so I think
we no longer need it here.
See: https://github.com/nushell/nushell.github.io/pull/870
2023-04-14 07:15:56 -05:00
..
lib Move unit test runner to standard library (#8850) 2023-04-13 21:46:37 +02:00
src Move unit test runner to standard library (#8850) 2023-04-13 21:46:37 +02:00
tests Move unit test runner to standard library (#8850) 2023-04-13 21:46:37 +02:00
Cargo.toml remove nu_cli crate dependency from nu_std (#8807) 2023-04-08 13:53:43 +02:00
LICENSE add LICENSE to nu-std (#8803) 2023-04-07 13:39:21 -07:00
README.md Move unit test runner to standard library (#8850) 2023-04-13 21:46:37 +02:00

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][REPL] of nushell or inside some .nu script, you might want to use the use command!

use std

✏️ 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 cargo run -- -c "use std; std run-tests --path crates/nu-std"

Warning


the cargo run -- part of this command is important to ensure the version of nushell and the version of the library are the same.