Клиентские скрипты управления Конструктором комментариев
В данном каталоге сосредоточена изолированная клиентская логика веб-страницы Конструктора комментариев. Все скрипты написаны на чистом JavaScript (JS) и разделены по функциональным задачам для удобства сопровождения и развития интерфейса.
Структура папки
eaststandart.github.io/
└── assets/
└── js/
└── comment-builder/
├── 01-comment-notify.js # Модуль уведомлений и статусов конструктора
├── 02-comment-auth.js # Модуль авторизации и контроля доступа
├── 03-comment-form.js # Модуль инициализации и сброса формы
├── 04-drafts-parser.js # Модуль разбора структуры черновиков
├── 05-drafts-loader.js # Модуль загрузки списка черновиков
├── 06-drafts-injector.js # Модуль восстановления выбранного черновика
├── 07-drafts-delete.js # Модуль управления удалением черновиков
├── 08-comment-validation.js # Модуль проверки данных комментария
├── 09-comment-lock.js # Модуль блокировки формы
├── 10-media-blocks.js # Модуль создания и удаления медиаблоков
├── 11-media-files.js # Модуль управления данными медиафайлов
├── 12-media-files-ui.js # Модуль интерфейса списка медиафайлов
├── 13-media-upload.js # Модуль загрузки медиафайлов
├── 14-comment-markdown.js # Модуль формирования Markdown комментария
├── 15-comment-github-save.js # Модуль сохранения Markdown через GitHub API
└── 16-comment-submit.js # Модуль отправки комментария и сохранения черновика
Контур сквозной цепочки скриптов
Файлы пронумерованы и подключаются в указанном порядке. Нумерация отражает порядок загрузки модулей, а схема показывает основные связи между ними и движение данных в конструкторе.
[02-comment-auth.js] ─────────────► Проверка токена и доступа преподавателя
│
▼
[03-comment-form.js] ─────────────► Инициализация интерфейса конструктора
│
┌─────────┴──────────┐
│ │
▼ ▼
[05-drafts-loader.js] [10-media-blocks.js]
Загрузка списка Создание фото- и
черновиков видеоблоков
│ │
▼ ▼
[04-drafts-parser.js] [11-media-files.js]
Разбор Markdown Обработка выбранных
и Front Matter медиафайлов
│ │
▼ ▼
[06-drafts-injector.js] [12-media-files-ui.js]
Восстановление данных Отображение и управление
черновика в форме списком файлов
│ │
└─────────┬──────────┘
│
▼
[08-comment-validation.js] ──────► Проверка данных перед сохранением
│
▼
[16-comment-submit.js] ──────────► Координация сохранения комментария
│
┌─────────┴──────────┐
│ │
▼ ▼
[14-comment-markdown.js] [09-comment-lock.js]
Формирование Markdown Блокировка формы
│
▼
[15-comment-github-save.js] ───────────► Сохранение Markdown в GitHub
│
▼
[13-media-upload.js] ──────────────────► Загрузка медиафайлов в GitHub
│
▼
Обновление Markdown после загрузки
медиафайлов и завершение операции
[01-comment-notify.js] ────────────────► Уведомления и статусы на этапах работы
[07-drafts-delete.js] ────────────────► Управление признаком удаления черновика
Спецификация скриптов фронтенда
01-comment-notify.js(Модуль уведомлений и статусов конструктора)- Назначение: Отображение пользователю уведомлений о ходе операций, их успешном завершении и возникших ошибках.
- Логика работы: Выводит сообщения заданного типа и управляет доступностью кнопки выхода во время заблокированных операций конструктора.
02-comment-auth.js(Модуль авторизации и контроля доступа)- Назначение: Управление сессией преподавателя, проверка GitHub-токена и подтверждение права доступа к конструктору.
- Логика работы: Выполняет автоматический вход при наличии сохранённого токена или проверяет введённый токен через GitHub API. Получает логин пользователя, проверяет его по списку разрешённых преподавателей, сохраняет данные авторизации в
localStorageи запускает инициализацию конструктора.
03-comment-form.js(Модуль инициализации и сброса формы)- Назначение: Подготовка рабочего интерфейса конструктора и управление состоянием формы.
- Логика работы: Инициализирует элементы интерфейса, обрабатывает состояние полей и выполняет сброс формы для создания нового комментария.
04-drafts-parser.js(Модуль разбора структуры черновиков)- Назначение: Преобразование Markdown-файла черновика в структурированные данные для дальнейшего восстановления в форме.
- Логика работы: Разбирает Front Matter и содержимое Markdown, извлекает текстовые поля комментария, параметры публикации, фото- и видеоблоки, имена файлов и сведения об их отображении.
05-drafts-loader.js(Модуль загрузки списка черновиков)- Назначение: Получение списка сохранённых черновиков преподавателя из буферного репозитория.
- Логика работы: Обращается к GitHub Contents API, получает файлы из каталога
_input/репозиторияtechlab-comment-builder, обрабатывает ответ и подготавливает список черновиков для выбора в интерфейсе.
06-drafts-injector.js(Модуль восстановления выбранного черновика)- Назначение: Восстановление ранее сохранённых данных комментария в рабочей форме конструктора.
- Логика работы: Заполняет поля формы данными выбранного черновика, восстанавливает фото- и видеоблоки, сведения о медиафайлах и ссылки на них, а также согласует состояние элементов формы с загруженным черновиком.
07-drafts-delete.js(Модуль управления удалением черновиков)- Назначение: Управление выбором и фиксацией операции удаления черновика.
- Логика работы: Создаёт элемент управления удалением, отслеживает его состояние и передаёт выбранный признак в процесс сохранения, чтобы корректно обработать удаление черновика.
08-comment-validation.js(Модуль проверки данных комментария)- Назначение: Контроль корректности данных формы перед сохранением.
- Логика работы: Проверяет календарную дату, поля комментария и идентификаторы, а также данные медиаблоков. При обнаружении некорректного значения возвращает сообщение об ошибке и не позволяет продолжить сохранение до исправления данных.
09-comment-lock.js(Модуль блокировки формы)- Назначение: Защита формы от повторных действий пользователя во время выполнения операций.
- Логика работы: Блокирует и разблокирует элементы интерфейса, отображает состояние выполняемой операции и восстанавливает форму после её завершения.
10-media-blocks.js(Модуль создания и удаления медиаблоков)- Назначение: Управление структурой фото- и видеоблоков комментария.
- Логика работы: Создаёт новые медиаблоки, удаляет ненужные блоки и обновляет доступность элементов управления в зависимости от состояния интерфейса.
11-media-files.js(Модуль управления данными медиафайлов)- Назначение: Обработка выбранных пользователем файлов и подготовка их данных для работы конструктора.
- Логика работы: Обрабатывает выбор файлов, проверяет допустимые типы и дубликаты, формирует имена файлов и регистрирует данные файлов в соответствующих медиаблоках.
12-media-files-ui.js(Модуль интерфейса списка медиафайлов)- Назначение: Отображение списка файлов и управление действиями пользователя с ними.
- Логика работы: Формирует элементы списка медиафайлов, отображает их состояние и обрабатывает удаление, замену, выбор и перетаскивание файлов, включая работу с отсутствующими файлами и WikiLink.
13-media-upload.js(Модуль загрузки медиафайлов)- Назначение: Передача локальных фото- и видеофайлов в буферный репозиторий GitHub.
- Логика работы: Подготавливает имена и содержимое файлов, выполняет загрузку через GitHub Contents API в каталог
_input/репозиторияtechlab-comment-builder, обрабатывает результаты и ошибки загрузки.
14-comment-markdown.js(Модуль формирования Markdown комментария)- Назначение: Сбор данных формы и создание итогового Markdown-документа с Front Matter.
- Логика работы: Объединяет текстовые поля и данные медиаблоков, формирует метаданные комментария, ссылки и подписи файлов. Выполняет кодирование и декодирование содержимого в Base64 с поддержкой UTF-8.
15-comment-github-save.js(Модуль сохранения Markdown через GitHub API)- Назначение: Создание новых и обновление существующих файлов комментариев и черновиков в GitHub.
- Логика работы: Проверяет актуальную версию файла и его SHA, сохраняет Markdown через GitHub Contents API, обрабатывает конфликт обновления и выполняет повторные попытки при временных сетевых ошибках.
16-comment-submit.js(Модуль отправки комментария и сохранения черновика)- Назначение: Координация полного процесса проверки, сохранения комментария и загрузки медиафайлов.
- Логика работы: Проверяет наличие токена, корректность даты, номера обсуждения и данных формы. Запускает формирование и сохранение Markdown, затем загрузку медиафайлов. При успешной загрузке файлов обновляет Markdown, обрабатывает режимы сохранения, публикации или удаления черновика и выводит итоговый статус операции.