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

History

JT 90b65018b6 Require that values that look like numbers parse as numberlike (#8635 ) # Description Require that any value that looks like it might be a number (starts with a digit, or a '-' + digit, or a '+' + digits, or a special form float like `-inf`, `inf`, or `NaN`) must now be treated as a number-like value. Number-like syntax can only parse into number-like values. Number-like values include: durations, ints, floats, ranges, filesizes, binary data, etc. # User-Facing Changes BREAKING CHANGE BREAKING CHANGE BREAKING CHANGE BREAKING CHANGE BREAKING CHANGE BREAKING CHANGE BREAKING CHANGE BREAKING CHANGE Just making sure we see this for release notes 😅 This breaks any and all numberlike values that were treated as strings before. Example, we used to allow `3,` as a bare word. Anything like this would now require quotes or backticks to be treated as a string or bare word, respectively. # 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.		2023-03-28 19:31:38 +13:00
..
README.md	standard library: fix the readme (#8526 )	2023-03-20 17:05:49 +13:00
std.nu	remove `match` from the standard library (#8625 )	2023-03-26 10:57:41 +02:00
test_asserts.nu	Require that values that look like numbers parse as numberlike (#8635 )	2023-03-28 19:31:38 +13:00
test_dirs.nu	make std.nu tests work on mac (#8576 )	2023-03-23 07:08:01 -05:00
test_logger.nu	tweak logging format (#8588 )	2023-03-23 15:59:49 -05:00
test_std.nu	remove `match` from the standard library (#8625 )	2023-03-26 10:57:41 +02:00
tests.nu	stdlib: optimize test search and add better errors (#8626 )	2023-03-26 08:09:26 -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")