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).
42 lines
1.3 KiB
Rust
42 lines
1.3 KiB
Rust
//! Memory tools for cross-session knowledge retrieval.
|
|
//!
|
|
//! - `memory_search` — search indexed memory for relevant chunks
|
|
//! - `memory_get` — read a specific memory file by path
|
|
|
|
pub mod get_tool;
|
|
pub mod search_tool;
|
|
pub mod types;
|
|
|
|
pub use get_tool::MemoryGetImpl;
|
|
pub use search_tool::MemorySearchImpl;
|
|
|
|
/// Registered name of the `memory_search` tool. Single source of truth
|
|
/// shared between the tool definition and gating callers (e.g. shell-side
|
|
/// slash-command availability checks).
|
|
pub const MEMORY_SEARCH_TOOL_NAME: &str = "memory_search";
|
|
|
|
pub const MEMORY_GET_TOOL_NAME: &str = "memory_get";
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
/// The constants are the wire identifier embedded in
|
|
/// `AvailableCommandsUpdate._meta.tools` and matched by the shell's
|
|
/// memory-gate predicate. A typo in either site silently disables
|
|
/// `/flush` and `/dream`. Pin both halves.
|
|
#[test]
|
|
fn memory_tool_constants_match_registered_ids() {
|
|
assert_eq!(MEMORY_SEARCH_TOOL_NAME, "memory_search");
|
|
assert_eq!(MEMORY_GET_TOOL_NAME, "memory_get");
|
|
assert_eq!(
|
|
kigi_tool_runtime::Tool::id(&MemorySearchImpl).to_string(),
|
|
MEMORY_SEARCH_TOOL_NAME
|
|
);
|
|
assert_eq!(
|
|
kigi_tool_runtime::Tool::id(&MemoryGetImpl).to_string(),
|
|
MEMORY_GET_TOOL_NAME
|
|
);
|
|
}
|
|
}
|