mirror of
https://github.com/nushell/nushell.git
synced 2025-04-26 14:18:19 +02:00
0430167f1c
<!-- 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. --> This PR replaces the usage of `proc-macro-error` with `proc-macro-error2`. At the time of writing `nu-derive-value` this wasn't an option, at least it wasn't clear that it is the direction to go. This shouldn't change any of the usage of `nu-derive-value` in any way but removes one security warning. `proc-macro-error` depends on `syn 1`, that's why I initially had the default features for `proc-macro-error` disabled. `proc-macro-error2` uses `syn 2` as mostly everything. So we can use that. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> Same interface, no 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 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 > ``` --> - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` The tests for `nu-derive-value` do not test spans, so maybe something changed now but probably not. # 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. --> We still have `quickcheck` which depends on `syn 1` but it seems we need that for `nu-cmd-lang`. Would be great if, in the future, we can get rid of `syn 1` as that should improve build times a bit.
72 lines
2.9 KiB
Rust
72 lines
2.9 KiB
Rust
//! Macro implementations of `#[derive(FromValue, IntoValue)]`.
|
|
//!
|
|
//! As this crate is a [`proc_macro`] crate, it is only allowed to export
|
|
//! [procedural macros](https://doc.rust-lang.org/reference/procedural-macros.html).
|
|
//! Therefore, it only exports [`IntoValue`] and [`FromValue`].
|
|
//!
|
|
//! To get documentation for other functions and types used in this crate, run
|
|
//! `cargo doc -p nu-derive-value --document-private-items`.
|
|
//!
|
|
//! This crate uses a lot of
|
|
//! [`proc_macro2::TokenStream`](https://docs.rs/proc-macro2/1.0.24/proc_macro2/struct.TokenStream.html)
|
|
//! as `TokenStream2` to allow testing the behavior of the macros directly, including the output
|
|
//! token stream or if the macro errors as expected.
|
|
//! The tests for functionality can be found in `nu_protocol::value::test_derive`.
|
|
//!
|
|
//! This documentation is often less reference-heavy than typical Rust documentation.
|
|
//! This is because this crate is a dependency for `nu_protocol`, and linking to it would create a
|
|
//! cyclic dependency.
|
|
//! Also all examples in the documentation aren't tested as this crate cannot be compiled as a
|
|
//! normal library very easily.
|
|
//! This might change in the future if cargo allows building a proc-macro crate differently for
|
|
//! `cfg(doctest)` as they are already doing for `cfg(test)`.
|
|
//!
|
|
//! The generated code from the derive macros tries to be as
|
|
//! [hygienic](https://doc.rust-lang.org/reference/macros-by-example.html#hygiene) as possible.
|
|
//! This ensures that the macro can be called anywhere without requiring specific imports.
|
|
//! This results in obtuse code, which isn't recommended for manual, handwritten Rust
|
|
//! but ensures that no other code may influence this generated code or vice versa.
|
|
|
|
use proc_macro::TokenStream;
|
|
use proc_macro2::TokenStream as TokenStream2;
|
|
use proc_macro_error2::{proc_macro_error, Diagnostic};
|
|
|
|
mod attributes;
|
|
mod case;
|
|
mod error;
|
|
mod from;
|
|
mod into;
|
|
mod names;
|
|
#[cfg(test)]
|
|
mod tests;
|
|
|
|
const HELPER_ATTRIBUTE: &str = "nu_value";
|
|
|
|
/// Derive macro generating an impl of the trait `IntoValue`.
|
|
///
|
|
/// For further information, see the docs on the trait itself.
|
|
#[proc_macro_derive(IntoValue, attributes(nu_value))]
|
|
#[proc_macro_error]
|
|
pub fn derive_into_value(input: TokenStream) -> TokenStream {
|
|
let input = TokenStream2::from(input);
|
|
let output = match into::derive_into_value(input) {
|
|
Ok(output) => output,
|
|
Err(e) => Diagnostic::from(e).abort(),
|
|
};
|
|
TokenStream::from(output)
|
|
}
|
|
|
|
/// Derive macro generating an impl of the trait `FromValue`.
|
|
///
|
|
/// For further information, see the docs on the trait itself.
|
|
#[proc_macro_derive(FromValue, attributes(nu_value))]
|
|
#[proc_macro_error]
|
|
pub fn derive_from_value(input: TokenStream) -> TokenStream {
|
|
let input = TokenStream2::from(input);
|
|
let output = match from::derive_from_value(input) {
|
|
Ok(output) => output,
|
|
Err(e) => Diagnostic::from(e).abort(),
|
|
};
|
|
TokenStream::from(output)
|
|
}
|