MCP HubMCP Hub
Retour aux compétences

clean-codebase

pjt222
Mis à jour 5 days ago
31 vues
17
2
17
Voir sur GitHub
Documentationapi

À propos

Cette compétence effectue un nettoyage automatisé du code en supprimant le code mort et les imports inutilisés, en corrigeant les avertissements de lint et en normalisant la mise en forme sans altérer la logique métier. Elle est idéale pour résorber la dette technique accumulée lors d'un développement rapide, lorsque les outils d'analyse statique signalent des problèmes d'hygiène corrigeables. Utilisez-la pour des tâches de maintenance comme éliminer l'encombrement et les incohérences, mais pas pour du refactoring architectural ou la correction de bugs.

Installation rapide

Claude Code

Recommandé
Principal
npx skills add pjt222/agent-almanac -a claude-code
Commande PluginAlternatif
/plugin add https://github.com/pjt222/agent-almanac
Git CloneAlternatif
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/clean-codebase

Copiez et collez cette commande dans Claude Code pour installer cette compétence

Documentation

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 路之設。

Dépôt GitHub

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

Compétences associées

railway-docs

Documentation

Cette compétence récupère la documentation actuelle de Railway pour répondre aux questions sur les fonctionnalités, le fonctionnement ou des URL spécifiques de la documentation. Elle garantit que les développeurs reçoivent des informations précises et à jour directement depuis les sources officielles de Railway. Utilisez-la lorsque les utilisateurs demandent comment fonctionne Railway ou font référence à la documentation de Railway.

Voir la compétence

n8n-code-python

Documentation

Cette compétence Claude offre un accompagnement expert pour écrire du code Python dans les nœuds Code de n8n, en particulier pour utiliser la bibliothèque standard de Python et travailler avec la syntaxe spéciale de n8n comme `_input`, `_json` et `_node`. Elle aide les développeurs à comprendre les limites de Python dans n8n et recommande d'utiliser JavaScript pour la plupart des workflows, tout en proposant des solutions Python pour des besoins spécifiques de transformation de données.

Voir la compétence

archon

Documentation

La compétence Archon offre une recherche sémantique alimentée par RAG et une gestion de projet via une API REST. Utilisez-la pour interroger la documentation, gérer des projets/tâches hiérarchiques et effectuer de la recherche de connaissances avec des capacités de téléchargement de documents. Priorisez toujours Archon en premier lors de la recherche dans une documentation externe avant d'utiliser d'autres sources.

Voir la compétence

n8n-code-javascript

Documentation

Cette compétence Claude fournit des conseils d'expert pour écrire du code JavaScript dans les nœuds Code d'n8n. Elle couvre la syntaxe essentielle spécifique à n8n comme les variables `$input`/`$json`, les assistants HTTP et la gestion des DateTime, tout en résolvant les erreurs courantes. Utilisez-la lors du développement de workflows n8n nécessitant un traitement JavaScript personnalisé dans les nœuds Code.

Voir la compétence