nushell/crates
Piepmatz 39b0f3bdda
Change expected type for derived FromValue implementations via attribute (#13647)
<!--
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.
-->
In this PR I expanded the helper attribute `#[nu_value]` on
`#[derive(FromValue)]`. It now allows the usage of `#[nu_value(type_name
= "...")]` to set a type name for the `FromValue::expected_type`
implementation. Currently it only uses the default implementation but
I'd like to change that without having to manually implement the entire
trait on my own.

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
Users that derive `FromValue` may now change the name of the expected
type.

# 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 toolkit.nu; toolkit test stdlib"` 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
> ```
-->
I added some tests that check if this feature work and updated the
documentation about the derive macro.

- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`

# 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-08-23 06:47:15 -05:00
..
nu_plugin_custom_values Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_example Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_formats Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_gstat Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_inc Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_nu_example Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_polars Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_python Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_query Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_stress_internals Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-cli Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-cmd-base Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-cmd-extra Fix bits ror/bits rol implementation (#13673) 2024-08-22 21:22:10 +02:00
nu-cmd-lang Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-cmd-plugin Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-color-config Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-command add more granularity for into record with dates (#13650) 2024-08-22 12:09:27 +02:00
nu-derive-value Change expected type for derived FromValue implementations via attribute (#13647) 2024-08-23 06:47:15 -05:00
nu-engine Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-explore Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-glob Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-json Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-lsp Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-parser Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-path Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-plugin Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-plugin-core Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-plugin-engine Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-plugin-protocol Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-plugin-test-support Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-pretty-hex Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-protocol Change expected type for derived FromValue implementations via attribute (#13647) 2024-08-23 06:47:15 -05:00
nu-std Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-system Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-table Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-term-grid Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-test-support Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-utils Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nuon Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.