mirror of https://github.com/nushell/nushell synced 2024-12-28 14:03:09 +00:00

History

Jakub Žádník b8d37a7541 Fix panic in `rotate`; Add safe record creation function (#11718 ) <!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [linking keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. Provide examples and/or screenshots if your changes affect the user experience. --> Fixes https://github.com/nushell/nushell/issues/11716 The problem is in our [record creation API](`0d518bf813/crates/nu-protocol/src/value/record.rs (L33)`) which panics if the numbers of columns and values are different. I added a safe variant that returns a `Result` and used it in the `rotate` command. ## TODO in another PR: Go through all `from_raw_cols_vals_unchecked()` (this includes the `record!` macro which uses the unchecked version) and make sure that either a) it is guaranteed the number of cols and vals is the same, or b) convert the call to `from_raw_cols_vals()` Reason: Nushell should never panic. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > 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. -->		2024-02-03 13:23:16 +02:00
..
assets	REFACTOR: move the 0% commands to `nu-cmd-extra` (#9404 )	2023-07-06 08:31:31 -07:00
src	Fix panic in `rotate`; Add safe record creation function (#11718 )	2024-02-03 13:23:16 +02:00
tests	Clean up tests containing unnecessary `cwd:` tokens (#9692 )	2023-07-17 18:43:51 +02:00
Cargo.toml	update nu-ansi-term to 0.50, lscolors to 0.17, and add the Style attribute to Suggestion (#11635 )	2024-01-24 20:57:15 -08:00
LICENSE	nu-cmd-extra crate infrastructure in place with the Bits command as the model for adding other commands (#9327 )	2023-06-01 10:46:16 -07:00
README.md	add in a Readme for the crate nu-cmd-extra (#9745 )	2023-07-19 21:35:58 -07:00

README.md

nu-cmd-extra

the extra commands are not part of the Nushell binary

The commands in this crate are the extra commands of Nushell. They do not get built for the release and it is the responsibility of the developer to build these commands if they want to use them.

These commands are not going to part of the 1.0 Api; meaning that there is no guarantee longer term that these commands will be around into the future. Of course since they are part of the source tree one could always incorporate them into their own custom release.

How to build the commands in this crate

Step 1 is to read the installation notes for Nushell which is located in our Nushell book.

Once Rust is installed you can then build Nushell with the following command.

cargo build --features=extra

Your Nushell binary which just got built is called nu and will be located here.

nushell/target/debug/nu