feat(derive): allow naming the builder and setting field visibility

Author: tenuous-guidance

confik-macros/src/lib.rs

@@ -330,6 +330,9 @@ struct FieldImplementer {
     /// The field type.
     ty: Type,
 
+    /// `pub`, `pub(crate)`, etc.
+    vis: Visibility,
+
     /// Optional attributes to forward to the builder's field.
     forward: Option<Forward>,
 }
@@ -383,6 +386,7 @@ impl FieldImplementer {
             forward,
             from,
             try_from,
+            vis,
             ..
         } = field_impl.as_ref();
 
@@ -415,7 +419,7 @@ impl FieldImplementer {
         Ok(quote_spanned! { ident.span() =>
                 #[serde(default)]
                 #forward
-                #ident #ty
+                #vis #ident #ty
         })
     }
 
@@ -628,6 +632,11 @@ struct RootImplementer {
     /// This can be serde attributes e.g. `#[confik(forward(serde(default)))]` but also others like
     /// `#[confik(forward(derive(Hash)))]`
     forward: Option<Forward>,
+
+    /// A name to use for the builder.
+    ///
+    /// Setting this also puts the builder in the local module, so that the name is accessible.
+    name: Option<Ident>,
 }
 
 impl RootImplementer {
@@ -655,7 +664,11 @@ impl RootImplementer {
     ///
     /// Use [`Self::is_dataless`] first to determine whether a builder will exist.
     fn builder_name(&self) -> Ident {
-        format_ident!("{}ConfigBuilder", self.ident)
+        if let Some(name) = self.name.as_ref() {
+            name.clone()
+        } else {
+            format_ident!("{}ConfigBuilder", self.ident)
+        }
     }
 
     /// Defines the builder for the target.
@@ -920,18 +933,36 @@ fn derive_macro_builder_inner(target_struct: &DeriveInput) -> syn::Result<proc_m
         )]
     };
 
-    let full_derive = quote! {
-        #overall_lint_overrides
-        const _: () = {
-            #impl_lint_overrides
-            #target_impl
-
+    let full_derive = if implementer.name.is_some() {
+        quote! {
+            #overall_lint_overrides
             #struct_lint_overrides
             #builder_struct
 
-            #impl_lint_overrides
-            #builder_impl
-        };
+            #overall_lint_overrides
+            const _: () = {
+                #impl_lint_overrides
+                #target_impl
+
+                #overall_lint_overrides
+                #impl_lint_overrides
+                #builder_impl
+            };
+        }
+    } else {
+        quote! {
+            #overall_lint_overrides
+            const _: () = {
+                #impl_lint_overrides
+                #target_impl
+
+                #struct_lint_overrides
+                #builder_struct
+
+                #impl_lint_overrides
+                #builder_impl
+            };
+        }
     };
 
     Ok(full_derive.into())

confik-macros/tests/trybuild.rs

@@ -28,7 +28,11 @@ fn compile_macros() {
     t.pass("tests/trybuild/22-dataless-types.rs");
     t.pass("tests/trybuild/23-where-clause.rs");
     t.pass("tests/trybuild/24-field-try-from.rs");
-    t.pass("tests/trybuild/pass-enum-untagged.rs");
+    t.pass("tests/trybuild/25-pass-enum-untagged.rs");
+    t.pass("tests/trybuild/26-named-builder.rs");
+    t.pass("tests/trybuild/27-field-access.rs");
+    t.pass("tests/trybuild/28-field-vis.rs");
+    t.pass("tests/trybuild/29-named-field-vis.rs");
 
     t.compile_fail("tests/trybuild/fail-default-parse.rs");
     t.compile_fail("tests/trybuild/fail-default-invalid-expr.rs");

confik-macros/tests/trybuild/22-dataless-types.rs

@@ -8,7 +8,7 @@ struct A;
 struct B {}
 
 #[derive(Configuration, Debug)]
-struct C ();
+struct C();
 
 fn main() {
     let _builder = A::builder().try_build().expect("No data required");

confik-macros/tests/trybuild/pass-enum-untagged.rs

@@ -18,6 +18,13 @@
     #[confik(forward(derive(Hash)))]
     struct Config(usize);
     ```
+- Add a new `confik(name = ...)` attribute, that provides a custom name for the `Configuration::Builder` `struct` or `enum`.
+  - This will also place the builder in the local module, so that its name is in a known location
+  ```rust
+  #[derive(Configuration)]
+  #[confik(name = Builder)]
+  struct Config {}
+  ```
 
 ## 0.13.0
 

confik/CHANGELOG.md

@@ -256,6 +256,38 @@ struct Config {
 }
 ```
 
+### Named builders
+
+If you want to directly access the builders, you can provide them with a name. This will also place the builder in the local module, to ensure there's a known path with which to reference them.
+
+```rust
+#[derive(confik::Configuration)]
+#[confik(name = Builder)]
+struct Config {
+    data: usize,
+}
+
+let _ = Builder { data: Default::default() };
+```
+
+### Field and Builder visibility
+
+Field and builder visibility are direclty inherited from the underlying type. E.g.
+
+```rust
+mod config {
+    #[derive(confik::Configuration)]
+    pub struct Config {
+        pub data: usize,
+    }
+}
+
+// Required as you can't use this syntax for struct initialisation.
+type Builder = <config::Config as confik::Configuration>::Builder;
+
+let _ = Builder { data: Default::default() };
+```
+
 ## Macro Limitations
 
 ### Custom `Deserialize` Implementations