mirror of https://github.com/nushell/nushell.git synced 2024-11-08 09:34:30 +01: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
..
src	Fix panic in `rotate`; Add safe record creation function (#11718 )	2024-02-03 13:23:16 +02:00
Cargo.toml	Bump to dev version 0.89.1 (#11513 )	2024-01-11 00:19:21 +13:00
README.md	Allow plugins to receive configuration from the nushell configuration (#10955 )	2024-01-15 16:59:47 +08:00

README.md

Plugin Example

Crate with a simple example of the Plugin trait that needs to be implemented in order to create a binary that can be registered into nushell declaration list

`example config`

This subcommand demonstrates sending configuration from the nushell $env.config to a plugin.

To register from after building nushell run:

register target/debug/nu_plugin_example

The configuration for the plugin lives in $env.config.plugins.example:

$env.config = {
  plugins: {
    example: [
      some
      values
    ]
  }
}

To list plugin values run:

nu-example-config