返回技能列表

clean-codebase

pjt222
更新于 5 days ago
35 次查看
17
2
17
在 GitHub 上查看
文档api

关于

This skill performs automated codebase cleanup by removing dead code and unused imports, fixing lint warnings, and normalizing formatting without altering business logic. It's ideal for addressing technical debt accumulated during rapid development when static analysis tools report fixable hygiene issues. Use it for maintenance tasks like eliminating clutter and inconsistencies, but not for architectural refactoring or bug fixes.

快速安装

Claude Code

推荐
主要方式
npx skills add pjt222/agent-almanac -a claude-code
插件命令备选方式
/plugin add https://github.com/pjt222/agent-almanac
Git 克隆备选方式
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/clean-codebase

在 Claude Code 中复制并粘贴此命令以安装该技能

技能文档

clean-codebase

用時

用此技於庫積污者:

  • 速開發中 lint 警已累
  • 未用之引與變雜亂諸檔
  • 死碼徑存而未除
  • 諸檔之式不一
  • 靜析具報可補之問

勿用於構重構、修訛、或業理之變。此技專於潔與自動之清。

ParameterTypeRequiredDescription
codebase_pathstringYesAbsolute path to codebase root
languagestringYesPrimary language (js, python, r, rust, etc.)
cleanup_modeenumNosafe (default) or aggressive
run_testsbooleanNoRun test suite after cleanup (default: true)
backupbooleanNoCreate backup before deletion (default: true)

第一步:清前之評

量當前之態以後驗改。

# Count lint warnings by severity
lint_tool --format json > lint_before.json

# Count lines of code
cloc . --json > cloc_before.json

# List unused symbols (language-dependent)
# JavaScript/TypeScript: ts-prune or depcheck
# Python: vulture
# R: lintr unused function checks

得: 基量存於 lint_before.jsoncloc_before.json

敗則: 若 lint 具不得,略自動之補而專於手察

第二步:補自動 lint 警

施安之自補(間、引、分、尾空)。

JavaScript/TypeScript:

eslint --fix .
prettier --write .

Python:

black .
isort .
ruff check --fix .

R:

Rscript -e "styler::style_dir('.')"

Rust:

cargo fmt
cargo clippy --fix --allow-dirty

得: 諸安 lint 警已解;諸檔式一

敗則: 若自補引測敗,退變而升

第三步:識死碼徑

用靜析尋未引之函、未用之變、孤之檔。

JavaScript/TypeScript:

ts-prune | tee dead_code.txt
depcheck | tee unused_deps.txt

Python:

vulture . | tee dead_code.txt

R:

Rscript -e "lintr::lint_dir('.', linters = lintr::unused_function_linter())"

通法

  1. grep 函之定
  2. grep 函之呼
  3. 報定而未呼之函

得: dead_code.txt 列未用之函、變、檔

敗則: 若靜析具不得,手察近之提交史尋孤碼

第四步:除未用之引

清引區,除永未用之包。

JavaScript:

eslint --fix --rule 'no-unused-vars: error'

Python:

autoflake --remove-all-unused-imports --in-place --recursive .

R:

# Manual review: grep for library() calls, check if package used
grep -r "library(" . | cut -d: -f2 | sort | uniq

得: 諸未用之引句皆除

敗則: 若除引而建敗,間接有用——復而書之

第五步:除死碼(依模)

安模(默):

  • 只除明標為棄之碼
  • 除已注釋之碼塊(若逾十行且逾六月)
  • 除引已畢之 TODO 注

侵模(擇入):

  • 除第三步所識諸未用之函
  • 除零引之私法
  • 除棄功之旗

每候刪:

  1. 驗庫中零引
  2. 察 git 史近之動(若三十日內改則略)
  3. 除碼而加條入 CLEANUP_LOG.md

得: 死碼已除;CLEANUP_LOG.md 書諸除

敗則: 若不確碼真死,移入 archive/ 而非除

第六步:式之一

確諸檔式一(雖 lint 不捕)。

  1. 一行末(LF 抑 CRLF)
  2. 確檔末單新行
  3. 除尾空
  4. 一縮(空抑 tab,縮之寬)
