unused-files-cleaner/README.zh-CN.md

A CLI tool to clean unused files in projects

# Unused Files Cleaner

[[English](./README.md) | 中文 (当前)]

一个用于扫描和清理项目中空文件的命令行工具。

### 功能特点

- 扫描目录中的空文件
- 删除前预览功能
- 支持忽略特定文件或目录
- 详细的日志模式
- 安全删除（需确认）
- 支持自定义忽略模式

### 安装

```bash
# 克隆仓库
git clone https://github.com/yourusername/unused-files-cleaner.git

# 进入项目目录
cd unused-files-cleaner

# 安装依赖
pnpm install

# 构建项目
pnpm run build

# 全局安装
npm link
```

### 使用方法

```bash
# 基本用法（扫描当前目录）
unused-files-cleaner

# 扫描指定目录
unused-files-cleaner -d ./your-project

# 预览模式（不删除文件）
unused-files-cleaner -p

# 显示详细日志
unused-files-cleaner -v

# 忽略特定文件模式
unused-files-cleaner -i "*.log,*.tmp"

# 组合多个选项
unused-files-cleaner -d ./your-project -p -v -i "*.log,*.tmp"
```

### 命令选项

- `-d, --dir <path>`: 指定要扫描的目录（默认：当前目录）
- `-p, --preview`: 预览模式 - 只显示要删除的文件
- `-i, --ignore <patterns>`: 要忽略的文件模式（用逗号分隔）
- `-v, --verbose`: 显示详细日志

### 默认忽略的文件模式

以下文件模式默认被忽略：

- `**/node_modules/**`
- `**/.git/**`
- `**/dist/**`
- `**/build/**`
- `**/.DS_Store`

### 安全特性

- 提供预览模式
- 删除前需要确认
- 详细的错误报告
- 可选的详细日志

### 开源协议

MIT