Back to Details

s-clean

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Cleaning WoW Addons

清理WoW插件

Expert guidance for finding and removing cruft in addon codebases.
针对插件代码库中查找和移除冗余内容的专业指南。

Related Commands

相关命令

  • c-clean - Cleanup workflow
  • c-review - Full review (includes clean step)
  • c-clean - 清理工作流
  • c-review - 全面审查（包含清理步骤）

MCP Tools

MCP工具

TaskMCP Tool
Find Dead Code
addon.deadcode(addon="MyAddon")
Find Stale Docs
docs.stale(addon="MyAddon")
Filter by Confidence
addon.deadcode(addon="MyAddon", include_suspicious=false)
任务MCP工具
查找死代码
addon.deadcode(addon="MyAddon")
查找过时文档
docs.stale(addon="MyAddon")
按置信度筛选
addon.deadcode(addon="MyAddon", include_suspicious=false)

Capabilities

功能特性

  1. Dead Code Detection — Find unused functions, orphaned files, dead exports
  2. Stale Docs Detection — Find broken links, outdated refs, version drift
  3. Confidence Levels — Definite (100%), Likely (90%+), Suspicious (70%+)
  1. 死代码检测 — 查找未使用的函数、孤立文件、失效导出项
  2. 过时文档检测 — 查找失效链接、过时引用、版本偏差
  3. 置信度等级 — 确定（100%）、可能（90%+）、可疑（70%+）

Detection Categories

检测类别

Dead Code (
addon.deadcode
)

死代码（
addon.deadcode
）

CategoryDescription
unused_function
Functions defined but never called
orphaned_file
Lua files not in TOC
dead_export
Exported values never used
unused_library
Libraries in Libs/ never used
stale_event
Event handlers for unregistered events
commented_code
Large blocks of commented-out code
类别描述
unused_function
已定义但从未被调用的函数
orphaned_file
未在TOC中声明的Lua文件
dead_export
已导出但从未被使用的值
unused_library
Libs/目录下从未被使用的库
stale_event
针对未注册事件的事件处理器
commented_code
大段被注释掉的代码

Stale Docs (
docs.stale
)

过时文档（
docs.stale
）

CategoryDescription
dead_link
Internal links to non-existent files
dead_reference
Mentions of functions/files that don't exist
version_drift
Old version numbers in documentation
relative_staleness
Docs not updated in many commits
类别描述
dead_link
指向不存在文件的内部链接
dead_reference
提及不存在的函数/文件
version_drift
文档中的旧版本号
relative_staleness
多次提交后未更新的文档

Workflow

工作流

Quick Cleanup

快速清理

  1. Run 
    addon.deadcode
    with 
    include_suspicious=false
    for high-confidence issues only
  2. Remove identified dead code
  3. Run 
    docs.stale
    to find documentation issues
  4. Fix broken links and update outdated references
  1. 运行
    addon.deadcode
    并设置
    include_suspicious=false
    ，仅处理高置信度问题
  2. 移除识别出的死代码
  3. 运行
    docs.stale
    查找文档问题
  4. 修复失效链接并更新过时引用

Deep Cleanup

深度清理

  1. Run 
    addon.deadcode
    with all confidence levels
  2. Manually verify suspicious findings before removal
  3. Run 
    docs.stale
    with all techniques
  4. Update documentation to match current code
  1. 运行
    addon.deadcode
    并包含所有置信度等级
  2. 在移除前手动验证可疑结果
  3. 运行
    docs.stale
    并使用所有检测技术
  4. 更新文档以匹配当前代码

Confidence Interpretation

置信度解读

LevelMeaningAction
Definite100% certain (e.g., file not in TOC)Safe to remove
Likely90%+ certain (e.g., function never called)Review briefly, usually safe
Suspicious70%+ certain (e.g., dynamic code patterns)Manual verification required
等级含义操作建议
确定100%确定（例如：文件未在TOC中声明）可安全移除
可能90%+确定（例如：函数从未被调用）简要审查，通常可安全移除
可疑70%+确定（例如：动态代码模式）需要手动验证

Best Practices

最佳实践

  1. Start with definite issues — These are safe to fix immediately
  2. Check dynamic patterns — 
    _G
    , 
    rawget
    , 
    loadstring
    may hide usage
  3. Preserve intentional dead code — Mark with 
    -- KEEP:
    comment if needed
  4. Update docs after code changes — Run 
    docs.stale
    after refactoring
  1. 从确定的问题开始 — 这些问题可立即安全修复
  2. 检查动态模式 — 
    _G
    、
    rawget
    、
    loadstring
    可能会隐藏使用痕迹
  3. 保留有意保留的死代码 — 如有需要，使用
    -- KEEP:
    注释标记
  4. 代码变更后更新文档 — 重构后运行
    docs.stale