fix(macros): support #[doc = include_str!(...)] for macros (#444)

Add tests and return syn::Result from extract_doc_line to propagate parsing errors.
This commit is contained in:
rliang 2025-09-23 05:49:43 -03:00 • committed by GitHub
commit a11c4de332
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,5 +1,5 @@
use darling::{FromMeta, ast::NestedMeta};
use proc_macro2::TokenStream;
use proc_macro2::{Span, TokenStream};
use quote::{format_ident, quote};
use syn::{Expr, Ident, ImplItemFn, ReturnType};
@ -23,7 +23,7 @@ pub struct PromptAttribute {
pub struct ResolvedPromptAttribute {
pub name: String,
pub title: Option<String>,
pub description: Option<String>,
pub description: Option<Expr>,
pub arguments: Expr,
pub icons: Option<Expr>,
}
@ -98,9 +98,14 @@ pub fn prompt(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream>
};
let name = attribute.name.unwrap_or_else(|| fn_ident.to_string());
let description = attribute
.description
.or_else(|| fn_item.attrs.iter().fold(None, extract_doc_line));
let description = if let Some(s) = attribute.description {
Some(Expr::Lit(syn::ExprLit {
attrs: Vec::new(),
lit: syn::Lit::Str(syn::LitStr::new(&s, Span::call_site())),
}))
} else {
fn_item.attrs.iter().try_fold(None, extract_doc_line)?
};
let arguments = arguments_expr;
let resolved_prompt_attr = ResolvedPromptAttribute {
@ -200,4 +205,22 @@ mod test {
Ok(())
}
#[test]
fn test_doc_include_description() -> syn::Result<()> {
let attr = quote! {}; // No explicit description
let input = quote! {
#[doc = include_str!("some/test/data/doc.txt")]
fn test_prompt_included(&self) -> Result<String> {
Ok("Test".to_string())
}
};
let result = prompt(attr, input)?;
// The generated tokens should preserve the include_str! invocation
let result_str = result.to_string();
assert!(result_str.contains("include_str"));
Ok(())
}
}