frontis
v0.0.3
Published
Консольная утилита для аудита фронтенд-проектов через Code PushUp с результатами в JSON
Maintainers
Readme
Frontis запускает проверки фронтенд-проекта через Code PushUp и сохраняет результаты и рекомендации в JSON. Версия 0.0.3 включает проверку зависимостей npm, анализ ESLint, Prettier и knip, сбор покрытия и результатов Jest или Vitest, проверку версии Node.js и размера сборки.
Быстрый старт
Нужны Node.js 22 или новее и Git. Установите Frontis в корне проверяемого проекта с npm:
npm install -D frontisСоздайте в корне файл frontis.config.mjs с настройками по умолчанию:
export default {};Запустите проверку:
npx frontis runВо время проверки Frontis показывает состояние модулей в консоли. Доступность проверок зависит от конфигурации проекта и установленных инструментов. Список проверок и требования к ним
Результаты
.frontis/report.jsonсодержит аудиты Code PushUp..frontis/result.jsonсодержит статусы показателей, оценку и рекомендации Frontis..frontis/no-data.jsonсодержит причины, по которым отдельные проверки не дали результата. Технические журналы инструментов сохраняются в.frontis/logs/.
В версии 0.0.3 результаты доступны в JSON. HTML-отчёт запланирован для MVP. Формат результатов
Код выхода 0 означает, что записан результат хотя бы с одним валидным аудитом. Код 2 означает, что валидных аудитов нет либо произошла ошибка аргументов, конфигурации или записи.
Разработка
npm ci
npm run build
npm linkПосле npm link команда frontis доступна локально. Для пересборки при изменениях запустите npm run dev.
Структура
src/coreядро, запуск и подготовка конфигурации движка- Формат результатов
src/collectorsконтракт модулей сбора данныхsrc/pluginsплагины Frontis для Code PushUp
Публикация в npm
- Обновите версию через
npm version <версия> --no-git-tag-versionи включитеpackage.jsonиpackage-lock.jsonв PR. Для стабильного выпуска направьте PR вmain, для предварительного выпуска с версией вида0.1.0-beta.0используйте веткуrelease/*. - После слияния создайте тег
v<версия>на текущем коммите целевой ветки с новой версией и отправьте тег в GitHub. - Откройте Actions → Release → Run workflow и выберите целевую ветку. Workflow проверит тег, соберёт архив и опубликует его через npm Trusted Publishing. Стабильные выпуски получают метку
latest, предварительные получаютnext.
Лицензия
Apache 2.0
