mirror of
https://github.com/nushell/nushell
synced 2024-12-30 15:03:25 +00:00
f723bc6989
# Description Add `xaccess`,`xupdate` and `xinsert` scripts to standard library. They allow accessing and manipulating data in new xml format https://github.com/nushell/nushell/pull/7947 with relative ease. Access some data in nushell xml structure:  Update attributes of xml tags matching a path:  # User-Facing Changes New commands `std xaccess`, `std xupdate` and `std xinsert` # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. |
||
|---|---|---|
| .. | ||
| README.md | ||
| std.nu | ||
| test_asserts.nu | ||
| test_dirs.nu | ||
| test_logger.nu | ||
| test_std.nu | ||
| test_xml.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
- 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.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")