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).
This commit is contained in:
1 parent
ff0fb56c67
commit
a02b555e66
1458 files changed
+10729
-21750
No files matched your search
@@ -13,16 +13,12 @@ use kigi_agent::plugins::install_registry::{
|
||||
InstallError, InstallKind, InstallRegistry, InstalledRepo,
|
||||
};
|
||||
|
||||
// ── Helpers (internal) ──────────────────────────────────────────────
|
||||
|
||||
fn save_registry_or_warn(registry: &InstallRegistry) {
|
||||
if let Err(e) = registry.save() {
|
||||
tracing::warn!("failed to save install registry: {e}");
|
||||
}
|
||||
}
|
||||
|
||||
// ── Install ─────────────────────────────────────────────────────────
|
||||
|
||||
pub struct InstallOutcome {
|
||||
pub repo_key: String,
|
||||
pub plugin_names: Vec<String>,
|
||||
@@ -63,8 +59,6 @@ pub fn install_plugin(source: &str, cwd: &Path) -> Result<InstallOutcome, Instal
|
||||
})
|
||||
}
|
||||
|
||||
// ── Uninstall ───────────────────────────────────────────────────────
|
||||
|
||||
pub struct UninstallOutcome {
|
||||
pub repo_key: String,
|
||||
pub removed_plugins: Vec<String>,
|
||||
@@ -167,8 +161,6 @@ pub fn uninstall_plugin(
|
||||
})
|
||||
}
|
||||
|
||||
// ── Update ──────────────────────────────────────────────────────────
|
||||
|
||||
pub enum RepoUpdateOutcome {
|
||||
Updated {
|
||||
repo_key: String,
|
||||
@@ -218,7 +210,6 @@ impl std::fmt::Display for UpdateError {
|
||||
}
|
||||
}
|
||||
|
||||
/// Apply an update result to the registry entry.
|
||||
fn apply_update_to_registry(
|
||||
registry: &mut InstallRegistry,
|
||||
repo_key: &str,
|
||||
@@ -304,8 +295,6 @@ pub fn update_plugins_by_selector(
|
||||
Ok(outcomes)
|
||||
}
|
||||
|
||||
// ── Source helpers ──────────────────────────────────────────────────
|
||||
|
||||
/// Expand GitHub shorthand (user/repo) to `https://github.com/user/repo.git`.
|
||||
pub fn normalize_git_url(input: &str) -> String {
|
||||
if !input.contains("://") && !input.contains("git@") {
|
||||
@@ -351,8 +340,6 @@ pub fn classify_install_error(err: &InstallError) -> String {
|
||||
.to_string()
|
||||
}
|
||||
|
||||
// ── Tests ───────────────────────────────────────────────────────────
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -388,8 +375,10 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn name_from_url_edge_cases() {
|
||||
assert_eq!(name_from_url("https://github.com/org/repo/"), "repo"); // trailing slash bug fix
|
||||
assert_eq!(name_from_url(""), "plugin"); // empty fallback
|
||||
// trailing slash bug fix
|
||||
assert_eq!(name_from_url("https://github.com/org/repo/"), "repo");
|
||||
// empty fallback
|
||||
assert_eq!(name_from_url(""), "plugin");
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
Reference in new issue
Block a user