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 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
//! # codegenrs
//!
//! > **Moving code-gen our of `build.rs`**
//!
//! ## About
//!
//! `codegenrs` makes it easy to get rid of code-gen in `build.rs`, reducing your
//! and dependents' build times. This is done by:
//! - Creating a child `[[bin]]` crate that does code-gen using `codegenrs`
//! - Do one-time code-gen and commit it
//! - Run the `--check` step in your CI to ensure your code-gen is neither out of
//! date or been human edited.
//!
//!## Usage
//!
//!`imperative` example:
//! - output: [`wordlist_codegen.rs`](https://github.com/crate-ci/imperative/blob/master/src/wordlist_codegen.rs)
//! - generator: [`imperative-codegen`](https://github.com/crate-ci/imperative/tree/master/tests/codegen.rs)
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(clippy::print_stderr)]
#![warn(clippy::print_stdout)]
use std::io::Write;
#[cfg(feature = "clap")]
use clap::Args;
/// CLI arguments to `flatten` into your args
///
/// ## Example
///
/// ```rust
/// #[derive(clap::Parser)]
/// struct Args{
/// #[arg(short('i'), long)]
/// input: std::path::PathBuf,
/// #[command(flatten)]
/// codegen: codegenrs::CodeGenArgs,
/// }
/// ```
#[cfg(feature = "clap")]
#[derive(Debug, Args)]
pub struct CodeGenArgs {
#[arg(short('o'), long)]
output: std::path::PathBuf,
#[arg(long)]
check: bool,
}
#[cfg(feature = "clap")]
impl CodeGenArgs {
/// Write or verify code-genned text.
pub fn write_str(&self, content: &str) -> Result<(), Box<dyn std::error::Error>> {
write_str(content, &self.output, self.check)
}
}
/// Write or verify code-genned text.
///
/// See `CodeGenArgs` for `clap` integration.
pub fn write_str(
content: &str,
output: &std::path::Path,
check: bool,
) -> Result<(), Box<dyn std::error::Error>> {
if check {
let content: String = normalize_line_endings::normalized(content.chars()).collect();
let actual = std::fs::read_to_string(output)?;
let actual: String = normalize_line_endings::normalized(actual.chars()).collect();
if content != actual {
// `difference` will allocation a `Vec` with N*M elements.
let allocation = content.lines().count() * actual.lines().count();
if 1_000_000_000 < allocation {
return Err(Box::new(CodeGenError {
message: format!("{} out of sync (too big to diff)", output.display()),
}));
} else {
let changeset = difference::Changeset::new(&actual, &content, "\n");
assert_ne!(changeset.distance, 0);
return Err(Box::new(CodeGenError {
message: format!("{} out of sync:\n{changeset}", output.display()),
}));
}
}
} else {
let mut file = std::io::BufWriter::new(std::fs::File::create(output)?);
write!(file, "{content}")?;
}
Ok(())
}
/// CLI arguments to `flatten` into your args
///
/// ## Example
///
/// ```rust
/// #[derive(clap::Parser)]
/// struct Args{
/// #[arg(short('i'), long)]
/// input: std::path::PathBuf,
/// #[command(flatten)]
/// codegen: codegenrs::CodeGenArgs,
/// #[command(flatten)]
/// rustfmt: codegenrs::RustfmtArgs,
/// }
/// ```
#[cfg(feature = "clap")]
#[derive(Debug, Args)]
pub struct RustfmtArgs {
#[arg(long)]
rustfmt_config: Option<std::path::PathBuf>,
}
#[cfg(feature = "clap")]
impl RustfmtArgs {
/// Write or verify code-genned text.
pub fn reformat(
&self,
text: impl std::fmt::Display,
) -> Result<String, Box<dyn std::error::Error>> {
rustfmt(text, self.rustfmt_config.as_deref())
}
}
/// Run `rustfmt` on an in-memory string
pub fn rustfmt(
text: impl std::fmt::Display,
config: Option<&std::path::Path>,
) -> Result<String, Box<dyn std::error::Error>> {
let mut rustfmt = std::process::Command::new("rustfmt");
rustfmt
.stdin(std::process::Stdio::piped())
.stdout(std::process::Stdio::piped());
if let Some(config) = config {
rustfmt.arg("--config-path").arg(config);
}
let mut rustfmt = rustfmt
.spawn()
.map_err(|err| format!("could not run `rustfmt`: {err}"))?;
write!(
rustfmt
.stdin
.take()
.expect("rustfmt was configured with stdin"),
"{text}"
)?;
let output = rustfmt.wait_with_output()?;
let stdout = String::from_utf8(output.stdout)?;
Ok(stdout)
}
#[derive(Clone, Debug)]
struct CodeGenError {
message: String,
}
impl std::error::Error for CodeGenError {}
impl std::fmt::Display for CodeGenError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.message.fmt(f)
}
}