ZacharyZhang-NY
a02b555e66
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).
41 lines
1.1 KiB
Rust
41 lines
1.1 KiB
Rust
//! Bazel runfiles helpers for test data.
|
|
//!
|
|
//! Under `bazel test`, data lives in the runfiles tree; under `cargo test`,
|
|
//! `CARGO_MANIFEST_DIR` is the crate root. [`crate_root!`] covers both.
|
|
|
|
use std::path::PathBuf;
|
|
|
|
/// Resolve a runfiles path to an absolute directory when the `bazel` feature
|
|
/// is on and the entry exists; otherwise `None`.
|
|
pub fn try_resolve_runfiles(_path: &str) -> Option<PathBuf> {
|
|
#[cfg(feature = "bazel")]
|
|
{
|
|
let r = runfiles::Runfiles::create().ok()?;
|
|
runfiles::rlocation!(r, _path)
|
|
}
|
|
#[cfg(not(feature = "bazel"))]
|
|
{
|
|
None
|
|
}
|
|
}
|
|
|
|
/// Crate root under both `bazel test` (runfiles) and `cargo test`
|
|
/// (`CARGO_MANIFEST_DIR`).
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```ignore
|
|
/// use kigi_test_utils::crate_root;
|
|
///
|
|
/// fn test_data_dir() -> std::path::PathBuf {
|
|
/// crate_root!("_main/crates/common/kigi-test-utils").join("testdata")
|
|
/// }
|
|
/// ```
|
|
#[macro_export]
|
|
macro_rules! crate_root {
|
|
($runfiles_path:expr) => {
|
|
$crate::runfiles_util::try_resolve_runfiles($runfiles_path)
|
|
.unwrap_or_else(|| ::std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")))
|
|
};
|
|
}
|