← Довідник API · Повернутися до README
Розробка
Перевірки пакета
Встановіть PHP-залежності:
composer install
Запустіть тести або створіть звіт про покриття:
composer test
composer test:coverage
Застосуйте налаштований стиль коду:
composer style
Набори Pest перевіряють різні контракти:
| Набір | Покриття |
|---|---|
tests/Feature | Значення за замовчуванням, перевизначення, видалення, відсутні дані та власники |
tests/Unit/Casts | Стандартний JSON, користувацькі перетворення, morph map і Laravel Data |
tests/Unit/KeyTypes | Рядкові й цілочислові ключі, backed enum і pure unit enum |
tests/Unit/PrimaryKeyTypes | Цілочислові, рядкові, UUID- та ULID-ідентифікатори батьківських моделей |
tests/Unit/QueryCount | Кількість запитів під час читання й запису, включно з попереднім завантаженням |
tests/Architecture | Простори імен, типи, строгий режим та архітектурні правила Laravel |
Перевірки документації
Для сайту Docusaurus потрібен Node.js 20 або новіший. Встановіть залежності з каталогу docs:
npm ci
| Завдання | Команда |
|---|---|
| Запустити локальний сайт | npm run start |
| Перевірити TypeScript | npm run typecheck |
| Перевірити переклади | npm run check:i18n |
| Створити production-збірку | npm run build |
Production-збірка перевіряє внутрішні посилання для кожної налаштованої локалі.
Зберігайте сторінки документації в docs/docs. Кожна сторінка використовує front matter для позиції
в бічній панелі, рядок навігації на початку, відносні посилання між посібниками та розділ Див. також
наприкінці.
Зберігайте кожну локаль, крім основної, у каталозі
docs/i18n/<locale>/docusaurus-plugin-content-docs/current. Кожна локаль має містити ті самі шляхи
сторінок, що й docs/docs. Команда npm run check:i18n перевіряє це перед production-збіркою.
Участь у розробці
Перед створенням pull request прочитайте посібник з участі.
Безпека
Надсилайте повідомлення про вразливості приватно на [email protected].
Автори
Пакет створили Andrey Helldar і учасники проєкту.
Див. також
- Початок роботи — встановлення пакета в Laravel-застосунок.
- Конфігурація — опубліковані файли пакета.
- Довідник API — публічний API перед зміною поведінки.