facet-macros-impl 0.44.4

Implementation of facet derive macros (parsing and code generation)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

#![warn(missing_docs)]
#![allow(uncommon_codepoints)]
//!
//! [![Coverage Status](https://coveralls.io/repos/github/facet-rs/facet-macros-impl/badge.svg?branch=main)](https://coveralls.io/github/facet-rs/facet?branch=main)
//! [![crates.io](https://img.shields.io/crates/v/facet-macros-impl.svg)](https://crates.io/crates/facet-macros-impl)
//! [![documentation](https://docs.rs/facet-macros-impl/badge.svg)](https://docs.rs/facet-macros-impl)
//! [![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/facet-macros-impl.svg)](./LICENSE)
//! [![Discord](https://img.shields.io/discord/1379550208551026748?logo=discord&label=discord)](https://discord.gg/JhD7CwCJ8F)
//!
//! Implementation of facet derive macros, combining parsing and code generation.
//!
//! This crate provides the internal implementation for `#[derive(Facet)]` and related procedural macros. It's used by `facet-macros` (the proc-macro crate) and should not be used directly.
//!
#![doc = include_str!("../readme-footer.md")]

// ============================================================================
// RE-EXPORTS FROM FACET-MACRO-TYPES (grammar) AND FACET-MACRO-PARSE (parsed types)
// ============================================================================

// Re-export everything from facet-macro-types (includes unsynn, grammar, RenameRule)
pub use facet_macro_types::*;

// Re-export everything from facet-macro-parse (includes parsed types like PStruct, PEnum, etc.)
pub use facet_macro_parse::*;

// ============================================================================
// FUNCTION PARSING (optional feature)
// ============================================================================

/// Parse function signature shape
#[cfg(feature = "function")]
pub mod function;

// ============================================================================
// CODE EMISSION
// ============================================================================

mod process_enum;
mod process_struct;

// ============================================================================
// DOC STRIPPING DETECTION
// ============================================================================

/// Returns true if doc strings should be stripped from generated shapes.
///
/// Controlled by `--cfg facet_no_doc`. Set via rustflags in .cargo/config.toml,
/// Cargo.toml profile, or RUSTFLAGS env var. The cfg is evaluated when the
/// proc-macro is compiled.
#[cfg(all(feature = "doc", facet_no_doc))]
pub const fn is_no_doc() -> bool {
    true
}

/// Returns true if doc strings should be stripped from generated shapes.
#[cfg(all(feature = "doc", not(facet_no_doc)))]
pub const fn is_no_doc() -> bool {
    false
}

mod derive;
pub use derive::*;

mod plugin;
pub use plugin::*;

mod extension;
pub use extension::*;

mod on_error;
pub use on_error::*;

/// Attribute grammar infrastructure for extension crates
pub mod attr_grammar;

#[cfg(test)]
mod tests {
    use super::*;
    use quote::quote;

    #[test]
    fn test_struct_with_field_doc_comments() {
        let input = quote! {
            #[derive(Facet)]
            pub struct User {
                #[doc = " The user's unique identifier"]
                pub id: u64,
            }
        };

        let mut it = input.to_token_iter();
        let parsed = it.parse::<Struct>().expect("Failed to parse struct");

        // Check that we parsed the struct correctly
        assert_eq!(parsed.name.to_string(), "User");

        // Extract fields from the struct
        if let StructKind::Struct { fields, .. } = &parsed.kind {
            assert_eq!(fields.content.len(), 1);

            // Check first field (id)
            let id_field = &fields.content[0].value;
            assert_eq!(id_field.name.to_string(), "id");

            // Extract doc comments from id field
            let mut doc_found = false;
            for attr in &id_field.attributes {
                match &attr.body.content {
                    AttributeInner::Doc(doc_inner) => {
                        // This should work with LiteralString
                        assert_eq!(doc_inner.value, " The user's unique identifier");
                        doc_found = true;
                    }
                    _ => {
                        // Skip non-doc attributes
                    }
                }
            }
            assert!(doc_found, "Should have found a doc comment");
        } else {
            panic!("Expected a regular struct with named fields");
        }
    }
}