Files
Kigi-CLI/crates/codegen/kigi-shell/build.rs
T
ZacharyZhang-NY a02b555e66 docs(comments): rewrite comments across all crates to the guidelines
Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
2026-07-23 16:55:39 -04:00

188 lines
7.6 KiB
Rust

//! Build script for bundling ripgrep for the kigi-shell crate.
//!
//! - If `KIGI_SHELL_BUNDLE_RG_PATH` is set, always bundle it
//! - Otherwise, only bundle in release builds
use std::env;
use std::fs;
use std::io;
use std::path::{Path, PathBuf};
const RG_VER: &str = "15.0.0";
fn main() -> Result<(), Box<dyn std::error::Error>> {
println!("cargo:rerun-if-env-changed=KIGI_SHELL_BUNDLE_RG_PATH");
println!("cargo:rerun-if-env-changed=KIGI_SHELL_RG_DOWNLOAD_BASE");
// Declare our custom cfg to the compiler so cfg(bundle_rg) is recognized by lints
println!("cargo:rustc-check-cfg=cfg(bundle_rg)");
// Decide whether to bundle: path override OR release build. Bail before
// touching the filesystem so debug `cargo check` needs no environment.
let path_override = env::var("KIGI_SHELL_BUNDLE_RG_PATH").ok();
let is_release = env::var("PROFILE").as_deref() == Ok("release");
if path_override.is_none() && !is_release {
return Ok(());
}
// In Bazel builds, write into OUT_DIR (which is writable) rather than
// XAI_ROOT/target/tmp (which is read-only inside the sandbox). Outside
// Bazel, prefer XAI_ROOT's shared cache dir (monorepo behavior) and fall
// back to OUT_DIR for standalone checkouts where XAI_ROOT is not a thing.
let manifest_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR")?);
let in_bazel = is_bazel_build(&manifest_dir);
let gen_dir = if in_bazel {
// OUT_DIR is always set by Cargo/Bazel for build scripts.
PathBuf::from(env::var("OUT_DIR")?)
} else if let Ok(xai_root) = env::var("XAI_ROOT") {
PathBuf::from(xai_root).join("target/tmp/kigi-shell-bundle-rg")
} else {
PathBuf::from(env::var("OUT_DIR")?)
};
fs::create_dir_all(&gen_dir)?;
// Skip auto-bundling on Windows: ripgrep ships .zip there (not .tar.gz)
// and we do not yet have a zip-extraction path. Returning here BEFORE
// emitting `cargo:rustc-cfg=bundle_rg` keeps the include_bytes! macros
// gated on cfg(bundle_rg) compiled-out, so the runtime falls back to
// `rg` on PATH (see src/util/ripgrep.rs::rg_path). Users install via
// `winget install BurntSushi.ripgrep.MSVC` or `scoop install ripgrep`.
// An explicit KIGI_SHELL_BUNDLE_RG_PATH still bundles on Windows (the
// override path below copies any binary regardless of target).
let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap_or_default();
if target_os == "windows" && path_override.is_none() {
return Ok(());
}
// Expose cfg so the crate can include the bundled bytes.
println!("cargo:rustc-cfg=bundle_rg");
println!("cargo:rustc-env=KIGI_SHELL_RG_VER={}", RG_VER);
println!(
"cargo:rustc-env=KIGI_SHELL_RG_GEN_DIR={}",
gen_dir.display()
);
// If a local rg binary is provided, copy it directly (skips target check).
if let Some(path) = path_override {
let dest = gen_dir.join(format!("rg-{}-override.bin", RG_VER));
println!("cargo:rustc-env=KIGI_SHELL_RG_TARGET=override");
let _ = fs::remove_file(&dest);
fs::copy(PathBuf::from(path.clone()), &dest).map_err(|e| {
format!(
"Failed copying KIGI_SHELL_BUNDLE_RG_PATH: {e} from path {path} to dest {}",
dest.display()
)
})?;
return Ok(());
}
// Determine supported ripgrep asset triple for auto-download.
let target_arch = env::var("CARGO_CFG_TARGET_ARCH").unwrap_or_default();
let asset_triple = match (target_os.as_str(), target_arch.as_str()) {
("macos", "aarch64") => "aarch64-apple-darwin",
("macos", "x86_64") => "x86_64-apple-darwin",
("linux", "x86_64") => "x86_64-unknown-linux-musl",
("linux", "aarch64") => "aarch64-unknown-linux-gnu",
_ => {
return Err(format!(
"Unsupported target for ripgrep bundling: {os}-{arch}. Set KIGI_SHELL_BUNDLE_RG_PATH to a local rg binary for offline or unsupported builds.",
os = target_os,
arch = target_arch
).into());
}
};
println!("cargo:rustc-env=KIGI_SHELL_RG_TARGET={}", asset_triple);
let dest = gen_dir.join(format!("rg-{}-{}.bin", RG_VER, asset_triple));
let _ = fs::remove_file(&dest);
// Download base is overridable so sandboxed/offline CI can point at an
// internal mirror (e.g. KIGI_SHELL_RG_DOWNLOAD_BASE=http://<mirror>/github/
// BurntSushi/ripgrep/releases/download). Defaults to the public GitHub
// releases URL.
let download_base = env::var("KIGI_SHELL_RG_DOWNLOAD_BASE")
.unwrap_or_else(|_| "https://github.com/BurntSushi/ripgrep/releases/download".to_string());
let url = format!(
"{base}/{v}/ripgrep-{v}-{t}.tar.gz",
base = download_base.trim_end_matches('/'),
v = RG_VER,
t = asset_triple
);
// Transient CDN hiccups (502/503/timeouts) are retried with backoff: a
// single flaky response must not kill a ~50-minute release build (it
// did — the v0.1.5 tag build failed on one 502). Genuine failures
// (404, offline) still error out with the offline-build hint.
let bytes: Vec<u8> = {
let mut last_err = String::new();
let mut bytes = None;
for (attempt, backoff_secs) in [0u64, 2, 8].into_iter().enumerate() {
if backoff_secs > 0 {
std::thread::sleep(std::time::Duration::from_secs(backoff_secs));
}
match reqwest::blocking::get(&url) {
Ok(resp) if resp.status().is_success() => match resp.bytes() {
Ok(b) => {
bytes = Some(b.to_vec());
break;
}
Err(e) => last_err = format!("reading ripgrep body: {e}"),
},
Ok(resp) => {
let status = resp.status();
last_err = format!("HTTP {status} downloading ripgrep");
// Only server-side/transient statuses are worth retrying.
if !(status.is_server_error() || status.as_u16() == 429) {
break;
}
}
Err(e) => last_err = format!("Failed to download ripgrep: {e}"),
}
println!(
"cargo:warning=ripgrep download attempt {} failed: {last_err}",
attempt + 1
);
}
bytes.ok_or_else(|| {
format!("{last_err}. Set KIGI_SHELL_BUNDLE_RG_PATH for offline builds.")
})?
};
let gz = flate2::read::GzDecoder::new(&bytes[..]);
let mut ar = tar::Archive::new(gz);
let mut found = false;
for entry in ar.entries()? {
let mut e = entry?;
let p = e.path()?;
if p.file_name().is_some_and(|n| n == "rg") {
let data: Vec<u8> = {
let mut v = Vec::new();
io::copy(&mut e, &mut v)?;
v
};
fs::write(&dest, &data)?;
found = true;
break;
}
}
if !found {
return Err(format!(
"Could not find 'rg' in ripgrep archive {}. Set KIGI_SHELL_BUNDLE_RG_PATH for offline builds.",
url
)
.into());
}
Ok(())
}
fn is_bazel_build(manifest_dir: &Path) -> bool {
let manifest_dir_str = manifest_dir.to_string_lossy();
env::var_os("BAZEL_WORKSPACE").is_some()
|| env::var_os("BUILD_WORKSPACE_DIRECTORY").is_some()
|| env::var_os("BAZEL_EXECUTION_ROOT").is_some()
|| env::var_os("BAZEL_OUTPUT_BASE").is_some()
|| manifest_dir_str.contains("/execroot/")
|| manifest_dir_str.contains("/bazel-out/")
}