# Example: Fix line endings and trailing whitespace
find . -type f -name "*.js" -exec sed -i 's/\r$//' {} +
find . -type f -name "*.js" -exec sed -i 's/[[:space:]]*$//' {} +

得: 諸檔循一式

敗則: 若 sed 破二進之檔,略而書之

第七步:行測

驗清未破功。

# Language-specific test command
npm test              # JavaScript
pytest                # Python
R CMD check           # R
cargo test            # Rust

得: 諸測皆通(或同清前之敗)

敗則: 漸退變以識破者,而升

第八步:生清報

書諸變以察。

# Codebase Cleanup Report

**Date**: YYYY-MM-DD
**Mode**: safe | aggressive
**Language**: <language>

## Metrics

| Metric | Before | After | Change |
|--------|--------|-------|--------|
| Lint warnings | X | Y | -Z |
| Lines of code | A | B | -C |
| Unused imports | D | 0 | -D |
| Dead functions | E | F | -G |

## Changes Applied

1. Fixed X lint warnings (automated)
2. Removed Y unused imports
3. Deleted Z lines of dead code (see CLEANUP_LOG.md)
4. Normalized formatting across W files

## Escalations

- [Issue description requiring human review]
- [Uncertain deletion moved to archive/]

## Validation

- [x] All tests pass
- [x] Backup created: backup_YYYYMMDD/
- [x] CLEANUP_LOG.md updated

得: 報存於項目根之 CLEANUP_REPORT.md

敗則:(無——無論結果皆生報)

清後:

  • 諸測皆通(或同前之敗)
  • 無新 lint 警引入
  • 除前已備
  • CLEANUP_LOG.md 書諸除碼
  • 清報已生附量
  • git diff 已察無外變
  • CI 管已通

  1. 除仍以反射用之碼:靜析漏動呼(如 eval()、元編程)。必察 git 史。

  2. 破隱依:除依所用之引。每除引後行測。

  3. 刪活功之旗:雖當枝未用,或於他境活。察部署之設。

  4. 過侵之式:如 blackprettier 可重式生冗 diff。設具合項目之風。

  5. 忽測覆:無測之庫不可安清。若覆低,先升補測。

  6. 不備:除前必建 backup_YYYYMMDD/,雖用 git。

  7. 混系上之誤 R 二:於 WSL 或 Docker,Rscript 或解為跨臺之包而非原生 R。以 which Rscript && Rscript --version 察。宜用原生 R 二(如 Linux/WSL 上之 /usr/local/bin/Rscript)以信。見 Setting Up Your Environment 以 R 路之設。

GitHub 仓库

pjt222/agent-almanac
路径: i18n/wenyan/skills/clean-codebase
0
agentsagentskillsai-assisted-developmentclaude-codeskillsteams

相关推荐技能

railway-docs

文档

Railway Docs Skill可实时获取最新的Railway官方文档,确保回答的准确性。当开发者询问Railway功能特性、工作原理或分享docs.railway.com链接时,应优先使用此技能。它通过专门的LLM优化文档源提供最新信息,避免依赖过时记忆来回答技术问题。

查看技能

n8n-code-python

文档

该Skill为在n8n平台的Python代码节点中编写代码提供专家指导,特别适用于需要使用_input/_json/_node语法、Python标准库或了解n8n中Python限制的场景。它强调JavaScript应作为首选方案,仅当需要特定Python功能或对Python语法更熟悉时才使用Python。Skill提供了快速入门模板和关键注意事项,帮助开发者在n8n中高效编写Python代码。

查看技能

archon

文档

Archon Skill为开发者提供了基于RAG的语义搜索和项目任务管理功能,可通过REST API访问知识库。它支持文档搜索、网站爬取、文件上传和版本控制,适用于技术文档查询和项目管理场景。首次使用时需要配置Archon主机地址,建议在处理外部文档时优先使用该Skill。

查看技能

n8n-code-javascript

文档

这个Skill为n8n工作流中的JavaScript代码节点提供专业指导,涵盖数据处理、HTTP请求和日期操作等核心场景。它详细解释了如何正确使用n8n特有的`$input`/`$json`语法、`$helpers`工具以及DateTime对象,并包含关键的错误排查和模式选择建议。开发者通过该Skill能快速掌握Code节点的正确返回格式、数据访问方法和常见陷阱解决方案。

查看技能