cleaner/README.md

138 lines
5.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Cleaner
Go CLI-утилита для нормализации имён файлов и папок путём удаления спам-ключевых слов и удаления известных мусорных файлов.
## Обзор
Инструмент рекурсивно обходит целевую директорию, удаляет невалидные фрагменты имён по правилам из файла замен и удаляет файлы, совпадающие с точным списком мусора, например служебные метаданные ОС или кэши превью.
Подходит для задач очистки, когда в загруженных материалах встречаются рекламные подписи, названия сервисов, повторяющиеся служебные строки или дублирующиеся расширения в именах файлов.
## Возможности
- рекурсивный обход целевой директории;
- удаление или замена фрагментов в именах файлов и папок через один словарь правил;
- поиск без учёта регистра по умолчанию;
- удаление точных имён файлов по списку мусора;
- нормализация повторяющихся расширений через `replacements.txt`;
- безопасный режим предпросмотра через `--dry-run`;
- автоматическое создание файлов словарей при отсутствии.
## Требования
- Go 1.22+
## Быстрый старт
### Сборка
```bash
go build -o cleaner ./cmd/cleaner
```
### Предпросмотр без изменения файлов
```bash
./cleaner --dir /path/to/content --dry-run
```
### Применение изменений
```bash
./cleaner --dir /path/to/content
```
## Конфигурация
По умолчанию программа читает словари из текущей рабочей директории. Пути можно переопределить явно:
```bash
./cleaner \
--dir ./content \
--trash-file ./config/trash.txt \
--replace-file ./config/replacements.txt
```
Если файлы отсутствуют, программа создаёт их на основе встроенных шаблонов и продолжает работу.
## Флаги CLI
```bash
./cleaner --help
```
Доступные параметры:
- `--dir` — корневая папка для обработки;
- `--trash-file` — список точных имён файлов для удаления;
- `--replace-file` — список правил вида `token` для удаления или `old -> new` для замены;
- `--dry-run` — показать действия без изменения файлов;
- `-i` / `--ignore-case` — включить поиск без учёта регистра (по умолчанию);
- `--version` — вывести метаданные сборки.
## Формат словарей
### `trash.txt`
```text
# точные имена файлов для удаления
# комментарии начинаются с #
.DS_Store
Thumbs.db
desktop.ini
```
Совпадающие имена будут удалены с диска.
### `replacements.txt`
```text
# правила удаления и замены
# формат: token для удаления или old -> new для замены
# комментарии начинаются с #
[SWBAND.CO]
VIP
.mp4.mp4 -> .mp4
.wmv.mp4 -> .mp4
```
Это удобно для исправления повторяющихся расширений и типовых мусорных суффиксов, например:
- `movie[SWBAND.CO].mp4` -> `movie.mp4`
- `movie.mp4.mp4` -> `movie.mp4`
- `movie.wmv.mp4` -> `movie.mp4`
## Структура проекта
```text
.
├── cmd/
│ └── cleaner/
│ └── main.go
├── internal/
│ ├── keywords/
│ │ ├── templates/
│ │ │ ├── trash.txt
│ │ │ └── replacements.txt
│ │ └── keywords.go
│ └── renamer/
│ └── renamer.go
├── go.mod
├── README.md
├── Makefile
└── bin/
└── cleaner
```
## Рекомендации по безопасной работе
- сначала проверяйте запуск на копии данных;
- используйте `--dry-run` перед массовой очисткой;
- храните пользовательские словари под контролем версий;
- проверяйте правила удаления и замены перед запуском на больших архивах;
- не указывайте `--dir` на важные системные папки.
## Примечания
Шаблоны словарей встроены в бинарник через Go `embed`, но приложение создаёт локальные файлы, если они отсутствуют. Это сохраняет бинарник самодостаточным и одновременно позволяет использовать пользовательские правила удаления и замены.