Go to file
Kirill Kalikin f436053a85 Readme 2026-11-14 14:50:18 +07:00
cmd/cleaner Implementation 2026-11-14 14:00:54 +07:00
internal embed keywords and trash templates 2026-11-14 14:17:19 +07:00
.gitignore Init 2026-11-14 12:16:53 +07:00
Makefile Fix linter 2026-11-14 14:36:56 +07:00
README.md Readme 2026-11-14 14:50:18 +07:00
go.mod Init 2026-11-14 12:16:53 +07:00

README.md

Название проекта

Краткое описание проекта: сервис/утилита на Go для обработки данных с использованием встроенных словарей и шаблонов (keywords).

Особенности архитектуры

В проекте используется стандартный пакет embed (Go 1.16+) для встраивания текстовых ресурсов (словаря words.txt) непосредственно в скомпилированный бинарный файл. Это позволяет распространять приложение в виде единого исполняемого файла без необходимости таскать за ним внешние директории со статикой.

Структура проекта

.
├── go.mod                   # Файл описания модуля и зависимостей
├── cmd/             
│   ├── cleaner/          
│       └── main.go          # Точка входа в приложение (если применимо)
└── internal/                # Приватный код приложения
    ├── keywords/            # Бизнес-логика работы со словами
    |   ├── templates/       # Директория со статическими ресурсами и шаблонами
    |   │   ├── words.txt    # Словарь удаляемых слов из названий файлов и папок
    |   │   └── trash.txt    # Словарь имен удаляемых файлов
    |   └── keywords.go      # Пакет работы с ключевыми словами
    └── renamer/
        └── keywords.go      # Пакет переименовывателя

Требования

  • Go версии 1.16 или выше (рекомендуется актуальная стабильная версия).

Установка и запуск

  1. Клонируйте репозиторий:

    git clone https://github.com
    cd ваш-проект
    
  2. Загрузите зависимости (если есть):

    go mod download
    
  3. Запустите проект:

    go run .
    

Сборка

Для компиляции в единый бинарный файл (все файлы из templates/ будут автоматически вшиты внутрь):

go build -o app .

После сборки вы можете перенести файл app на любой сервер — папка templates/ рядом с ним больше не потребуется.

Работа с ресурсами (templates/)

Поскольку в Go директива //go:embed запрещает обращение к родительским директориям (../), доступ к файлам из вложенных пакетов (таких как internal/keywords) реализован через пакет templates:

  • Все текстовые файлы хранятся в /templates.
  • Файл /templates/embed.go считывает их на этапе компиляции и предоставляет через функции-геттеры (например, templates.GetWords()), что защищает данные от случайного изменения во время работы программы.
  • При добавлении новых текстовых файлов в templates/ необходимо также добавить соответствующую директиву //go:embed и функцию доступа в templates/embed.go.