返回技能列表

clean-codebase

pjt222
更新于 2 days ago
8 次查看
17
2
17
在 GitHub 上查看
开发general

关于

This skill cleans up technical debt by removing dead code, fixing lint warnings, and standardizing formatting without altering business logic. Use it when unused imports, inconsistent formatting, or static analysis warnings have accumulated during rapid development. It focuses on code hygiene improvements while maintaining the existing architecture.

快速安装

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 中复制并粘贴此命令以安装该技能

技能文档

Codebasis bereinigen

Wann verwenden

Diesen Skill verwenden wenn eine Codebasis Hygieneschulden angehaeuft hat:

  • Lint-Warnungen haben sich waehrend schneller Entwicklung angehaeuft
  • Ungenutzte Imports und Variablen ueberladen Dateien
  • Tote Codepfade existieren, wurden aber nie entfernt
  • Formatierung ist ueber Dateien hinweg inkonsistent
  • Statische Analysewerkzeuge melden behebbare Probleme

NICHT verwenden fuer architektonisches Refactoring, Fehlerbehebungen oder Aenderungen der Geschaeftslogik. Dieser Skill konzentriert sich ausschliesslich auf Hygiene und automatisierte Bereinigung.

Eingaben

ParameterTypErforderlichBeschreibung
codebase_pathstringJaAbsoluter Pfad zum Codebasis-Stammverzeichnis
languagestringJaPrimaersprache (js, python, r, rust usw.)
cleanup_modeenumNeinsafe (Standard) oder aggressive
run_testsbooleanNeinTestsuite nach Bereinigung ausfuehren (Standard: true)
backupbooleanNeinBackup vor Loeschung erstellen (Standard: true)

Vorgehensweise

Schritt 1: Vorbewertung

Den aktuellen Zustand messen um Verbesserungen spaeter zu quantifizieren.

# Lint-Warnungen nach Schweregrad zaehlen
lint_tool --format json > lint_before.json

# Codezeilen zaehlen
cloc . --json > cloc_before.json

# Ungenutzte Symbole auflisten (sprachabhaengig)
# JavaScript/TypeScript: ts-prune oder depcheck
# Python: vulture
# R: lintr-Pruefung ungenutzter Funktionen

Erwartet: Ausgangskennzahlen in lint_before.json und cloc_before.json gespeichert

Bei Fehler: Wenn das Lint-Werkzeug nicht gefunden wird, automatisierte Korrekturen ueberspringen und auf manuelle Pruefung konzentrieren

Schritt 2: Automatisierte Lint-Warnungen beheben

Sichere automatisierte Korrekturen anwenden (Abstande, Anfuehrungszeichen, Semikolons, nachfolgende Leerzeichen).

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

Erwartet: Alle sicheren Lint-Warnungen behoben; Dateien konsistent formatiert

Bei Fehler: Wenn automatisierte Korrekturen Testfehler einfuehren, Aenderungen rueckgaengig machen und eskalieren

Schritt 3: Tote Codepfade identifizieren

Statische Analyse verwenden um unreferenzierte Funktionen, ungenutzte Variablen und verwaiste Dateien zu finden.

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())"

Allgemeiner Ansatz:

  1. Nach Funktionsdefinitionen suchen
  2. Nach Funktionsaufrufen suchen
  3. Funktionen melden die definiert aber nie aufgerufen werden

Erwartet: dead_code.txt listet ungenutzte Funktionen, Variablen und Dateien auf

Bei Fehler: Wenn das statische Analysewerkzeug nicht verfuegbar ist, manuell die juengste Commit-Historie auf verwaisten Code pruefen

Schritt 4: Ungenutzte Imports entfernen

Importbloecke bereinigen indem Referenzen auf nie verwendete Pakete entfernt werden.

JavaScript:

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

Python:

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

R:

# Manuelle Pruefung: nach library()-Aufrufen suchen, pruefen ob Paket verwendet wird
grep -r "library(" . | cut -d: -f2 | sort | uniq

Erwartet: Alle ungenutzten Import-Anweisungen entfernt

