Добро пожаловать в официальный центр документации экосистемы плагинов для PeekIt — инструмента мгновенного предварительного просмотра файлов по клавише Space (Пробел) в Windows 10 и 11.
Выберите раздел в зависимости от вашей роли и задачи:
- Руководство пользователя (USER_GUIDE.md)
Установка плагинов через каталог или перетаскиванием (.pkit), горячие клавиши, управление ассоциациями файлов и удаление.
- Быстрый старт за 10 минут (QUICKSTART.md)
Пошаговое создание рабочего плагина с нуля, настройка манифеста, канонический порядок исполнения скрипта (Zero-TDZ) и первая сборка. - Спецификация протокола сообщений (RPC_SPECIFICATION.md)
Подробный справочник событийwindow.postMessage, фазы рукопожатия (PEEKIT_READY➔PEEKIT_INIT➔PEEKIT_REQUEST_DATA➔PEEKIT_DATA_RESPONSE) и предупреждение о типичных антипаттернах. - Руководство по стилю и UI/UX (STYLE_GUIDE.md)
Системные CSS-токены Fluent Design (--bg-main,--accent), стандартная анатомия окна (шапка, тулбар, вьюпорт), типографика и горячие клавиши. - Руководство по локализации плагинов (I18N_GUIDE.md)
Принципы глубокой локализации (Deep Visual I18N), двусторонняя синхронизация языка с хостом, защита от мигания текста и обработка динамических счётчиков. - Руководство по тестированию и верификации (TESTING_GUIDE.md)
Как запустить автоматический тестовый раннерnpm test, описание всех 6 стадий проверок, ручное тестирование в реальном приложении PeekIt на Windows и отладка через DevTools. - База частых проблем и решений (TROUBLESHOOTING.md)
Решение типовых ошибок: белый экран при старте, бесконечный цикл перезагрузок, ошибки локализации в тестах, проблемы с памятью при обработке больших файлов.
- Регламент проверки плагинов (REVIEW_GUIDELINES.md)
Критерии прохождения автоматического и ручного код-ревью перед слиянием Pull Request вmain. - Политика безопасности (SECURITY.md)
Модель изоляции WebView2 Sandbox, защита от утечек данных и правила сообщения об уязвимостях. - Правила контрибьюции (CONTRIBUTING.md)
Порядок создания веток, формат сообщений Conventional Commits и публикация в реестрregistry.json.
| Инструмент | Путь | Описание |
|---|---|---|
| Браузерная песочница | template/mock-host.html |
Локальная отладка плагина в Chrome/Edge без запуска десктопного приложения PeekIt |
| Тестовый раннер | test_plugins.cjs |
Автоматическая верификация всех плагинов (npm test) |
| Упаковщик пакетов | pack_plugin.cjs |
Сборка архивов .pkit, подсчёт SHA-256 и обновление registry.json (npm run pack) |
| JSON Schema | plugin-schema.json |
Схема валидации манифестов плагинов |