unused-files-cleaner/README.md

A CLI tool to clean unused files in projects

# Unused Files Cleaner

[English (Current) | [中文](./README.zh-CN.md)]

A command-line tool for scanning and cleaning empty files in your project.

### Features

- Scan directories for empty files
- Preview files before deletion
- Ignore specific files or directories
- Detailed logging mode
- Safe deletion with confirmation
- Support for custom ignore patterns

### Installation

```bash
# Clone the repository
git clone https://github.com/yourusername/unused-files-cleaner.git

# Navigate to the project directory
cd unused-files-cleaner

# Install dependencies
pnpm install

# Build the project
pnpm run build

# Install globally
npm link
```

### Usage

```bash
# Basic usage (scan current directory)
unused-files-cleaner

# Scan specific directory
unused-files-cleaner -d ./your-project

# Preview mode (no deletion)
unused-files-cleaner -p

# Show detailed logs
unused-files-cleaner -v

# Ignore specific patterns
unused-files-cleaner -i "*.log,*.tmp"

# Combine multiple options
unused-files-cleaner -d ./your-project -p -v -i "*.log,*.tmp"
```

### Command Options

- `-d, --dir <path>`: Specify the directory to scan (default: current directory)
- `-p, --preview`: Preview mode - only show files to be deleted
- `-i, --ignore <patterns>`: Patterns to ignore (comma separated)
- `-v, --verbose`: Show detailed logs

### Default Ignored Patterns

The following patterns are ignored by default:

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

### Safety Features

- Preview mode available
- Confirmation required before deletion
- Detailed error reporting
- Verbose logging option

### License

MIT