# project-cleaner

> 清理项目中的临时文件、缓存和构建产物，释放磁盘空间。**核心原则**：预览模式确认后执行，避免误删重要文件。

- Author: Kirky-X
- Repository: Kirky-X/DevCraft-AI
- Version: 20260115150227
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/Kirky-X/DevCraft-AI
- Web: https://mule.run/skillshub/@@Kirky-X/DevCraft-AI~project-cleaner:20260115150227

---

# 项目目录清理技能

清理项目中的临时文件、缓存和构建产物，释放磁盘空间。**核心原则**：预览模式确认后执行，避免误删重要文件。

## Use When

- 释放磁盘空间（"清理构建产物以释放空间"）
- 移除缓存（"清除所有 Python 缓存文件和 __pycache__"）
- 准备发布（"打包前清理"）
- 移除临时文件（"删除项目中所有临时文件"）
- CI/CD 清理（"CI 运行后清理工作区"）

## Quick Start

### 预览清理（推荐先运行）

```bash
# 预览当前目录的清理内容
python scripts/cleanup.py /path/to/project

# 预览并显示文件大小
python scripts/cleanup.py /path/to/project --verbose
```

### 执行清理

```bash
# 执行清理（删除文件）
python scripts/cleanup.py /path/to/project --execute
```

## 清理模式

| 模式 | 说明 | 包含内容 |
|------|------|----------|
| `all` | 完整清理（默认） | 所有类型 |
| `build` | 只清理构建产物 | `dist/` `build/` `target/` `.next/` `.nuxt/` |
| `cache` | 只清理缓存 | `__pycache__/` `.cache/` `node_modules/.cache/` |
| `temp` | 只清理临时文件 | `*.tmp` `*.temp` `*.bak` `*~` |

## 决策流程

```
需要清理什么？
     │
     ├─→ 释放磁盘空间 ──→ 预览待删除文件 ──→ 确认后执行
     │
     ├─→ 清理构建产物 ──→ 只清理 build/ dist/ target/ ──→ 预览确认
     │
     ├─→ 清理缓存文件 ──→ 只清理 __pycache__ .cache node_modules/.cache
     │
     └─→ 清理所有临时文件 ──→ 完整扫描 ──→ 预览确认
```

## 命令参数

| 参数 | 说明 | 示例 |
|------|------|------|
| `--execute` | 执行清理（否则只预览） | `--execute` |
| `--verbose` | 显示详细信息 | `--verbose` |
| `--mode MODE` | 清理模式 | `--mode build` |
| `--include-tests` | 包含测试文件 | `--include-tests` |
| `--no-gitignore` | 不更新 .gitignore | `--no-gitignore` |

## 常用场景

| 场景 | 命令 |
|------|------|
| 释放磁盘空间 | `python scripts/cleanup.py . --verbose && --execute` |
| 只清理构建产物 | `python scripts/cleanup.py . --mode build --execute` |
| 清理后重新构建 | `cleanup && npm run build` |
| 清理测试覆盖率 | `python scripts/cleanup.py . --execute --include-tests` |
| CI/CD 定时清理 | 使用 GitHub Actions workflow |

## 参考文档

- [语言特定规则](references/language-rules.md) - 各语言清理目标
- [风险控制](references/safety.md) - 敏感文件保护和恢复

## 最佳实践

### ✅ 推荐做法

1. **先预览后执行** - 始终先运行预览，确认列表正确
2. **定期清理** - 每周或每次发布后清理
3. **更新 .gitignore** - 使用 `--update-gitignore` 参数
4. **提交清理日志** - 将清理纳入版本控制

### ❌ 避免做法

1. **直接执行清理** - 未预览可能导致误删
2. **删除 node_modules/** - 重新安装非常耗时
3. **忽略敏感文件** - .env 等需要特别保护
4. **清理 .git/** - 会破坏版本控制