nushell/crates/nu-std
Antoine Stevan d128c0e02b
stdlib: use the loaded library in tests and update README (#8811)
Should close #8809.

# Description
this PR uses the automatically loaded library from the tests by
replacing `use std.nu ...` with `use std ...`.

the `README` has been updated by
- removing the very deprencated "concrete examples"
- fixing the `use std` and the "run the tests" sections

the `README` can be previewed
[here](https://github.com/amtoine/nushell/blob/refactor/stdlib/use-std-in-tests-and-update-readme/crates/nu-std/README.md)
👍

# User-Facing Changes
```
$nothing
```

# Tests + Formatting
- 🟢 `toolkit test stdlib`

# After Submitting
```
$nothing
```
2023-04-08 07:35:16 -05:00
..
src remove nu_cli crate dependency from nu_std (#8807) 2023-04-08 13:53:43 +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 stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05:00
std.nu stdlib: make the library a standalone crate (#8770) 2023-04-07 22:12:27 +02:00
test_asserts.nu stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05:00
test_dirs.nu stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05:00
test_logger.nu stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05:00
test_std.nu stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05:00
test_xml.nu stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05:00
tests.nu stdlib: use the loaded library in tests and update README (#8811) 2023-04-08 07:35:16 -05: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 -- crates/nu-std/tests.nu

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.