How dedonych/shikimori-dark-theme works
Тип проекта и назначение (что рисуем)
По дереву и README это не “сервис” и не backend, а пакет клиентской кастомизации UI для сайта *shikimori.one*:
• Основной артефакт: SCSS/CSS “Dark Theme” (исходник shikimori_dark.scss, сборка в dist/…min.css).
• Доп. инструмент: colorpicker.js — пользовательский скрипт (Tampermonkey/консоль), который помогает подбирать и применять CSS-переменные (--my-clr, --dropdown) и копировать готовые строки.
Следовательно, “системная архитектура” здесь — это архитектура распространения и применения темы в браузере, плюс пайплайн сборки SCSS→CSS (даже если инструменты сборки не закоммичены, на диаграмме нужно отразить факт существования сборки dist из scss).
Разбор структуры репозитория (компоненты для диаграммы)
Отразите в диаграмме как минимум такие узлы (каждый — отдельным блоком):
Исходники
• shikimori_dark.scss — единый/главный исходный стиль темы. В README есть ссылка на участок, где переменные переносятся в body (значит важно отметить: кастомизация завязана на CSS Custom Properties и scope :root/body).
• colorpicker.js — самостоятельный инструмент, который:
• меняет --my-clr, --dropdown
• “lock/unlock”, swap, random, копирование строк, reset
• живёт как userscript (Tampermonkey) или выполняется в консоли.
Сборка/артефакты
• dist/ — публично подключаемый CSS (в README импорт через raw GitHub URL).
• Важно на диаграмме указать: dist — это “release artifact / compiled CSS”.
Документация/ассеты
• README.md — инструкция подключения, список фич, праздничные темы (условная активация через CSS-переменные).
• posters/, posters/features/ — скриншоты для документации.
Что важно вытащить из README для архитектуры
README говорит о реальных “точках интеграции”:
1) Подключение темы: через CSS @import url(…/dist/shikimori_dark.min.css) в пользовательский стиль (скорее Stylus/расширение/собственный CSS на сайте).
Настройка через :root
• --my-clr (основной цвет)
• --dropdown (цвет верхнего меню)
• --news:none, отключение подсказки
• флаги праздничных тем: --themes:none, --xmas:none, --halloween:none, --fools:none
3) Праздничные темы: логика включения/отключения не кодом, а через CSS-переменные, и вероятно привязана к календарным датам (то есть в CSS есть правила, условно активирующие оформление в определённые дни).
4) ColorPicker JS: отдельный путь настройки — динамически меняет CSS variables в рантайме и помогает копировать настройки.
4a) Главные компоненты (что обязано быть на диаграмме)
Разбейте на 3 “плоскости”:
A. Репозиторий / разработка
• Developer
• shikimori_dark.scss (source)
• Build step “SCSS → CSS” (инструмент можно обозначить абстрактно: Sass compiler)
• dist/shikimori_dark.min.css (artifact)
B. Доставка/хостинг
• GitHub repository (source)
• GitHub Raw / CDN-like URL (как источник импорта CSS)
C. Клиент (браузер пользователя на shikimori.one)
• Browser
• shikimori.one (как “existing website / DOM”)
• User style manager (Stylus/Custom CSS) — точка, где пользователь вставляет @import и :root variables
• Theme CSS (загруженный из dist)
• CSS Variables configuration (:root, body)
• Optional: Tampermonkey + colorpicker.js (userscript), который меняет переменные
4b) Связи и взаимодействия (стрелки)
Нарисуйте направленные стрелки с подписями:
Theme CSS → shikimori.one DOM: “переписывание/override стилей сайта”
7) Tampermonkey/Console → colorpicker.js → CSS Variables: “runtime изменение --my-clr / --dropdown”
4c) Архитектурные принципы/паттерны (что подчеркнуть)
• Configuration via CSS Custom Properties: ключевая точка расширяемости — не форкать тему, а менять переменные.
• Runtime theming: colorpicker.js не пересобирает CSS, а меняет переменные на лету.
• Separation of concerns:
• SCSS — “источник истины”
• dist — “дистрибутив”
• README/posters — “документация/маркетинг”
• External dependency: сайт shikimori.one — внешний, не контролируется проектом; тема “накладывается” поверх существующих классов/DOM.
4d) Технологии (подписи на блоках)
• SCSS/Sass
• CSS Custom Properties (:root, body, --my-clr, --dropdown)
• GitHub Raw URL как хостинг артефакта
• Userscript (Tampermonkey) / DevTools Console
• Browser rendering pipeline (можно кратко: “CSS cascade/override”)
Как адаптировать диаграмму под этот тип проекта (тема/пользовательский стиль)
Для темы правильнее делать две диаграммы (или одну, но с двумя зонами):
Диаграмма 1: “Build & Release”
Цель — показать откуда берётся dist:
• shikimori_dark.scss → (Sass compiler) → dist/shikimori_dark.min.css → GitHub
Даже если в репозитории нет package.json/скриптов, блок “Sass compiler” всё равно нужен, иначе непонятно происхождение dist.
Диаграмма 2: “Runtime / Integration”
Цель — показать как пользователь реально использует:
• Пользователь → добавляет @import и :root переменные → браузер грузит CSS → применяется к DOM shikimori.one
• Опционально: colorpicker.js → меняет CSS variables → UI меняется мгновенно
Что обязательно включить в сам рисунок (оформление)
Чтобы диаграмма была “principal-grade” и при этом максимально понятной:
• Чёткие лейблы:
• “Source SCSS”, “Compiled CSS (dist)”, “GitHub Raw URL”, “User Style (Stylus)”, “Tampermonkey userscript”, “CSS variables (:root/body)”, “shikimori.one DOM”.
• Стрелки с глаголами (не просто линии):
• “compile”, “publish”, “import”, “override styles”, “set variables”, “mutate variables at runtime”.
• Цвет/формы по типам:
• Код/артефакты (файлы) — прямоугольники
• Процессы (компиляция) — ромб/скруглённый прямоугольник
• Внешние системы (shikimori.one, GitHub Raw) — отдельный цвет/рамка “external”
• Клиентские инструменты (Stylus/Tampermonkey) — отдельная группа “Browser Extensions”
“Не переусложнять, но максимально разложить на компоненты”
Самая точная декомпозиция для этого репозитория — это:
• Theme Source: shikimori_dark.scss
• Theme Distribution: dist/shikimori_dark.min.css (и канал доставки через raw)
• Configuration Surface: :root/body variables (--my-clr, --dropdown, флаги отключения тем)
• Runtime Tooling: colorpicker.js (userscript/console)
• Target System: shikimori.one DOM/CSS (external)
Если изобразить эти 6 блоков и их стрелочные связи — это будет “лучшее и самое точное” архитектурное представление для данного проекта.