18 releases

new 0.7.1 Mar 5, 2025
0.6.2 Mar 2, 2025
0.5.10 Dec 15, 2024
0.5.4 Nov 19, 2024
0.5.0 Jul 21, 2024

#685 in Procedural macros

Download history 248/week @ 2024-11-17 124/week @ 2024-11-24 513/week @ 2024-12-01 459/week @ 2024-12-08 450/week @ 2024-12-15 30/week @ 2024-12-22 42/week @ 2024-12-29 127/week @ 2025-01-05 150/week @ 2025-01-12 110/week @ 2025-01-19 222/week @ 2025-01-26 300/week @ 2025-02-02 108/week @ 2025-02-09 129/week @ 2025-02-16 113/week @ 2025-02-23 526/week @ 2025-03-02

888 downloads per month
Used in 26 crates (6 directly)

ISC license

245KB
6K SLoC

This is the library-version of genemichaels, useful for generating code, testing proc macro output (deterministically formatting for string comparisons), the uses are various!

Usage

Do cargo add genemichaels

There are three main functions:

  • genemichaels::format_str - formats a string (full rust source file, doesn't support snippets at the moment).
  • genemichaels::format_ast - formats AST element (implements genemichaels::Formattable, most syn::* structs do). Comments need to be passed in separately, if you have any.
  • genemichaels::extract_comments - takes a string of source code and extracts comments, mapping each comment to the start of a syntax element

If you want to format a TokenStream, parse it into an AST with syn::parse2::<syn::File>(token_stream) then call format_ast.

The format functions also return lost comments - comments not formatted/added to the formatted source after processing. In an ideal world this wouldn't exist, but right now comments are added on a case by case basis and not all source tokens support comments.

Dependencies

~10–21MB
~306K SLoC