Opt out from default derives and attributes #925

pmikolajczyk41 · 2023-04-24T08:01:38Z

This PR aims at giving the subxt user full control over derived traits and attributes for generated types. Until now, every new type was given:

#[derive(
    #crate_path::ext::scale_encode::EncodeAsType,
    #crate_path::ext::scale_decode::DecodeAsType,
    #crate_path::ext::codec::Encode,
    #crate_path::ext::codec::Decode,
    Debug
)]
#[encode_as_type(crate_path = #encode_crate_path)]
#[decode_as_type(crate_path = #decode_crate_path)]
#[codec(crate = #crate_path::ext::codec)]

This in particular meant that subxt was assumed to be available when working with just subxt_macro crate. In order to allow some flexibility, we add (both to the macro and CLI):

option to opt out from these defaults
arguments to provide both universal (for every type) and type-specific derives and attributes

cli/src/commands/codegen.rs

examples/examples/no_default_derives.rs

macro/src/lib.rs

…efault-derive

cli/src/commands/codegen.rs

macro/src/lib.rs

codegen/src/types/derives.rs

jsdw · 2023-04-24T10:01:16Z

A couple more naming nits for consistency with DerivesForType etc but otherwise looks great!

…efault-derive

pepoviola · 2023-04-24T11:13:00Z

cli/src/commands/codegen.rs

    /// Additional derives for a given type.
    ///
    /// Example `--derive-for-type my_module::my_type=serde::Serialize`.
    #[clap(long = "derive-for-type", value_parser = derive_for_type_parser)]
    derives_for_type: Vec<(String, String)>,
+    /// Additional attributes for a given type.
+    ///
+    /// Example `--attribute-type my_module::my_type=#[allow(clippy::all)]`.


Suggested change

/// Example `--attribute-type my_module::my_type=#[allow(clippy::all)]`.

/// Example `--attributes-for-type my_module::my_type=#[allow(clippy::all)]`.

Typo on docs.

Good spot; thank you!

fixed, thanks!

No default derives

950427e

pmikolajczyk41 requested a review from a team as a code owner April 24, 2023 08:01

pmikolajczyk41 added 2 commits April 24, 2023 10:08

Clippy

49b0f35

Clippy

553e512