From c3fbe252ea30a78b4620ac14860d283e587e66ec Mon Sep 17 00:00:00 2001 From: Eirik A Date: Thu, 12 Oct 2023 11:37:00 +0100 Subject: [PATCH] Upgrade `darling` and `syn` and rename `#[kube(struct)]` (#1307) * Bump darling and syn Signed-off-by: clux * breaking rename of `#[kube(struct)]` Signed-off-by: clux * r/generate/root and make docs consistently refer to root struct Signed-off-by: clux --------- Signed-off-by: clux --- examples/crd_derive.rs | 2 +- kube-derive/Cargo.toml | 4 ++-- kube-derive/src/custom_resource.rs | 2 +- kube-derive/src/lib.rs | 16 ++++++++-------- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/examples/crd_derive.rs b/examples/crd_derive.rs index 8aee39ec9..6715d5616 100644 --- a/examples/crd_derive.rs +++ b/examples/crd_derive.rs @@ -15,7 +15,7 @@ use serde::{Deserialize, Serialize}; version = "v1", kind = "Foo", plural = "fooz", - struct = "FooCrd", + root = "FooCrd", namespaced, status = "FooStatus", derive = "PartialEq", diff --git a/kube-derive/Cargo.toml b/kube-derive/Cargo.toml index 2f07b23f8..d3a284b10 100644 --- a/kube-derive/Cargo.toml +++ b/kube-derive/Cargo.toml @@ -18,9 +18,9 @@ categories = ["api-bindings", "encoding"] [dependencies] proc-macro2 = "1.0.29" quote = "1.0.10" -syn = { version = "1.0.80", features = ["extra-traits"] } +syn = { version = "2.0.38", features = ["extra-traits"] } serde_json = "1.0.68" -darling = "0.14.0" +darling = "0.20.3" [lib] proc-macro = true diff --git a/kube-derive/src/custom_resource.rs b/kube-derive/src/custom_resource.rs index 9fa120a15..177abe7de 100644 --- a/kube-derive/src/custom_resource.rs +++ b/kube-derive/src/custom_resource.rs @@ -10,7 +10,7 @@ struct KubeAttrs { group: String, version: String, kind: String, - #[darling(rename = "struct")] + #[darling(rename = "root")] kind_struct: Option, /// lowercase plural of kind (inferred if omitted) plural: Option, diff --git a/kube-derive/src/lib.rs b/kube-derive/src/lib.rs index 2b178e66d..7e296c3e1 100644 --- a/kube-derive/src/lib.rs +++ b/kube-derive/src/lib.rs @@ -34,12 +34,12 @@ mod custom_resource; /// let f = Foo::new("foo-1", FooSpec { /// info: "informative info".into(), /// }); -/// println!("foo: {:?}", f); // debug print on generated type +/// println!("foo: {:?}", f); // debug print on root type /// println!("crd: {}", serde_yaml::to_string(&Foo::crd()).unwrap()); // crd yaml /// ``` /// -/// This example creates a `struct Foo` containing metadata, the spec, -/// and optionally status. The **generated** type `Foo` can be used with the [`kube`] crate +/// This example generates a `struct Foo` containing metadata, the spec, +/// and optionally status. The **root** struct `Foo` can be used with the [`kube`] crate /// as an `Api` object (`FooSpec` can not be used with [`Api`][`kube::Api`]). /// /// ```no_run @@ -73,12 +73,12 @@ mod custom_resource; /// Your cr api version. The part after the slash in the top level `apiVersion` key. /// /// ## `#[kube(kind = "Kind")]` -/// Name of your kind and your generated root type. +/// Name of your kind, and implied default for your generated root type. /// /// # Optional `#[kube]` attributes /// /// ## `#[kube(singular = "nonstandard-singular")]` -/// To specify the singular name. Defaults to lowercased `kind`. +/// To specify the singular name. Defaults to lowercased `.kind` value. /// /// ## `#[kube(plural = "nonstandard-plural")]` /// To specify the plural name. Defaults to inferring from singular. @@ -86,8 +86,8 @@ mod custom_resource; /// ## `#[kube(namespaced)]` /// To specify that this is a namespaced resource rather than cluster level. /// -/// ## `#[kube(struct = "StructName")]` -/// Customize the name of the generated root struct (defaults to `kind`). +/// ## `#[kube(root = "StructName")]` +/// Customize the name of the generated root struct (defaults to `.kind` value). /// /// ## `#[kube(crates(kube_core = "::kube::core"))]` /// Customize the crate name the generated code will reach into (defaults to `::kube::core`). @@ -153,7 +153,7 @@ mod custom_resource; /// group = "clux.dev", /// version = "v1", /// kind = "Foo", -/// struct = "FooCrd", +/// root = "FooCrd", /// namespaced, /// status = "FooStatus", /// derive = "PartialEq",