Genco
A whitespace-aware quasiquoter for beautiful code generation.
[](https://github.com/udoprog/genco) [](https://crates.io/crates/genco) [](https://docs.rs/genco) [](https://github.com/udoprog/genco/actions?query=branch%3Amain) The project is written primarily in Rust, distributed under the Apache License 2.0 license, first published in 2017. Key topics include: code-generation, proc-macro, quasiquoter, rust.
genco
<img alt="github" src="https://img.shields.io/badge/github-udoprog/genco-8da0cb?style=for-the-badge&logo=github" height="20">
<img alt="crates.io" src="https://img.shields.io/crates/v/genco.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">
<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-genco-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">
<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/udoprog/genco/ci.yml?branch=main&style=for-the-badge" height="20">
A whitespace-aware quasiquoter for beautiful code generation.
Central to genco are the quote! and quote_in! procedural macros which
ease the construction of token streams.
This project solves the following language-specific concerns:
-
Imports — Generates and groups import statements as they are used.
So you only import what you use, with no redundancy. We also do our best
to solve namespace conflicts. -
String Quoting — genco knows how to quote strings. And can even
interpolate values into the quoted string if it's supported by the
language. -
Structural Indentation — The quoter relies on intuitive
whitespace detection to structurally sort out spacings and indentation.
Allowing genco to generate beautiful readable code with minimal effort.
This is also a requirement for generating correctly behaving code in
languages like Python where indentation is meaningful. -
Language Customization — Building support for new languages is a
piece of cake with the help of the impl_lang! macro.
To support line changes during whitespace detection, we depend on span
information which was made available in Rust 1.88. Before that, we rely on
a nightly proc_macro_span feature to work.
Prior to this version of Rust if you want fully functional whitespace
detection you must build and run projects using genco with a nightly
compiler. This is important for whitespace-sensitive languages like python.
You can try the difference between:
bashcargo run --example rust
And:
<br>bashcargo +nightly run --example rust
Supported Languages
The following are languages which have built-in support in genco.
-
🦀 <b>Rust</b><br>
<small>Example</small> -
☕ <b>Java</b><br>
<small>Example</small> -
🎼 <b>C#</b><br>
<small>Example</small> -
🐿️ <b>Go</b><br>
<small>Example</small> -
🎯 <b>Dart</b><br>
<small>Example</small> -
🌐 <b>JavaScript</b><br>
<small>Example</small> -
🇨 <b>C</b><br>
<small>Example</small> -
🐍 <b>Python</b><br>
<small>Example</small>
<small>Is your favorite language missing? <b>Open an issue!</b></small>
You can run one of the examples by:
<br>bashcargo +nightly run --example rust
Rust Example
The following is a simple program producing Rust code to stdout with custom
configuration:
rustuse genco::prelude::*; let hash_map = rust::import("std::collections", "HashMap"); let tokens: rust::Tokens = quote! { fn main() { let mut m = $hash_map::new(); m.insert(1u32, 2u32); } }; println!("{}", tokens.to_file_string()?);
This would produce:
<br>rustuse std::collections::HashMap; fn main() { let mut m = HashMap::new(); m.insert(1u32, 2u32); }
Contributors
Showing top 10 contributors by commit count.
