← API Reference · Back to README
Development
Package checks
Install the PHP dependencies:
composer install
Run the test suite or generate coverage:
composer test
composer test:coverage
Apply the configured code style:
composer style
The Pest suites cover different contracts:
| Suite | Coverage |
|---|---|
tests/Feature | Defaults, overrides, deletion, missing data, and ownership |
tests/Unit/Casts | Default JSON, custom casts, morph maps, and Laravel Data |
tests/Unit/KeyTypes | String, integer, backed enum, and pure unit enum keys |
tests/Unit/PrimaryKeyTypes | Integer, string, UUID, and ULID parent identifiers |
tests/Unit/QueryCount | Read and write query counts, including eager loading |
tests/Architecture | Namespace, type, strictness, and Laravel architecture rules |
Documentation checks
The Docusaurus site requires Node.js 20 or newer. Install its dependencies from the docs
directory:
npm ci
| Task | Command |
|---|---|
| Start the local site | npm run start |
| Check TypeScript | npm run typecheck |
| Check translations | npm run check:i18n |
| Create a production build | npm run build |
The production build validates internal links for every configured locale.
Keep documentation pages in docs/docs. Each page uses front matter for sidebar order, a navigation
line at the top, relative links between guides, and a See Also section at the end.
Keep each non-default locale in
docs/i18n/<locale>/docusaurus-plugin-content-docs/current. Every locale must contain the same page
paths as docs/docs. The npm run check:i18n command enforces this before a production build.
Contributing
Follow the contribution guide before opening a pull request.
Security
Report security issues privately to [email protected].
Credits
Created by Andrey Helldar and the project contributors.
See Also
- Getting Started — install the package in a Laravel application.
- Configuration — understand the published package files.
- API Reference — review the public API before changing behavior.