Bei Fehler: Wenn das Entfernen von Imports den Build bricht, wurden sie indirekt verwendet — wiederherstellen und dokumentieren

Schritt 5: Toten Code entfernen (modusabhaengig)

Sicherer Modus (Standard):

  • Nur explizit als veraltet markierten Code entfernen
  • Auskommentierte Codebloecke entfernen (wenn >10 Zeilen und >6 Monate alt)
  • TODO-Kommentare entfernen die auf abgeschlossene Issues verweisen

Aggressiver Modus (opt-in):

  • Alle in Schritt 3 als ungenutzt identifizierten Funktionen entfernen
  • Private Methoden mit null Referenzen entfernen
  • Feature-Flags fuer veraltete Features entfernen

Fuer jede Loeschkandidatin:

  1. Null Referenzen in der Codebasis verifizieren
  2. Git-Historie auf juengste Aktivitaet pruefen (ueberspringen wenn in den letzten 30 Tagen geaendert)
  3. Code entfernen und Eintrag in CLEANUP_LOG.md hinzufuegen

Erwartet: Toter Code entfernt; CLEANUP_LOG.md dokumentiert alle Loeschungen

Bei Fehler: Wenn unsicher ob Code wirklich tot ist, in ein archive/-Verzeichnis verschieben statt zu loeschen

Schritt 6: Formatierung vereinheitlichen

Konsistente Formatierung ueber alle Dateien sicherstellen (auch wenn nicht von Lintern erfasst).

  1. Zeilenenden normalisieren (LF vs CRLF)
  2. Einzelnen Zeilenumbruch am Dateiende sicherstellen
  3. Nachfolgende Leerzeichen entfernen
  4. Einrueckung normalisieren (Leerzeichen vs Tabs, Einrueckungstiefe)
# Beispiel: Zeilenenden und nachfolgende Leerzeichen beheben
find . -type f -name "*.js" -exec sed -i 's/\r$//' {} +
find . -type f -name "*.js" -exec sed -i 's/[[:space:]]*$//' {} +

Erwartet: Alle Dateien folgen konsistenten Formatierungskonventionen

Bei Fehler: Wenn sed Binaerdateien beschaedigt, ueberspringen und dokumentieren

Schritt 7: Tests ausfuehren

Validieren dass die Bereinigung die Funktionalitaet nicht beeintraechtigt hat.

# Sprachspezifischer Testbefehl
npm test              # JavaScript
pytest                # Python
R CMD check           # R
cargo test            # Rust

Erwartet: Alle Tests bestehen (oder dieselben Fehler wie vor der Bereinigung)

Bei Fehler: Aenderungen inkrementell rueckgaengig machen um die brechende Aenderung zu identifizieren, dann eskalieren

Schritt 8: Bereinigungsbericht erstellen

Alle Aenderungen zur Pruefung dokumentieren.

# Codebasis-Bereinigungsbericht

**Datum**: JJJJ-MM-TT
**Modus**: safe | aggressive
**Sprache**: <Sprache>

## Kennzahlen

| Kennzahl | Vorher | Nachher | Aenderung |
|----------|--------|---------|-----------|
| Lint-Warnungen | X | Y | -Z |
| Codezeilen | A | B | -C |
| Ungenutzte Imports | D | 0 | -D |
| Tote Funktionen | E | F | -G |

## Angewandte Aenderungen

1. X Lint-Warnungen behoben (automatisiert)
2. Y ungenutzte Imports entfernt
3. Z Zeilen toten Code geloescht (siehe CLEANUP_LOG.md)
4. Formatierung ueber W Dateien vereinheitlicht

## Eskalierungen

- [Problembeschreibung die menschliche Pruefung erfordert]
- [Unsichere Loeschung nach archive/ verschoben]

## Validierung

- [x] Alle Tests bestehen
- [x] Backup erstellt: backup_JJJJMMTT/
- [x] CLEANUP_LOG.md aktualisiert

Erwartet: Bericht als CLEANUP_REPORT.md im Projektstammverzeichnis gespeichert

