forked from extern/nushell
f9cf1d943c
# Description
## in the `test_dirs` test module
- use the `std assert` function in the `test_dirs` module instead of
`myassert`
- refactor the "test cleaning" in the `clean` command
- allows to clean the tests and then throw a real error in the `catch`
block in case there is an error
- the test still "try"s to `clean` the test directory after the `catch`,
like in a "finally" block
- parse the `catch` error and `error make` a proper one instead of
`debug`ging it => because the `catch` will be triggered as soon as one
error occurs, there will always only be a single error in the tests, so
this does not change the behaviour of failing `dirs` tests!
> **Note**
> i'm not particularly happy with the parsing stage in the `catch`
block.
> however that's the simplest i found to both keep the `try` / `catch`
construct that allows to clean the test directory and have a proper
error at the same time!
## in the global `tests` module
- use `print` instead of `echo` to make sure the log statements show up
during the tests
# User-Facing Changes
```
$nothing
```
# Tests + Formatting
```bash
nu crates/nu-utils/standard_library/tests.nu
```
passes but now with
- proper log statements
- proper error when a `dirs` error occurs => try with `sd 'assert \(1'
"assert (10" crates/nu-utils/standard_library/test_dirs.nu` 😉
# After Submitting
```
$nothing
```
|
||
|---|---|---|
| .. | ||
| README.md | ||
| std.nu | ||
| test_dirs.nu | ||
| test_logger.nu | ||
| test_std.nu | ||
| tests.nu | ||
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
ghqtool to managegitprojectsNote
ghqstores any repository inside$env.GHQ_ROOTunder<host>/<owner>/<repo>/
- the path to my local fork of
nushellis then defined aslet-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
usethe 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, or preferably create a new submodule. - add associated tests to
test_std.nuor preferably totest_<submodule>.nu.- define a new exported (!)
test_<feature>command - import the
assertfunctions you need at the top of the functions, e.g.use std.nu "assert eq"
- define a new exported (!)
🧪 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_LIBdefined as in the example aboveNU_LOG_LEVEL=DEBUG nu ($env.STD_LIB | path join "tests.nu")