ZacharyZhang-NY/Kigi-CLI
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs(comments): rewrite comments across all crates to the guidelines

Browse Source 
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).
This commit is contained in:
ZacharyZhang-NY committed 2026-07-23 16:55:39 -04:00
1 parent ff0fb56c67
commit a02b555e66
1458 files changed
+10729 -21750
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

crates/codegen/kigi-tools/src/implementations/kigi/task/mod.rs
+8 -36
View File
@@ -30,17 +30,9 @@ use kigi_tool_types::{SubagentCompletedOutput, SubagentIsolationMode, TaskToolIn
/// the first subagent is depth 1. Subagents cannot spawn further subagents.
pub const MAX_SUBAGENT_DEPTH: u32 = 1;
// ───────────────────────────────────────────────────────────────────────────
// Tool implementation
// ───────────────────────────────────────────────────────────────────────────
#[derive(Debug, Default)]
pub struct TaskTool;
// ───────────────────────────────────────────────────────────────────────────
// Tests
// ───────────────────────────────────────────────────────────────────────────
impl crate::types::tool_metadata::ToolMetadata for TaskTool {
fn kind(&self) -> ToolKind {
ToolKind::Task
@@ -117,7 +109,6 @@ impl kigi_tool_runtime::Tool for TaskTool {
use crate::types::tool_metadata::shared_resources;
let resources = shared_resources(&ctx)?;
// 1. Depth check
let (depth, backend, model_validator, parent_session_id, parent_prompt_id) = {
let res = resources.lock().await;
@@ -201,7 +192,6 @@ impl kigi_tool_runtime::Tool for TaskTool {
but not both.",
));
}
// Non-existent path alongside worktree — clear it so worktree wins.
tracing::debug!(
cwd = %cwd.as_deref().unwrap_or(""),
"clearing non-existent cwd path because isolation=worktree is set"
@@ -211,7 +201,6 @@ impl kigi_tool_runtime::Tool for TaskTool {
cwd
};
// Validate that cwd points to an existing directory (skip when resuming).
if let Some(ref cwd_path) = cwd
&& resume_from.is_none()
{
@@ -226,8 +215,8 @@ impl kigi_tool_runtime::Tool for TaskTool {
}
}
// 2. Eager validation — catch unknown / disabled / not-allowed
// types before the fire-and-forget background spawn.
// Eager validation — catch unknown / disabled / not-allowed
// types before the fire-and-forget background spawn.
match backend
.backend()
.validate_type(&input.subagent_type, &parent_session_id)
@@ -284,7 +273,6 @@ impl kigi_tool_runtime::Tool for TaskTool {
}
}
// 3. Build the subagent request
let id = input
.task_id
.clone()
@@ -321,7 +309,7 @@ impl kigi_tool_runtime::Tool for TaskTool {
result_tx,
};
// 4. Background mode: fire-and-forget via backend.spawn().
// Background mode: fire-and-forget via backend.spawn().
// Coordinator stores the result for TaskOutputTool polling.
// Both transport errors and coordinator rejections are logged so
// late failures (worktree creation, etc.) remain visible.
@@ -368,10 +356,9 @@ impl kigi_tool_runtime::Tool for TaskTool {
));
}
// 5. Blocking mode (default): spawn via backend and await result
let result = backend.backend().spawn(request).await?;
// 5b. The await budget expired and the coordinator auto-backgrounded the
// The await budget expired and the coordinator auto-backgrounded the
// still-running child — return a task_id to poll, like the background
// branch above (the result arrives via auto-wake or a later poll).
if result.backgrounded {
@@ -397,7 +384,6 @@ impl kigi_tool_runtime::Tool for TaskTool {
));
}
// 6. Return result
if result.success {
let resume_from_hint = result.subagent_id.clone();
let persona_hint: Option<String> = None;
@@ -498,7 +484,7 @@ mod tests {
let (backend, _rx) = make_backend();
let mut resources = Resources::new();
resources.insert(backend);
resources.insert(SubagentDepthCounter(MAX_SUBAGENT_DEPTH)); // at limit
resources.insert(SubagentDepthCounter(MAX_SUBAGENT_DEPTH));
resources.insert(SessionIdResource("test-session".to_string()));
resources.insert(CurrentPromptIdResource("prompt-123".to_string()));
@@ -531,7 +517,7 @@ mod tests {
let (backend, _rx) = make_backend();
let mut resources = Resources::new();
resources.insert(backend);
resources.insert(SubagentDepthCounter(1)); // first-level subagent
resources.insert(SubagentDepthCounter(1));
resources.insert(SessionIdResource("child-session".to_string()));
resources.insert(CurrentPromptIdResource("prompt-456".to_string()));
@@ -604,7 +590,6 @@ mod tests {
let tool = TaskTool;
let shared = resources.into_shared();
// Spawn a task that will handle the request
let handle = tokio::spawn(async move {
let request = unwrap_spawn(rx.recv().await.unwrap());
assert_eq!(request.subagent_type, "explore");
@@ -663,7 +648,7 @@ mod tests {
let (backend, mut rx) = make_backend();
let mut resources = Resources::new();
resources.insert(backend);
resources.insert(SubagentDepthCounter(0)); // top-level session
resources.insert(SubagentDepthCounter(0));
resources.insert(SessionIdResource("parent-session".to_string()));
resources.insert(CurrentPromptIdResource("prompt-123".to_string()));
@@ -719,7 +704,6 @@ mod tests {
let tool = TaskTool;
let shared = resources.into_shared();
// Spawn a task that drops the result_tx without sending
let handle = tokio::spawn(async move {
let request = unwrap_spawn(rx.recv().await.unwrap());
drop(request.result_tx);
@@ -771,7 +755,7 @@ mod tests {
let result = kigi_tool_runtime::Tool::run(
&TaskTool,
test_ctx(resources.into_shared()),
task_input("general-purpose", false), // blocking mode
task_input("general-purpose", false),
)
.await
.expect("auto-backgrounded blocking spawn returns Ok");
@@ -1135,8 +1119,6 @@ mod tests {
assert!(capture_rx.try_recv().is_err(), "must fire exactly once");
}
// ── Runtime overrides serde tests ─────────────────
#[test]
fn runtime_overrides_parse() {
let input: TaskToolInput = serde_json::from_str(
@@ -1274,8 +1256,6 @@ mod tests {
}
}
// -- Isolation mode tests --
#[test]
fn isolation_defaults_to_none() {
let input: TaskToolInput =
@@ -1337,8 +1317,6 @@ mod tests {
}
}
// -- Capability mode enforcement tests --
fn tc(id: &str, kind: crate::types::tool::ToolKind) -> crate::registry::types::ToolConfig {
let mut c = crate::registry::types::ToolConfig::from_id(id);
c.kind = Some(kind);
@@ -1444,8 +1422,6 @@ mod tests {
);
}
// ── resume_from tests ────────────────────────────────────────────
#[test]
fn task_tool_input_has_no_fork_context_field() {
let _: TaskToolInput =
@@ -1682,8 +1658,6 @@ mod tests {
}
}
// ── cwd tests ────────────────────────────────────────────────────
#[test]
fn cwd_defaults_to_none() {
let input: TaskToolInput =
@@ -2270,8 +2244,6 @@ mod tests {
}
}
// ── model override tests ─────────────────────────────────────
#[tokio::test]
async fn model_threads_to_runtime_overrides() {
let (backend, mut rx) = make_backend();