feat(stackable-versioned): Add support for multiple k8s shortname arguments (#958)

* feat(stackable-versioned): Add support for multiple k8s `shortname` arguments

* chore(stackable-versioned): Update changelog

* chore(stackable-versioned): Remove commented out code

* chore(stackable-versioned): Update doc-comment for shortname

* docs(stackable-versioned): Improve CRD shortname argument description

* docs(stackable-versioned): Make k8s argument descriptions consistent.

I copy/pasted from the module docs to keep wrapping new-lines consistent.

Author: NickLarsenNZ

crates/stackable-versioned-macros/fixtures/inputs/k8s/shortnames.rs

@@ -0,0 +1,9 @@
+#[versioned(
+    version(name = "v1alpha1"),
+    k8s(group = "stackable.tech", shortname = "f", shortname = "fo",)
+)]
+// ---
+#[derive(
+    Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema, kube::CustomResource,
+)]
+pub(crate) struct FooSpec {}

crates/stackable-versioned-macros/fixtures/snapshots/stackable_versioned_macros__test__k8s_snapshots@shortnames.rs.snap

@@ -8,16 +8,19 @@ use syn::Path;
 ///
 /// Supported arguments are:
 ///
-/// - `group`, which sets the CRD group, usually the domain of the company.
-/// - `kind`, which allows overwriting the kind field of the CRD. This defaults to the struct name
-///    (without the 'Spec' suffix).
-/// - `singular`, to specify the singular name of the CR object.
-/// - `plural`, to specify the plural name of the CR object.
-/// - `namespaced`, to specify that this is a namespaced resource rather than cluster level.
+/// - `group`: Set the group of the CR object, usually the domain of the company.
+///   This argument is Required.
+/// - `kind`: Override the kind field of the CR object. This defaults to the struct
+///    name (without the 'Spec' suffix).
+/// - `singular`: Set the singular name of the CR object.
+/// - `plural`: Set the plural name of the CR object.
+/// - `namespaced`: Indicate that this is a namespaced scoped resource rather than a
+///    cluster scoped resource.
 /// - `crates`: Override specific crates.
-/// - `status`: Sets the specified struct as the status subresource.
-/// - `shortname`: Sets the shortname of the CRD.
-/// - `skip`, which controls skipping parts of the generation.
+/// - `status`: Set the specified struct as the status subresource.
+/// - `shortname`: Set a shortname for the CR object. This can be specified multiple
+///   times.
+/// - `skip`: Controls skipping parts of the generation.
 #[derive(Clone, Debug, FromMeta)]
 pub(crate) struct KubernetesArguments {
     pub(crate) group: String,
@@ -32,7 +35,8 @@ pub(crate) struct KubernetesArguments {
     // schema
     // scale
     // printcolumn
-    pub(crate) shortname: Option<String>,
+    #[darling(multiple, rename = "shortname")]
+    pub(crate) shortnames: Vec<String>,
     // category
     // selectable
     // doc

crates/stackable-versioned-macros/src/attrs/k8s.rs

@@ -280,7 +280,7 @@ pub(crate) struct KubernetesOptions {
     // schema
     // scale
     // printcolumn
-    pub(crate) shortname: Option<String>,
+    pub(crate) shortnames: Vec<String>,
     // category
     // selectable
     // doc
@@ -301,7 +301,7 @@ impl From<KubernetesArguments> for KubernetesOptions {
                 .crates
                 .map_or_else(KubernetesCrateOptions::default, |crates| crates.into()),
             status: args.status,
-            shortname: args.shortname,
+            shortnames: args.shortnames,
             skip_merged_crd: args.skip.map_or(false, |s| s.merged_crd.is_present()),
         }
     }

crates/stackable-versioned-macros/src/codegen/container/mod.rs

@@ -282,10 +282,11 @@ impl Struct {
                     .status
                     .as_ref()
                     .map(|s| quote! { , status = #s });
-                let shortname = kubernetes_options
-                    .shortname
-                    .as_ref()
-                    .map(|s| quote! { , shortname = #s });
+                let shortnames: TokenStream = kubernetes_options
+                    .shortnames
+                    .iter()
+                    .map(|s| quote! { , shortname = #s })
+                    .collect();
 
                 Some(quote! {
                     // The end-developer needs to derive CustomResource and JsonSchema.
@@ -294,7 +295,7 @@ impl Struct {
                         // These must be comma separated (except the last) as they always exist:
                         group = #group, version = #version, kind = #kind
                         // These fields are optional, and therefore the token stream must prefix each with a comma:
-                        #singular #plural #namespaced #crates #status #shortname
+                        #singular #plural #namespaced #crates #status #shortnames
                     )]
                 })
             }

crates/stackable-versioned-macros/src/codegen/container/struct.rs

@@ -603,16 +603,18 @@ println!("{}", serde_yaml::to_string(&merged_crd).unwrap());
 
 Currently, the following arguments are supported:
 
-- `group`: Sets the CRD group, usually the domain of the company.
-- `kind`:  Allows overwriting the kind field of the CRD. This defaults
-  to the struct name (without the 'Spec' suffix).
-- `singular`: Sets the singular name.
-- `plural`: Sets the plural name.
-- `namespaced`: Specifies that this is a namespaced resource rather than
-  a cluster scoped.
+- `group`: Set the group of the CR object, usually the domain of the company.
+  This argument is Required.
+- `kind`: Override the kind field of the CR object. This defaults to the struct
+   name (without the 'Spec' suffix).
+- `singular`: Set the singular name of the CR object.
+- `plural`: Set the plural name of the CR object.
+- `namespaced`: Indicate that this is a namespaced scoped resource rather than a
+   cluster scoped resource.
 - `crates`: Override specific crates.
-- `status`: Sets the specified struct as the status subresource.
-- `shortname`: Sets the shortname of the CRD.
+- `status`: Set the specified struct as the status subresource.
+- `shortname`: Set a shortname for the CR object. This can be specified multiple
+  times.
 
 ### Versioning Items in a Module
 

crates/stackable-versioned-macros/src/lib.rs

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+
+- Add support for multiple k8s `shortname` arguments ([#958]).
+
+[#958]: https://github.com/stackabletech/operator-rs/pull/958
+
 ## [0.5.0] - 2024-12-03
 
 ### Added