Bei Fehler: (Entfaellt — Bericht unabhaengig vom Ergebnis erstellen)

Validierung

Nach der Bereinigung:

  • Alle Tests bestehen (oder dieselben Fehler wie vorher)
  • Keine neuen Lint-Warnungen eingefuehrt
  • Backup vor allen Loeschungen erstellt
  • CLEANUP_LOG.md dokumentiert allen entfernten Code
  • Bereinigungsbericht mit Kennzahlen erstellt
  • Git-Diff auf unerwartete Aenderungen geprueft
  • CI-Pipeline besteht

Haeufige Stolperfallen

  1. Code entfernen der noch ueber Reflexion verwendet wird: Statische Analyse uebersieht dynamische Aufrufe (z.B. eval(), Metaprogrammierung). Immer Git-Historie pruefen.

  2. Implizite Abhaengigkeiten brechen: Imports entfernen die von Abhaengigkeiten verwendet wurden. Nach jeder Import-Entfernung Tests ausfuehren.

  3. Feature-Flags fuer aktive Features loeschen: Auch wenn im aktuellen Branch ungenutzt, koennen Feature-Flags in anderen Umgebungen aktiv sein. Deployment-Konfigurationen pruefen.

  4. Ueberaggressive Formatierung: Werkzeuge wie black oder prettier koennen Code auf eine Weise umformatieren die unnoetige Diffs ausloest. Werkzeuge so konfigurieren dass sie zum Projektstil passen.

  5. Testabdeckung ignorieren: Codebasen ohne Tests koennen nicht sicher bereinigt werden. Wenn die Abdeckung niedrig ist, zuerst fuer Testergaenzungen eskalieren.

  6. Kein Backup erstellen: Immer ein backup_JJJJMMTT/-Verzeichnis erstellen bevor irgendetwas geloescht wird, auch bei Verwendung von Git.

  7. Falsches R-Binary auf Hybrid-Systemen: Unter WSL oder Docker kann Rscript einen plattformuebergreifenden Wrapper statt nativem R aufloesen. Mit which Rscript && Rscript --version pruefen. Das native R-Binary bevorzugen (z.B. /usr/local/bin/Rscript unter Linux/WSL) fuer Zuverlaessigkeit. Fuer die R-Pfadkonfiguration siehe Setting Up Your Environment.

Verwandte Skills

  • tidy-project-structure — Verzeichnislayout organisieren, READMEs aktualisieren
  • repair-broken-references — Tote Links und Imports reparieren
  • escalate-issues — Komplexe Probleme an Spezialisten weiterleiten

GitHub 仓库

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

相关推荐技能

qmd

开发

这是一个本地搜索和索引的CLI工具,支持BM25、向量搜索和重排序功能。开发者可以用它快速索引本地文件(如Markdown文档)并进行混合搜索,特别适合代码库或文档的本地检索。它还提供MCP模式,能轻松集成到Claude开发环境中使用。

查看技能

subagent-driven-development

开发

该Skill用于在当前会话中执行包含独立任务的实施计划,它会为每个任务分派一个全新的子代理并在任务间进行代码审查。这种"全新子代理+任务间审查"的模式既能保障代码质量,又能实现快速迭代。适合需要在当前会话中连续执行独立任务,并希望在每个任务后都有质量把关的开发场景。

查看技能

mcporter

开发

mcporter Skill 让开发者能在Claude中直接管理和调用MCP服务器。它支持列出可用服务器、调用工具、处理OAuth认证以及管理服务器守护进程。开发者可以通过命令行式交互快速执行`mcporter list`查看服务器,或使用`mcporter call`直接调用工具,简化了MCP工作流程。

查看技能

adk-deployment-specialist

开发

这是一个用于部署和编排Google Vertex AI ADK智能体的Claude Skill,专为构建生产级多智能体系统而设计。它支持通过A2A协议进行智能体通信,提供代码执行沙箱和记忆库功能,并能处理智能体发现与任务提交。当开发者需要部署ADK智能体或编排多智能体协作时,可使用此Skill来简化Vertex AI Agent Engine的部署流程。

查看技能