Skip to content

docs: README к выпуску FetchIt 4 и новый логотип - #35

Merged
GulomovCreative merged 5 commits into
4.xfrom
docs/readme-logo
Sep 24, 2026
Merged

GulomovCreative merged 5 commits into
4.xfrom
docs/readme-logo

Conversation

@GulomovCreative

@GulomovCreative GulomovCreative commented Sep 24, 2026 •

Copy link
Copy Markdown
Owner

Зачем

К выпуску FetchIt 4 README должен с первого экрана объяснять, что это и зачем, а подробности раскладывать по разделам. Логотип перерисован в едином стиле, и теперь он рендерится из исходника, а не хранится готовой картинкой.

Что меняется

Логотип

  • Исходник .github/logo/logo.html: светло-серый квадрат с формой (два поля и кнопка в sky-500 из Tailwind CSS 4), рядом надпись «Fetch» шрифтом Outfit и «It» шрифтом JetBrains Mono.
  • npm run logo рендерит из него:
    • logo.png и logo@2x.png на прозрачном фоне для README;
    • logo-dark.png и logo-dark@2x.png со светлой надписью для тёмной темы GitHub (README выбирает вариант через <picture>);
    • social.png 1280×640 для превью ссылок на репозиторий.
  • Если Google Fonts не загрузились, скрипт останавливается и не трогает готовые картинки: он проверяет шрифты и пишет файлы только после того, как готовы все снимки.

Сборка

  • Скрипт теперь собирается в синтаксис ES2019 (transform.target в rolldown.config.ts). В browserslist проекта есть UC Browser и Opera Mobile на Chromium 78, который не разбирает ?., ?? и ??=. Минифицированный скрипт вырос на 1,5 КБ, в gzip на 0,5 КБ.
  • npm run check:syntax проверяет обе сборки парсером ES2019 (acorn), CI запускает её в задаче Frontend. Прежняя сборка эту проверку не проходит.

README

  • Сверху: логотип, одна строка о главном, бейджи (MODX 2.8+ и 3, PHP 7.4+, типы, CI, лицензия), абзац о том, что это, и оглавление.
  • Новые разделы:
    • «Быстрый старт»: вызов сниппета и чанк формы с объяснением атрибутов;
    • «Параметры сниппета» с примером своего сниппета и предупреждением, что он вызывается и при каждом выводе формы;
    • «События и JavaScript»: таблица событий с тем, что делает отмена, и примеры;
    • «Системные настройки»: таблица всех настроек со значениями по умолчанию;
    • «Требования»;
    • в «Разработке»: «Как устроено», как части компонента работают вместе.
  • Разделы про защиту от спама, уведомления, TypeScript и переход на FetchIt 4 остались, в «Переходе» теперь есть и защита, и Notyf.
  • Сравнение с AjaxForm сжато до одного пункта «Никаких зависимостей».
  • В readme.txt пакета, который показывает Менеджер пакетов, описание дописано и добавлена ссылка на README.

Заметки для ревью

  • Старый fetchit-logo.svg в корне я не удалял: на него могут ссылаться страницы пакета на modstore.pro, modx.com и в документации по адресу из master. Когда ссылки будут заменены, его можно убрать.
  • social.png нужно загрузить вручную: Settings, General, Social preview. У GitHub нет для этого API.
  • Все ссылки на разделы внутри README я проверил скриптом, длинных тире в тексте нет.
  • По ревью README сверен с кодом: некешируемый вызов, свой сниппет, detail и отмена каждого события, момент fetchit:reset, формы из AJAX, требования к браузерам и PHP, размеры скрипта, значения настроек. Описание хука reset в fetchit.d.ts тоже поправлено.
  • Со сборкой ES2019 на чистых сайтах MODX 2.8.6 и 3.2.4 прошли smoke, все браузерные тесты, тесты уведомлений, proof-of-work и Turnstile.
  • Раздел «Ветки» описывает состояние до выпуска: после 4.0, когда 4.x станет master, его нужно будет поправить.

@GulomovCreative
GulomovCreative merged commit b003c63 into 4.x Sep 24, 2026
16 checks passed
@GulomovCreative
GulomovCreative deleted the docs/readme-logo branch September 24, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant